Documentation generator for Google Closure Javascript
- by Julius Eckert
I want to generate a HTML-Documentation for my Javascript code.
The comments in my code are written in a format, the Google Closure Compiler can use to optimize my code.
Example:
/**
* Class for handling timing events.
*
* @param {number=} opt_interval Number of ms between ticks (Default: 1ms).
* @param {Object=} opt_timerObject An object that has setTimeout, setInterval,
* clearTimeout and clearInterval (eg Window).
* @constructor
* @extends {goog.events.EventTarget}
*/
goog.Timer = function(opt_interval, opt_timerObject) {
...
}
I am looking for something like http://yardoc.org for Javascript.
What tools can you recommend? Are there any specific tools for Google Closure code?