jsdoc-sphinx
Version:
A JSDoc3 template which output ReStructured Text for Sphinx Doc
79 lines (65 loc) • 1.37 kB
JavaScript
/* eslint require-jsdoc:0 */
/* eslint no-unused-vars:0 */
/**
* @namespace rootNameSpace
* @desc
* Description of rootNameSpace
*/
/**
* 'function', 'member', 'constant', 'attribute', 'typedef', 'type'
*/
/**
* someFunc description.
* @function
* @memberof rootNameSpace
* @name someFunc
* @param {string} a A parameter
* @return {int} Some randome number
*/
/**
* Height member description.
* @member
* @memberof rootNameSpace
* @name {int} height
*/
/**
* @constant {string} ENCODING
* @memberof rootNameSpace
*/
/**
* @attribute {int} width - The current width
* @memberof rootNameSpace
*/
/**
* @namespace childNameSpace
* @memberof rootNameSpace
*/
/**
* @namespace secondChildNameSpace
* @memberof rootNameSpace
*/
/**
* @module MyModule
* @memberof rootNameSpace
*/
/**
* @function robustFunction
* @memberof rootNameSpace
* @desc
* Function description
*
* @param {string} a First parameter
* @param {string|array} [b] Second parameter
* @param {object} options The options param
* @param {string} options.stick An option attribute
* @param {string} options.row An option attribute with
* a much longer description
* @return {int} The function result
*/
/**
* @module TopLevelModule
* @desc
* Description of TopLevelModule
*/
function yo() {
}