Skip to content

fix: line number anchor in source links #1182

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
gennaroprota wants to merge 1 commit into
base: develop
Choose a base branch
from
+122 −1
Open

fix: line number anchor in source links #1182

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion share/mrdocs/addons/generator/common/partials/location/source.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
--}}
Declared in {{#>markup/code~}}
{{ str "<" }}{{#if (and @root.config.base-url dcl.shortPath dcl.sourcePath)~}}
{{#>markup/a href=(concat @root.config.base-url dcl.sourcePath '#L' dcl.line)}}{{dcl.shortPath}}{{/markup/a}}
{{#>markup/a href=(concat @root.config.base-url dcl.sourcePath '#L' dcl.lineNumber)}}{{dcl.shortPath}}{{/markup/a}}
{{~else~}}
{{dcl.shortPath}}
{{~/if~}}{{ str ">" }}
Expand Down
29 changes: 29 additions & 0 deletions test-files/golden-tests/config/base-url/base-url.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
= Reference
:mrdocs:

[#index]
== Global namespace

=== Functions

[cols=1]
|===
| Name
| link:#f[`f`]
|===

[#f]
== f

=== Synopsis

Declared in `&lt;https://example.com/src/base-url.cpp#L6[base&hyphen;url&period;cpp]&gt;`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
void
f();
----


[.small]#Created with https://www.mrdocs.com[MrDocs]#
6 changes: 6 additions & 0 deletions test-files/golden-tests/config/base-url/base-url.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
// When the `base-url` config option is set, the generated
// documentation's Synopsis section carries a link to the source
// file, with an anchor pointing at the line where the symbol is
// declared.

void f();
49 changes: 49 additions & 0 deletions test-files/golden-tests/config/base-url/base-url.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
<html lang="en">
<head>
<title>Reference</title>
<meta charset="utf-8">
</head>
<body>
<div>
<h1>Reference</h1>
<div>
<div>
<h2 id="index">
Global Namespace</h2>
</div>
<h2>
Functions</h2>
<table style="table-layout: fixed; width: 100%;">
<thead>
<tr>
<th>Name</th>
</tr>
</thead>
<tbody>
<tr>
<td><a href="#f"><code>f</code></a> </td></tr>
</tbody>
</table>

</div>
<div>
<div>
<h2 id="f">
f</h2>
</div>
<div>
<h3>
Synopsis</h3>
<div>
Declared in <code>&lt;<a href="https://example.com/src/base-url.cpp#L6">base-url.cpp</a>&gt;</code></div>
<pre><code class="source-code cpp">void
f();</code></pre>
</div>
</div>

</div>
<footer class="mrdocs-footer">
<span>Created with <a href="https://www.mrdocs.com">MrDocs</a></span>
</footer>
</body>
</html>
36 changes: 36 additions & 0 deletions test-files/golden-tests/config/base-url/base-url.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
<?xml version="1.0" encoding="UTF-8"?>
<mrdocs xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="https://github.com/cppalliance/mrdocs/raw/develop/mrdocs.rnc">
<namespace>
<source>
</source>
<kind>namespace</kind>
<id>//////////////////////////8=</id>
<extraction>regular</extraction>
<namespace-tranche>
<functions>s6nsa+zVhpzzrN+yUVPP5rvdXqs=</functions>
</namespace-tranche>
</namespace>
<function>
<name>f</name>
<source>
<location>
<short-path>base-url.cpp</short-path>
<source-path>base-url.cpp</source-path>
<line-number>6</line-number>
<column-number>1</column-number>
</location>
</source>
<kind>function</kind>
<id>s6nsa+zVhpzzrN+yUVPP5rvdXqs=</id>
<extraction>regular</extraction>
<parent>//////////////////////////8=</parent>
<named>
<name>
<kind>identifier</kind>
<identifier>void</identifier>
</name>
</named>
<func-class>normal</func-class>
</function>
</mrdocs>
1 change: 1 addition & 0 deletions test-files/golden-tests/config/base-url/base-url.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
base-url: https://example.com/src/
Loading