mirror of
https://github.com/jsdoc/jsdoc.git
synced 2025-12-08 19:46:11 +00:00
Updated README with information about dependencies.
This commit is contained in:
parent
7fc4708526
commit
60b67732ac
56
README.md
56
README.md
@ -1,41 +1,71 @@
|
||||
JSDoc 3
|
||||
=======
|
||||
|
||||
This is pre-release software, under active development. It is not
|
||||
intended for general use.
|
||||
An inline API documentation processor for JavaScript. JSDoc 3 is intended to be
|
||||
an upgrade to JsDoc Toolkit (JSDoc 2).
|
||||
|
||||
Install
|
||||
-------
|
||||
Notice
|
||||
------
|
||||
|
||||
To build the jsdoc jar that runs JSDoc 3, use the ant build tool.
|
||||
This software is not yet released and is still under active development.
|
||||
|
||||
Installation
|
||||
------------
|
||||
|
||||
Download a copy of JSDoc 3 from the official Git Hub repository here:
|
||||
<https://github.com/micmath/jsdoc>
|
||||
|
||||
To build the jar file that runs JSDoc 3, use the Apache 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.
|
||||
This will create a file named `jsdoc.jar` in the project base directory.
|
||||
|
||||
To test that the installed app is working, execute the following:
|
||||
To test that the newly 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...
|
||||
This example assumes that your working directory is the jsdoc application base
|
||||
directory:
|
||||
|
||||
java -jar jsdoc.jar yourSourceCodeFile.js
|
||||
|
||||
For help regarding the supported commandline options use -h.
|
||||
For help regarding the supported commandline options use the --help option.
|
||||
|
||||
java -jar jsdoc.jar --help
|
||||
|
||||
Included with JSDoc 3 is a bash shell script that can simplify the command line
|
||||
usage slightly. For example:
|
||||
|
||||
./jsdoc --help
|
||||
./jsdoc yourSourceCodeFile.js
|
||||
|
||||
Dependencies
|
||||
------------
|
||||
|
||||
JSDoc 3 utilises the Mozilla Rhino engine, which requires Java. JSDoc 3 is known
|
||||
to work with version 1.6.0_24 of Java.
|
||||
|
||||
JSDoc 3 uses advanced features in the Rhino application which are only
|
||||
available in or after Rhino 1.7 release 3. A copy of this version of Rhino is
|
||||
included in JSDoc so this is not normally an issue that the user needs to be
|
||||
concerned with. However, in rare cases, users may have their Java CLASSPATH
|
||||
configured to override that included Rhino and point to some older version of
|
||||
Rhino instead. If this is the case, simply correct the CLASSPATH to remove the
|
||||
older Rhino.
|
||||
|
||||
The build script for JSDoc 3 requires Apache ant. It is know to work with
|
||||
version 1.8.2 of ant.
|
||||
|
||||
See
|
||||
---
|
||||
|
||||
Project Documentation: <http://micmath.github.com/jsdoc>
|
||||
Project Documentation: <http://usejsdoc.org/>
|
||||
User's Group: <http://groups.google.com/group/jsdoc-users>
|
||||
Subversion Mirror: <http://code.google.com/p/jsdoc/source>
|
||||
|
||||
License
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
{
|
||||
"name": "jsdoc",
|
||||
"version": "3.0.0beta1",
|
||||
"revision": "2011-04-09-2143",
|
||||
"revision": "2011-04-10-2223",
|
||||
"description": "An automatic documentation generator for javascript.",
|
||||
"keywords": [ "documentation", "javascript" ],
|
||||
"licenses": [
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user