0.0.6 • Published 10 years ago

jaguarjs-jsdoc-patched-2 v0.0.6

Weekly downloads
15
License
MIT
Repository
github
Last release
10 years ago

Forked jaguarjs-jsdoc-patched and added the following tweaks:

v0.0.6 Opened sub-menu on page load Fixed navigation issue where clicking on a module name would reload the page instead of opening the sub-menus Highlight method for easier finding when you click from nav

v0.0.3 Display overriden methods/members Members display line number reference Navigation is alphabetical (for namespace grouping) Members with a type show up as properties Sort overriden/new methods & members before inherited ones


A patched version of JaguarJS-JSDoc

Usage

  1. Install from npm

    $ npm install jaguarjs-jsdoc-patched-2 --save-dev
  2. Copy the conf.json file to the root directory of your repo. Edit as necessary.

  3. Assuming you're using grunt-jsdoc, set the template to ./node_modules/jaguarjs-jsdoc-patched-2

      grunt.initConfig({
        ..other grunt tasks here..
        jsdoc : {
          dist : {
            src: ['src/*.js', 'README.md'],
            options: {
              destination: 'docs',
              configure : "conf.json",
              template: './node_modules/jaguarjs-jsdoc-patched-2'
            }
          }
        }
      });

    Other task runners should work similarly.

  4. Again assuming you're using grunt-jsdoc, simply run grunt jsdoc!

License

This project under the MIT License.

0.0.6

10 years ago

0.0.5

10 years ago

0.0.4

10 years ago

0.0.3

10 years ago

0.0.2

10 years ago

0.0.1

10 years ago