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
29 lines
471 B
JavaScript
29 lines
471 B
JavaScript
/**
|
|
* This is my class, a demo thing.
|
|
*
|
|
* @class MyClass
|
|
* @memberof com.Test
|
|
*/
|
|
com.Test.MyClass = class {
|
|
constructor() {
|
|
this.howMany = 2;
|
|
}
|
|
|
|
/**
|
|
* Get the number 42
|
|
*
|
|
* @param {boolean} getIt whether to get the number
|
|
* @returns {number} forty-two
|
|
*/
|
|
getFoo(getIt) {
|
|
return getIt ? 42 : 0;
|
|
}
|
|
|
|
/**
|
|
* Get undefined
|
|
*
|
|
* @returns {undefined} does not return anything.
|
|
*/
|
|
static getUndefined() {}
|
|
};
|