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 8507f83e88 Added support for @access tag.

2011-01-15 11:16:29 +00:00

build

Added sqlite support.

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

docs

Added more docs for tagging commonjs modules.

2010-12-18 22:18:59 +00:00

examples

More fixes to schema. Added tests for @tag.

2010-08-02 23:27:04 +01:00

modules

Added support for @access tag.

2011-01-15 11:16:29 +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

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

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

test

Added support for @access tag.

2011-01-15 11:16:29 +00:00

build.xml

Added sqlite support.

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

changes.md

Added docs and tests for type unions in the @type tag.

2010-07-28 22:46:08 +01:00

conf.json

Added support for the -q --query option to pass in custom options. Added support for haruki to generate XML when the format=xml query option is seen.

2011-01-09 14:39:44 +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

Added support for @global tag.

2011-01-14 21:21:45 +00:00

package.json

Added initial support for @alias tag. Added test for @module tag.

2011-01-13 00:46:41 +00:00

README.md

Added events, added parse handlers, added plugins and markdown plugin support.

2010-12-27 15:18:44 +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.

$ 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 Wiki: http://code.google.com/p/jsdoc/w/list

License

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