← Back to branch summary

~jstys-z/helioviewer.org/client5

« back to all changes in this revision

Viewing changes to install/tools/jsdoc-toolkit/README.txt

  • Committer: V. Keith Hughitt
  • Date: 2009-04-01 21:08:05 UTC
  • Revision ID: hughitt1@kore-20090401210805-372f7dgih07vxk42
nightly build 04-01-2009

Show diffs side-by-side

added added

removed removed

Lines of Context:
install/tools/jsdoc-toolkit/README.txt
 
1
======================================================================
 
2
 
 
3
DESCRIPTION:
 
4
 
 
5
This is the source code for JsDoc Toolkit, an automatic documentation
 
6
generation tool for JavaScript. It is written in JavaScript and is run
 
7
from a command line (or terminal) using the Java and Mozilla's Rhino
 
8
JavaScript runtime engine.
 
9
 
 
10
Using this tool you can automatically turn JavaDoc-like comments in
 
11
your JavaScript source code into published output files, such as HTML
 
12
or XML.
 
13
 
 
14
For more information, to report a bug, or to browse the technical
 
15
documentation for this tool please visit the official JsDoc Toolkit
 
16
project homepage at http://code.google.com/p/jsdoc-toolkit/
 
17
 
 
18
For the most up-to-date documentation on JsDoc Toolkit see the 
 
19
official wiki at http://code.google.com/p/jsdoc-toolkit/w/list
 
20
 
 
21
======================================================================
 
22
 
 
23
REQUIREMENTS:
 
24
 
 
25
JsDoc Toolkit is known to work with:
 
26
java version "1.6.0_03"
 
27
Java(TM) SE Runtime Environment (build 1.6.0_03-b05)
 
28
on Windows XP,
 
29
and java version "1.5.0_13"
 
30
Java(TM) 2 Runtime Environment, Standard Edition (build 1.5.0_13-b05-241)
 
31
on Mac OS X 10.4.
 
32
 
 
33
Other versions of java may or may not work with JsDoc Toolkit.
 
34
 
 
35
======================================================================
 
36
 
 
37
USAGE:
 
38
 
 
39
Running JsDoc Toolkit requires you to have Java installed on your
 
40
computer. For more information see http://www.java.com/getjava/
 
41
 
 
42
Before running the JsDoc Toolkit app you should change your current
 
43
working directory to the jsdoc-toolkit folder. Then follow the
 
44
examples below, or as shown on the project wiki.
 
45
 
 
46
On a computer running Windows a valid command line to run JsDoc
 
47
Toolkit might look like this:
 
48
 
 
49
> java -jar jsrun.jar app\run.js -a -t=templates\jsdoc mycode.js
 
50
 
 
51
On 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
 
 
55
The above assumes your current working directory contains jsrun.jar,
 
56
the "app" and "templates" subdirectories from the standard JsDoc
 
57
Toolkit distribution and that the relative path to the code you wish
 
58
to document is "mycode.js".
 
59
 
 
60
The 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
 
 
64
For help (usage notes) enter this on the command line:
 
65
 
 
66
$ java -jar jsrun.jar app/run.js --help
 
67
 
 
68
More information about the various command line options used by JsDoc
 
69
Toolkit are available on the project wiki.
 
70
 
 
71
======================================================================
 
72
 
 
73
TESTING:
 
74
 
 
75
To run the suite of unit tests included with JsDoc Toolkit enter this
 
76
on the command line:
 
77
 
 
78
$ java -jar jsrun.jar app/run.js -T
 
79
 
 
80
To see a dump of the internal data structure that JsDoc Toolkit has
 
81
built from your source files use this command:
 
82
 
 
83
$ java -jar jsrun.jar app/run.js mycode.js -Z
 
84
 
 
85
======================================================================
 
86
 
 
87
LICENSE:
 
88
 
 
89
JSDoc.pm
 
90
 
 
91
This project is based on the JSDoc.pm tool, created by Michael
 
92
Mathews and Gabriel Reid. More information on JsDoc.pm can
 
93
be found on the JSDoc.pm homepage: http://jsdoc.sourceforge.net/
 
94
 
 
95
Complete documentation on JsDoc Toolkit can be found on the project
 
96
wiki at http://code.google.com/p/jsdoc-toolkit/w/list
 
97
 
 
98
Rhino
 
99
 
 
100
Rhino (JavaScript in Java) is open source and licensed by Mozilla
 
101
under the MPL 1.1 or later/GPL 2.0 or later licenses, the text of
 
102
which is available at http://www.mozilla.org/MPL/
 
103
 
 
104
You can obtain the source code for Rhino from the Mozilla web site at
 
105
http://www.mozilla.org/rhino/download.html
 
106
 
 
107
JsDoc Toolkit is a larger work that uses the Rhino JavaScript engine
 
108
but is not derived from it in any way. The Rhino library is used 
 
109
without modification and without any claims whatsoever.
 
110
 
 
111
The Rhino Debugger
 
112
 
 
113
You can obtain more information about the Rhino Debugger from the 
 
114
Mozilla web site at http://www.mozilla.org/rhino/debugger.html
 
115
 
 
116
JsDoc Toolkit is a larger work that uses the Rhino Debugger but
 
117
is not derived from it in any way. The Rhino Debugger is used
 
118
without modification and without any claims whatsoever.
 
119
 
 
120
JsDoc Toolkit
 
121
 
 
122
All code specific to JsDoc Toolkit are free, open source and licensed
 
123
for use under the X11/MIT License.
 
124
 
 
125
JsDoc Toolkit is Copyright (c)2009 Michael Mathews <micmath@gmail.com>
 
126
 
 
127
This program is free software; you can redistribute it and/or
 
128
modify it under the terms below.
 
129
 
 
130
Permission is hereby granted, free of charge, to any person obtaining
 
131
a copy of this software and associated documentation files (the
 
132
"Software"), to deal in the Software without restriction, including
 
133
without limitation the rights to use, copy, modify, merge, publish,
 
134
distribute, sublicense, and/or sell copies of the Software, and to
 
135
permit persons to whom the Software is furnished to do so, subject to
 
136
the following conditions: The above copyright notice and this
 
137
permission notice must be included in all copies or substantial
 
138
portions of the Software.
 
139
 
 
140
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 
141
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 
142
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 
143
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
 
144
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 
145
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 
146
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.