Fork info
This repo has been forked because we needed to add
this fix.
We are going to publish the
release branch on npm GeoSolutions registry
This lib is used
here
JSDoc 3
=======
An API documentation generator for JavaScript.
Want to contribute to JSDoc? Please read
CONTRIBUTING.md.
Installation and Usage
----------------------
JSDoc supports Node.js 0.10 and later. You can install JSDoc in your project's
node_modules folder, or you can install it globally.
To install the latest version available on NPM:
npm install jsdoc
To install the latest development version:
npm install git+https://github.com/jsdoc3/jsdoc.git
If you installed JSDoc locally, the JSDoc command-line tool is available in
./node_modules/.bin. To generate documentation for the file
yourJavaScriptFile.js:
./node_modules/.bin/jsdoc yourJavaScriptFile.js
Or if you installed JSDoc globally, simply run the
jsdoc command:
jsdoc yourJavaScriptFile.js
By default, the generated documentation is saved in a directory named
out. You
can use the
--destination (
-d) option to specify another directory.
Run
jsdoc --help for a complete list of command-line options.
Templates and Build Tools
-------------------------
The JSDoc community has created numerous templates and other tools to help you
generate and customize your documentation. Here are just a few:
$3
+
jaguarjs-jsdoc
(
example)
+
DocStrap (
example)
+
jsdoc3Template
(
example)
+
minami
+
docdash(
example)
$3
+
JSDoc Grunt plugin
+
JSDoc ant task
For More Information
--------------------
+ Documentation is available at
Use JSDoc.
+ Contribute to the docs at
jsdoc3/jsdoc3.github.com.
+ Ask for help on the
JSDoc Users mailing list.
+ Post questions tagged
jsdoc to
Stack
Overflow.
License
-------
JSDoc 3 is copyright (c) 2011-present Michael Mathews
and the
contributors to JSDoc.
JSDoc 3 is free software, licensed under the Apache License, Version 2.0. See
the file LICENSE.md in this distribution for more details.