mirror of
https://github.com/jsdoc/jsdoc.git
synced 2025-12-08 19:46:11 +00:00
2f5934ba65
git-svn-id: https://jsdoc.googlecode.com/svn/trunk/@10 d5942f49-e6af-b5c1-9d01-85772c7ca168
47 lines
964 B
Markdown
47 lines
964 B
Markdown
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://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: <http://micmath.github.com/jsdoc>
|
|
Subversion Mirror: <http://code.google.com/p/jsdoc/source>
|
|
|
|
License
|
|
-------
|
|
|
|
JSDoc 3 is copyright (c) 2011 Michael Mathews <micmath@gmail.com>
|
|
|
|
See file "LICENSE.md" in this distribution for more details about
|
|
terms of use. |