YUIDoc

YUIDoc is the official documentation generator used by the Yahoo! team for the Yahoo! User Interface 3.x (YUI) series.

The app works by scanning JavaScript code for comments, and using them as documentation for the code itself.

YUIDoc can be used to document information about properties, custom events, methods and inheritance for JS objects.

Besides generating documentation sites out of JavaScript code, YUIDoc also comes with a built-in Web server as well. This feature was included to allow developers to preview documentation sites in real-time, while they write their code and comments.

YUIDoc should not be confused with YUI Doc, a similar documentation generator from Yahoo, but written mainly in Python.

What is new in this release:

• YUIDoc v0.9.0 supports documenting Custom Elements.

What is new in version 0.7.0:

• Fixed:
• Switch to true Markdown options as default
• Fix a bug that inherited class was parsed twice
• Unindent method Handlebars partials within constructor classes
• Use logFn configuration to logging
• Changed:
• Drop removed JSHint rules

What is new in version 0.6.0:

• Changed:
• The Markdown parser to markdown-it
• Add Node.js v0.12 and io.js in Travis CI setting
• Fixed:
• A bug with "@" doesn't escapable in example

What is new in version 0.5.0:

• YUIDoc supports @throws tag finally, and it includes more compatibility with Handlebars v2.0, enhancements, and dependencies updates.

What is new in version 0.4.0:

• Supports ES6 style rest parameters syntax for multiple parameters
• Allows base URLs for external links
• Adds --no-sort option

What is new in version 0.3.49:

• Changed URL creation to simply join strings.

What is new in version 0.3.47:

• Modify linting: Successful lint exits the CLI, unsuccessful lint exits the process.
• Change lint so that process only exits on failure.

Requirements:

• Node.js 0.4 or higher