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
20 lines
655 B
JavaScript
20 lines
655 B
JavaScript
/**
|
|
* @param {Object[]} employees - The employees who are responsible for the project.
|
|
* @param {string} employees[].name - The name of an employee.
|
|
* @param {string} employees[].department - The employee's department.
|
|
* @param {string} [type=minion] - The employee's type.
|
|
*/
|
|
function foo(employees, type) {}
|
|
|
|
/**
|
|
* @name foo
|
|
* @param {Object} options some options
|
|
* @param {number} options.much how much
|
|
* @param {number} bar something else
|
|
* @property {Object} theTime the current time
|
|
* @property {number} theTime.hours
|
|
* @property {number} theTime.minutes
|
|
* @property {number} theTime.seconds
|
|
* @returns {Object} foo something else
|
|
*/
|