js api documentation generator code example

Example: use jsdoc

/**
 * @file filename
 * @author you <email>
 * @version 0.1
 */

  /**
   * Function definition.
   *
   * @param {String} arg1.
   * @param {Number} arg2
   * @param {Object} arg3
   */

    /**
     * Return.
     *
     * @see [Example]{@link http://example.com}
     * @returns {Number} The value of..
     */
jsdoc filename.js