UNPKG

jsdoc-sphinx

Version:

A JSDoc3 template which output ReStructured Text for Sphinx Doc

22 lines (19 loc) 482 B
/** * @namespace anotherRootNamespace */ /** * @typedef {object} User * @memberof anotherRootNamespace * @desc * A user. * @property {string} username The username * @property {string} displayName The displayName */ /** * @function * @name login * @memberof anotherRootNamespace * @param {string} username The username to authenticate * @param {string} password The user password * @return {User} An authenticated user */