JSDoc

JSDoc can produce documentation in a wide number of text-based formats like HTML, XML, JSON, and so on.

JSDoc was previously know as JsDoc Toolkit.

The former JSDoc versions used Java to parse the source code, extract comments and generate the documentation. Since the 3.x branch Node.js is used instead.

Besides Node.js, JSDoc can also work with Mozilla's Rhino engine as well.

To use JSDoc properly, check its documentation for information about how to format your source code comments so they can be detected and used by JSDoc's engine.

What is new in this release:

• Can now run JSDoc on Node.js.
• Can now use the @interface and @implements tags to document interfaces and their implementations.
• Closure Compiler's @inheritDoc and @override tags are now supported.
• If the JSDoc comment for a symbol includes the @mixes tag, all of the mixins now appear in the symbol's documentation.
• JSDoc can now log information to the console as it runs (for example, the name of each file that JSDoc parses). To log this information, run JSDoc with the --verbose flag.
• Can now use any file as the package or README file for your documentation. Use the -P/--package/ and -R/--readme flags to specify the package and README file.
• The default template's typography and color scheme have been significantly improved.

What is new in version 3.3.2:

• Can now run JSDoc on Node.js.
• Can now use the @interface and @implements tags to document interfaces and their implementations.
• Closure Compiler's @inheritDoc and @override tags are now supported.
• If the JSDoc comment for a symbol includes the @mixes tag, all of the mixins now appear in the symbol's documentation.
• JSDoc can now log information to the console as it runs (for example, the name of each file that JSDoc parses). To log this information, run JSDoc with the --verbose flag.
• Can now use any file as the package or README file for your documentation. Use the -P/--package/ and -R/--readme flags to specify the package and README file.
• The default template's typography and color scheme have been significantly improved.

What is new in version 3.3.0:

• Can now run JSDoc on Node.js.
• Can now use the @interface and @implements tags to document interfaces and their implementations.
• Closure Compiler's @inheritDoc and @override tags are now supported.
• If the JSDoc comment for a symbol includes the @mixes tag, all of the mixins now appear in the symbol's documentation.
• JSDoc can now log information to the console as it runs (for example, the name of each file that JSDoc parses). To log this information, run JSDoc with the --verbose flag.
• Can now use any file as the package or README file for your documentation. Use the -P/--package/ and -R/--readme flags to specify the package and README file.
• The default template's typography and color scheme have been significantly improved.

What is new in version 3.2.2 / 3.3.0-beta1:

• Addressed a regression in JSDoc 3.2.1 that could prevent a function declaration from shadowing a declaration with the same name in an outer scope.
• If a child class overrides a method in a parent class without documenting the overridden method, the method's documentation is now copied from the parent class.
• You can now use inline HTML tags in Markdown-formatted text. In addition, JSDoc now uses only the marked Markdown parser; the markdown-js parser has been removed.
• Type expressions can now include a much broader range of repeatable types. In addition, you can now use Closure Compiler's nullable and non-nullable modifiers with repeatable types. For example, the type expression ...!string (a repeatable, non-nullable string) is now parsed correctly.

What is new in version 2.4.0:

• Fixed bug that added mutiple symbols with the same name to docs.
• Added support for the -m option to suppress warnings for multiple docs.
• Added patch by brownsea42 to support quoted user variables on the command line.
• Fixed bug that sometimes caused links to events to be incorrect.

Requirements:

• JavaScript enabled on client side
• Node.js 0.10 or higher