8000 document option to show complete longname in nav (#119) · jsdoc/jsdoc.github.io@2bc4b10 · GitHub
[go: up one dir, main page]
Skip to content

Commit 2bc4b10

Browse files
hegemonichegemonic
committed
document option to show complete longname in nav (#119)
1 parent fe33d77 commit 2bc4b10

File tree

2 files changed

+15
-0
lines changed

2 files changed

+15
-0
lines changed

‎about-configuring-default-template.html

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,9 @@ <h2>Table of Contents</h2>
3333
<li>
3434
<a href="#showing-the-current-date-in-the-page-footer">Showing the current date in the page footer</a>
3535
</li>
36+
<li>
37+
<a href="#showing-longnames-in-the-navigation-column">Showing longnames in the navigation column</a>
38+
</li>
3639
<li>
3740
<a href="#overriding-the-default-template-s-layout-file">Overriding the default template&#39;s layout file</a>
3841
</li>
@@ -83,6 +86,10 @@ <h2 id="showing-the-current-date-in-the-page-footer">Showing the current date in
8386
<p>By default, JSDoc&#39;s default template always shows the current date in the footer of the generated documentation. In JSDoc 3.3.0 and later, you can omit the
8487
current date by setting the option
8588
<code>templates.default.includeDate</code> to <code>false</code>.</p>
89+
<h2 id="showing-longnames-in-the-navigation-column">Showing longnames in the navigation column</h2>
90+
<p>By default, JSDoc&#39;s default template shows a shortened version of each symbol&#39;s name in the navigation column. For example, the symbol <code>my.namespace.MyClass</code> would be displayed simply as
91+
<code>MyClass</code>. To show the complete longname instead, set the option
92+
<code>templates.default.useLongnameInNav</code> to <code>true</code>. This option is available in JSDoc 3.4.0 and later.</p>
8693
<h2 id="overriding-the-default-template-s-layout-file">Overriding the default template&#39;s layout file</h2>
8794
<p>The default template uses a file named <code>layout.tmpl</code> to specify the header and footer for each page in the generated documentation. In particular,
8895
this file defines which CSS and JavaScript files are loaded for each page. In JSDoc 3.3.0 and later, you can specify your own <code>layout.tmpl</code> file

‎content/en/about-configuring-default-template.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,14 @@ documentation. In JSDoc 3.3.0 and later, you can omit the current date by settin
7373
`templates.default.includeDate` to `false`.
7474

7575

76+
## Showing longnames in the navigation column
77+
78+
By default, JSDoc's default template shows a shortened version of each symbol's name in the
79+
navigation column. For example, the symbol `my.namespace.MyClass` would be displayed simply as
80+
`MyClass`. To show the complete longname instead, set the option
81+
`templates.default.useLongnameInNav` to `true`. This option is available in JSDoc 3.4.0 and later.
82+
83+
7684
## Overriding the default template's layout file
7785

7886
The default template uses a file named `layout.tmpl` to specify the header and footer for each

0 commit comments

Comments
 (0)
0