Skip to content
/ jsdoc Public
forked from jsdoc/jsdoc

An automatic documentation generator for JavaScript.

License

Notifications You must be signed in to change notification settings

tomyan/jsdoc

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

JSDoc 3

This is pre-release software, under active development. It is not intended for general use.

Install

To build the jsdoc jar that runs JSDoc 3, use the ant build tool.

git clone git:https://github.com/micmath/jsdoc.git jsdoc
cd jsdoc
ant

This will create a file name jsdoc.jar in the project base directory.

To test that the installed app is working, execute the following:

java -jar jsdoc.jar --test

Usage

This example assumes your working directory is the JSDoc project base directory...

java -jar jsdoc.jar yourSourceCodeFile.js

For help regarding the supported commandline options use -h.

java -jar jsdoc.jar --help

See

Project Documentation: https://micmath.github.com/jsdoc Subversion Mirror: https://code.google.com/p/jsdoc/source

License

JSDoc 3 is copyright (c) 2011 Michael Mathews [email protected]

See file "LICENSE.md" in this distribution for more details about terms of use.

About

An automatic documentation generator for JavaScript.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published