PageRenderTime 35ms CodeModel.GetById 29ms app.highlight 2ms RepoModel.GetById 2ms app.codeStats 0ms

/tags/jsdoc_toolkit-2.2.1/jsdoc-toolkit/README.txt

http://jsdoc-toolkit.googlecode.com/
Plain Text | 186 lines | 129 code | 57 blank | 0 comment | 0 complexity | f8c5a74ce6249ab42be2a9d3bfc5493c MD5 | raw file
  1======================================================================
  2
  3DESCRIPTION:
  4
  5This is the source code for JsDoc Toolkit, an automatic documentation
  6generation tool for JavaScript. It is written in JavaScript and is run
  7from a command line (or terminal) using the Java and Mozilla's Rhino
  8JavaScript runtime engine.
  9
 10Using this tool you can automatically turn JavaDoc-like comments in
 11your JavaScript source code into published output files, such as HTML
 12or XML.
 13
 14For more information, to report a bug, or to browse the technical
 15documentation for this tool please visit the official JsDoc Toolkit
 16project homepage at http://code.google.com/p/jsdoc-toolkit/
 17
 18For the most up-to-date documentation on JsDoc Toolkit see the 
 19official wiki at http://code.google.com/p/jsdoc-toolkit/w/list
 20
 21======================================================================
 22
 23REQUIREMENTS:
 24
 25JsDoc Toolkit is known to work with:
 26java version "1.6.0_03"
 27Java(TM) SE Runtime Environment (build 1.6.0_03-b05)
 28on Windows XP,
 29and java version "1.5.0_13"
 30Java(TM) 2 Runtime Environment, Standard Edition (build 1.5.0_13-b05-241)
 31on Mac OS X 10.4.
 32
 33Other versions of java may or may not work with JsDoc Toolkit.
 34
 35======================================================================
 36
 37USAGE:
 38
 39Running JsDoc Toolkit requires you to have Java installed on your
 40computer. For more information see http://www.java.com/getjava/
 41
 42Before running the JsDoc Toolkit app you should change your current
 43working directory to the jsdoc-toolkit folder. Then follow the
 44examples below, or as shown on the project wiki.
 45
 46On a computer running Windows a valid command line to run JsDoc
 47Toolkit might look like this:
 48
 49> java -jar jsrun.jar app\run.js -a -t=templates\jsdoc mycode.js
 50
 51On Mac OS X or Linux the same command would look like this:
 52
 53$ java -jar jsrun.jar app/run.js -a -t=templates/jsdoc mycode.js
 54
 55The above assumes your current working directory contains jsrun.jar,
 56the "app" and "templates" subdirectories from the standard JsDoc
 57Toolkit distribution and that the relative path to the code you wish
 58to document is "mycode.js".
 59
 60The output documentation files will be saved to a new directory named
 61"out" (by default) in the current directory, or if you specify a
 62-d=somewhere_else option, to the somewhere_else directory.
 63
 64For help (usage notes) enter this on the command line:
 65
 66$ java -jar jsrun.jar app/run.js --help
 67
 68More information about the various command line options used by JsDoc
 69Toolkit are available on the project wiki.
 70
 71======================================================================
 72
 73RUNNING VIA SHELL SCRIPT
 74
 75Avi Deitcher has contributed the file jsrun.sh with the following usage notes:
 76
 77A script to simplify running jsdoc from the command-line, especially when
 78running from within a development or build environment such as ant.
 79
 80Normally, to run jsdoc, you need a command-line as the following:
 81java -Djsdoc.dir=/some/long/dir/path/to/jsdoc -jar
 82/some/long/dir/path/to/jsdoc/jsrun.jar /some/long/dir/path/to/jsdoc/app/run.js
 83-t=template -r=4 /some/long/dir/path/to/my/src/code
 84
 85This can get tedious to redo time and again, and difficult to use from within a
 86build environment.
 87
 88To simplify the process, jsrun.sh will automatically run this path, as well as
 89passing through any arguments.
 90
 91Usage: jsrun.sh <run.js arguments>
 92
 93All <run.js arguments> will be passed through.
 94Additionally, jsrun.sh will take the following actions:
 951) If the environment variable JSDOCDIR is set, it will add
 96"-Djsdoc.dir=$JSDOCDIR" to the command-line
 972) If the environment variable JSDOCTEMPLATEDIR is set, it will add
 98"-Djsdoc.template.dir=$JSDOCTEMPLATEDIR" to the command-line
 993) java with the appropriate path to jsrun.jar and run.js will be instantiated
100
101If not variables are set, it is assumed that the path to jsrun.jar and app/ is
102in the current working directory.
103
104Example:
105# jsrun.sh ./src/
106Assuming JSDOCDIR=/some/path/to/my/jsdoc will cause the following command to
107execute:
108java -Djsdoc.dir=/some/path/to/my/jsdoc -jar /some/path/to/my/jsdoc/jsrun.jar
109/some/path/to/my/jsdoc/app/run.js ./src/
110
111======================================================================
112
113TESTING:
114
115To run the suite of unit tests included with JsDoc Toolkit enter this
116on the command line:
117
118$ java -jar jsrun.jar app/run.js -T
119
120To see a dump of the internal data structure that JsDoc Toolkit has
121built from your source files use this command:
122
123$ java -jar jsrun.jar app/run.js mycode.js -Z
124
125======================================================================
126
127LICENSE:
128
129JSDoc.pm
130
131This project is based on the JSDoc.pm tool, created by Michael
132Mathews and Gabriel Reid. More information on JsDoc.pm can
133be found on the JSDoc.pm homepage: http://jsdoc.sourceforge.net/
134
135Complete documentation on JsDoc Toolkit can be found on the project
136wiki at http://code.google.com/p/jsdoc-toolkit/w/list
137
138Rhino
139
140Rhino (JavaScript in Java) is open source and licensed by Mozilla
141under the MPL 1.1 or later/GPL 2.0 or later licenses, the text of
142which is available at http://www.mozilla.org/MPL/
143
144You can obtain the source code for Rhino from the Mozilla web site at
145http://www.mozilla.org/rhino/download.html
146
147JsDoc Toolkit is a larger work that uses the Rhino JavaScript engine
148but is not derived from it in any way. The Rhino library is used 
149without modification and without any claims whatsoever.
150
151The Rhino Debugger
152
153You can obtain more information about the Rhino Debugger from the 
154Mozilla web site at http://www.mozilla.org/rhino/debugger.html
155
156JsDoc Toolkit is a larger work that uses the Rhino Debugger but
157is not derived from it in any way. The Rhino Debugger is used
158without modification and without any claims whatsoever.
159
160JsDoc Toolkit
161
162All code specific to JsDoc Toolkit are free, open source and licensed
163for use under the X11/MIT License.
164
165JsDoc Toolkit is Copyright (c)2009 Michael Mathews <micmath@gmail.com>
166
167This program is free software; you can redistribute it and/or
168modify it under the terms below.
169
170Permission is hereby granted, free of charge, to any person obtaining
171a copy of this software and associated documentation files (the
172"Software"), to deal in the Software without restriction, including
173without limitation the rights to use, copy, modify, merge, publish,
174distribute, sublicense, and/or sell copies of the Software, and to
175permit persons to whom the Software is furnished to do so, subject to
176the following conditions: The above copyright notice and this
177permission notice must be included in all copies or substantial
178portions of the Software.
179
180THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
181EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
182MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
183IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
184CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
185TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
186SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.