7

Project roadmap

hegemonic edited this page 2013-01-29 11:57:19 -08:00

Table of Contents

• Version 3.1 (January 2013)
• Version 3.2 (March 2013)
• Version 3.3 (April 2013)
• Archived roadmaps

This page provides a high-level roadmap for future improvements to JSDoc. See the issues page for details about other features and bug fixes that are being considered.

To propose additions or changes to the roadmap, please file a new issue or post a message to the JSDoc mailing list.

The roadmap is subject to change at any time.

Version 3.1 (January 2013)

1. Improve support for documenting callback functions.
2. Improve the functionality of {@link} tags.
3. Prepare for Node.js compatibility.
   • Complete all known API changes that could break templates/plugins. Example: fs module changes (#211).
   • Reorganize the tree as a Node.js-style project, and isolate Rhino-specific code (#210).

Version 3.2 (March 2013)

1. Improve compatibility with Google Closure Compiler. (#152)
   • Integrate the Catharsis parser.
   • Link to other types as appropriate. Example: If the classes Foo and Bar are documented, Array.<(Foo|Bar)> should link to the docs for those classes.
2. Improve support for documenting overloaded methods.
3. Enhance the appearance of the default template.

Version 3.3 (April 2013)

1. Provide experimental support for JSDoc on Node.js.
   • Integrate a new JS parser that can be used in place of Rhino's built-in parser.
   • Ensure that JSDoc passes all unit tests on Node.js 0.8.x.
   • Publish JSDoc to npm.
2. Provide an experimental asynchronous interface for generating doc output.

Archived roadmaps

Version 3.0 roadmap