/tags/jsdoc_toolkit-1.4.0/README.txt

  1=====================================================================
  2
  3DESCRIPTION:
  4
  5JsDoc Toolkit is an automatic documentation generation tool for
  6JavaScript. It is written in JavaScript and is run from a command line
  7(or terminal) using Mozilla Rhino JavaScript engine. Using this tool
  8you can automatically turn JavaDoc-like comments in your JavaScript
  9source code into published output, such as HTML or XML.
 10
 11For more information, to report a bug or to browse the technical
 12documentation for this tool please visit the official JsDoc Toolkit
 13project homepage: http://code.google.com/p/jsdoc-toolkit/
 14
 15This project is based on the JSDoc.pm tool, created by Michael 
 16Mathews, maintained by Gabriel Reid. More information on JsDoc can
 17be found on the JSDoc.pm homepage: http://jsdoc.sourceforge.net/
 18
 19Complete documentation on JsDoc Toolkit can be found on the project
 20wiki at http://code.google.com/p/jsdoc-toolkit/w/list
 21
 22
 23=====================================================================
 24
 25USAGE:
 26
 27Running JsDoc Toolkit on your desktop requires you to have Java
 28installed and the Mozilla Rhino JavaScript jar file (named "js.jar")
 29available. A copy of this jar file is included with the JsDoc Toolkit
 30distribution. To download Rhino yourself or to find out more go to 
 31the official Rhino web page: http://www.mozilla.org/rhino/
 32
 33Before running the JsDoc Toolkit app you must change your current
 34working directory to the jsdoc-toolkit folder. Then follow the
 35examples below, or as shown on the project wiki.
 36
 37On a computer running Windows a valid command line to run JsDoc
 38Toolkit might look like this:
 39
 40 > java -jar app\js.jar app\run.js -a -t=templates\htm test\data\test.js
 41
 42On Mac OS X or Linux the same command would look like this:
 43
 44 $ java -jar app/js.jar app/run.js -a -t=templates/htm test/data/test.js
 45
 46The above assumes your current working directory contains the app, test
 47and templates subdirectories from the standard JsDoc Toolkit 
 48distribution. If you have the js.jar file saved to a place in your
 49system's Java CLASSPATH, it can safely be omitted from the command.
 50
 51To run JsDoc Toolkit from any directory, specify the path to the app
 52folder like so:
 53
 54 > java -Djsdoc.dir=%BASE_DIR% -jar %RHINO% %RUN% %OPTS% %SRC_FILES%
 55
 56So assuming the JsDoc Toolkit "app" directory is in "lib\jsdoc-toolkit"
 57you would specify that like so:
 58
 59 > java -Djsdoc.dir=lib\jsdoc-toolkit <etc>
 60
 61The output documentation files will be saved to a new directory named
 62"js_docs_out" (by default) in the current directory, or if you specify
 63a -d=somewhere_else option, to the somewhere_else directory.
 64
 65For help (usage notes) enter this on the command line:
 66
 67 > java -jar app\js.jar app\run.js -h
 68
 69To run the unit tests included with JsDoc Toolkit enter this on the
 70command line:
 71
 72 > java -jar app\js.jar test\run.js
 73
 74To run any example in the included examples enter this on the
 75command line:
 76
 77 $ java -jar app/js.jar examples/run.js -a  examples/data/whatever.js
 78
 79
 80=====================================================================
 81
 82LICENSE:
 83
 84Rhino (JavaScript in Java) is open source and licensed by Mozilla
 85under the MPL 1.1 or later/GPL 2.0 or later licenses, the text of which
 86is available at http://www.mozilla.org/MPL/
 87
 88You can obtain the source code for Rhino via the Mozilla web site at
 89http://www.mozilla.org/rhino/download.html
 90
 91The Tango base icon theme is licensed under the Creative Commons 
 92Attribution Share-Alike license. The palette is in the public domain.
 93For more details visit the Tango! Desktop Project page at
 94http://tango.freedesktop.org/Tango_Desktop_Project
 95
 96JsDoc Toolkit is a larger work that uses the Rhino JavaScript engine
 97without modification and without any claims whatsoever. The portions of
 98code specific to JsDoc Toolkit are open source and licensed under the
 99X11/MIT License.
100
101Copyright (c) 2007 Michael Mathews <micmath@gmail.com>
102
103Permission is hereby granted, free of charge, to any person obtaining
104a copy of this software and associated documentation files (the
105"Software"), to deal in the Software without restriction, including
106without limitation the rights to use, copy, modify, merge, publish,
107distribute, sublicense, and/or sell copies of the Software, and to
108permit persons to whom the Software is furnished to do so, subject to
109the following conditions: The above copyright notice and this
110permission notice must be included in all copies or substantial
111portions of the Software.
112
113THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
114EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
115MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
116IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
117CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
118TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
119SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.