PageRenderTime 19ms CodeModel.GetById 13ms app.highlight 2ms RepoModel.GetById 1ms app.codeStats 0ms

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

http://jsdoc-toolkit.googlecode.com/
Plain Text | 183 lines | 126 code | 57 blank | 0 comment | 0 complexity | 209bf754f80e0b276c453ab1b45e2a59 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 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_19"
 30Java(TM) 2 Runtime Environment, Standard Edition (build 1.5.0_19-b02-304)
 31on Mac OS X 10.5.
 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 build environment.
 86
 87To simplify the process, jsrun.sh will automatically run this path, as well as passing through any arguments.
 88
 89Usage: jsrun.sh <run.js arguments>
 90
 91All <run.js arguments> will be passed through.
 92Additionally, jsrun.sh will take the following actions:
 931) If the environment variable JSDOCDIR is set, it will add
 94"-Djsdoc.dir=$JSDOCDIR" to the command-line
 952) If the environment variable JSDOCTEMPLATEDIR is set, it will add
 96"-Djsdoc.template.dir=$JSDOCTEMPLATEDIR" to the command-line
 973) java with the appropriate path to jsrun.jar and run.js will be instantiated
 98
 99If not variables are set, it is assumed that the path to jsrun.jar and app/ is in the current working directory.
100
101Example:
102# jsrun.sh ./src/
103Assuming JSDOCDIR=/some/path/to/my/jsdoc will cause the following command to
104execute:
105java -Djsdoc.dir=/some/path/to/my/jsdoc -jar /some/path/to/my/jsdoc/jsrun.jar
106/some/path/to/my/jsdoc/app/run.js ./src/
107
108======================================================================
109
110TESTING:
111
112To run the suite of unit tests included with JsDoc Toolkit enter this
113on the command line:
114
115$ java -jar jsrun.jar app/run.js -T
116
117To see a dump of the internal data structure that JsDoc Toolkit has
118built from your source files use this command:
119
120$ java -jar jsrun.jar app/run.js mycode.js -Z
121
122======================================================================
123
124LICENSE:
125
126JSDoc.pm
127
128This project is based on the JSDoc.pm tool, created by Michael
129Mathews and Gabriel Reid. More information on JsDoc.pm can
130be found on the JSDoc.pm homepage: http://jsdoc.sourceforge.net/
131
132Complete documentation on JsDoc Toolkit can be found on the project
133wiki at http://code.google.com/p/jsdoc-toolkit/w/list
134
135Rhino
136
137Rhino (JavaScript in Java) is open source and licensed by Mozilla
138under the MPL 1.1 or later/GPL 2.0 or later licenses, the text of
139which is available at http://www.mozilla.org/MPL/
140
141You can obtain the source code for Rhino from the Mozilla web site at
142http://www.mozilla.org/rhino/download.html
143
144JsDoc Toolkit is a larger work that uses the Rhino JavaScript engine
145but is not derived from it in any way. The Rhino library is used 
146without modification and without any claims whatsoever.
147
148The Rhino Debugger
149
150You can obtain more information about the Rhino Debugger from the 
151Mozilla web site at http://www.mozilla.org/rhino/debugger.html
152
153JsDoc Toolkit is a larger work that uses the Rhino Debugger but
154is not derived from it in any way. The Rhino Debugger is used
155without modification and without any claims whatsoever.
156
157JsDoc Toolkit
158
159All code specific to JsDoc Toolkit are free, open source and licensed
160for use under the X11/MIT License.
161
162JsDoc Toolkit is Copyright (c)2009 Michael Mathews <micmath@gmail.com>
163
164This program is free software; you can redistribute it and/or
165modify it under the terms below.
166
167Permission is hereby granted, free of charge, to any person obtaining
168a copy of this software and associated documentation files (the
169"Software"), to deal in the Software without restriction, including
170without limitation the rights to use, copy, modify, merge, publish,
171distribute, sublicense, and/or sell copies of the Software, and to
172permit persons to whom the Software is furnished to do so, subject to
173the following conditions: The above copyright notice and this
174permission notice must be included in all copies or substantial
175portions of the Software.
176
177THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
178EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
179MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
180IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
181CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
182TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
183SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.