archive-gh-me/jsdoc

Fork 0

mirror of https://github.com/jsdoc/jsdoc.git synced 2025-12-08 19:46:11 +00:00

Go to file

Michael Mathews f78a10c4b4 Added additional tests for @exports.

2011-01-29 17:08:01 +00:00

build

Updated project meta.

2011-01-16 20:14:53 +00:00

modules

Added better support for documenting properties of the "exports" global in commonjs modules.

2011-01-29 10:31:50 +00:00

plugins

Added in linkify function to default template. Added ability to keep HTML tags in text processed by the markdown plugin.

2011-01-06 17:14:38 +00:00

templates

Added exceptions to template. Improved name/longname resolution: namespace now is only applied to longname when using the @alias tag, names that are fully quoted strings no longer have incorrect shortening.

2011-01-26 08:48:01 +00:00

test

Added additional tests for @exports.

2011-01-29 17:08:01 +00:00

build.xml

Added sqlite support.

2011-01-09 00:06:55 +00:00

changes.md

Added additional test for alias.

2011-01-25 19:19:49 +00:00

conf.json

Added additional test for alias.

2011-01-25 19:19:49 +00:00

jsdoc

Moved mustache.js into modules. Added shell script to run jsdoc.jar.

2011-01-10 21:38:47 +00:00

LICENSE.md

Changes to update the haruki template to work with refactored core code.

2011-01-09 14:05:39 +00:00

main.js

2011-01-26 08:48:01 +00:00

package.json

Updated about info.

2011-01-24 22:42:48 +00:00

README.md

Update to readme.

2011-01-22 23:58:26 +00:00

README.md

JSDoc 3

This is pre-release software, under active development. It is not intended for general use.

Install

To build the jsdoc jar that runs JSDoc 3, use the ant build tool.

git clone git://github.com/micmath/jsdoc.git jsdoc
cd jsdoc
ant

This will create a file name jsdoc.jar in the project base directory.

To test that the installed app is working, execute the following:

java -jar jsdoc.jar --test

Usage

This example assumes your working directory is the JSDoc project base directory...

java -jar jsdoc.jar yourSourceCodeFile.js

For help regarding the supported commandline options use -h.

java -jar jsdoc.jar --help

See

Project Documentation: http://micmath.github.com/jsdoc

License

See file "LICENSE.md" in this distribution for more details about terms of use.