mirror of
https://github.com/documentationjs/documentation.git
synced 2025-12-08 18:23:43 +00:00
11d9045a00
* build: Use Flow syntax without comments. We're switching to Flow annotations - not Flow comments. This gives documentation.js the ability to self-document without JSDoc types and improves our compatibility with tools like prettier. Fixes #729. Fixes #709
24 lines
541 B
JavaScript
24 lines
541 B
JavaScript
/**
|
|
* Adds one to a number
|
|
* @param {number} a the input
|
|
* @returns {number} the output
|
|
*/
|
|
function addOne(a) {
|
|
return a + 1;
|
|
}
|
|
|
|
/**
|
|
* This function returns the number one. Internally, this uses
|
|
* {@link addOne} to do the math. This demonstrates
|
|
* {@link https://en.wikipedia.org/wiki/Addition Addition}
|
|
* and {@link https://en.wikipedia.org/wiki/Addition}
|
|
*
|
|
* This link refers to nothing: {@link nothing}
|
|
*
|
|
* @param {number} a the input
|
|
* @returns {number} numberone
|
|
*/
|
|
module.exports = function(a) {
|
|
return addOne(a);
|
|
};
|