jaguarjs-jsdoc icon indicating copy to clipboard operation
jaguarjs-jsdoc copied to clipboard

Show @module tags in navigation panel

Open jcardonadcdev opened this issue 8 years ago • 0 comments

This PR is to fix one existing issue, one issue I found while working with a recent version of jsdoc, one change to the display of items in the navigation list, and one change to display markdown lists in class descriptions as bulleted lists.

  • The existing issue is #25, modules tagged with @module do not get added to the navigation list on the left side of the page. In reference to this issue I made the following changes:
    • Added a new if statement to the publish.buildNav method to add modules to the array of items that get added to the navigation list
    • Removed module: from the name of the navigation item so the display name shown in the list is easier to read.
  • I found an issue when using the most recent version of jsdoc (3.4.2) that gets bundled with the latest version of grunt-jsdoc (2.1.0). The <li> elements generated for AMD modules in the navigation list have the wrong data-name attribute value due to a new file naming method in recent versions of jsdoc.
    • The fix is to set the data-name attribute of the element to the file name generated generated for the module instead of setting it to the longname property.
  • I added some entries to main.less to render <li> elements in class descriptions with list-style-type:disc
  • The last change is to add section labels to the navigation list so that it is easy to see the items grouped by type. This is the way that the default template for jsdoc displays items in the navigation list.

jcardonadcdev avatar Oct 10 '16 20:10 jcardonadcdev