Skip to content

Version 3.0 roadmap

hegemonic edited this page Nov 11, 2012 · 1 revision
  1. ✓ Support doclets associated with multiple var declarations, separated by commas.

    Example:

    /** for a */
    var a,
    /** for b */
    b;
    
  2. ✓ Support multiple doclets associated with a single code symbol.

    Example:

    /**
     * Set the name.
     * @param {string} newName
     *//**
     * Get the name.
     * @returns {string}
     */
    this.name = function(newName){
        if (typeof newName === 'string') {
            this._name = newName;
        }
        else {
            return this._name;
        }
    }
    
  3. ✓ Support documenting CommonJS modules with exported symbols.

    Example:

    /**
     * @module foo/bar
     */
    
    /**
     * An exported function.
     */
    exports.doit = function(){
    }
    
  4. ✓ Add @default tag. Support automatic @default for simple values types like strings, numbers, null, or named variables.

    Example:

    /**
     * Is documented as having a default value of 1.
     * @type {number}
     * @default
     */
    var count = 1;
    
  5. ✓ Simplify the commandline arguments as much as possible.

  6. ✓ Replace the bespoke templating toolset with an open source third party tool.

Clone this wiki locally