mirror of
https://github.com/documentationjs/documentation.git
synced 2026-01-18 14:17:30 +00:00
5b48290395
The `@description` tag allows people to specify a description of a node in any place in the JSDoc comment, instead of only at the beginning. Fixes https://github.com/documentationjs/documentation/issues/341
17 lines
412 B
JavaScript
17 lines
412 B
JavaScript
/**
|
|
* This description is ignored because the method has a tagged description.
|
|
* @returns {number} numberone
|
|
* @description This function returns the number one.
|
|
* @see {@link http://github.com/|github}
|
|
* @see TestCase
|
|
* @see [markdown link](http://foo.com/)
|
|
* @version 1.0.0
|
|
* @since 2.0.0
|
|
* @copyright Tom MacWright
|
|
* @license BSD
|
|
*/
|
|
module.exports = function() {
|
|
// this returns 1
|
|
return 1;
|
|
};
|