/branches/jsdoc_tk_gui/setup/README.txt

http://jsdoc-toolkit.googlecode.com/ · Plain Text · 131 lines · 90 code · 41 blank · 0 comment · 0 complexity · e15d8ba2f60a9275be15946a7d4c3715 MD5 · raw file

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