mirror of
https://github.com/documentationjs/documentation.git
synced 2026-01-18 14:17:30 +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
22 lines
465 B
JavaScript
22 lines
465 B
JavaScript
/**
|
|
* This function returns the number one.
|
|
* @returns {Number} numberone
|
|
* @example
|
|
* var myFoo = new Foo('[data-foo]');
|
|
* myFoo.foo(42);
|
|
* @example
|
|
* <p data-foo>Data-Foo Element in the dom</p>
|
|
* @example
|
|
* [data-foo] {
|
|
* background-color: red;
|
|
* }
|
|
* @throws {Error} if you give it something
|
|
* @throws {TypeError} if you give it something else
|
|
* @augments Foo
|
|
* @augments Bar
|
|
*/
|
|
module.exports = function() {
|
|
// this returns 1
|
|
return 1;
|
|
};
|