otris / jsdoc-tsd

JSDoc template for generating TypeScript definition files based on JSDoc comments.
MIT License
29 stars 7 forks source link

Support parameters with properties #13

Closed tineheller closed 6 years ago

tineheller commented 6 years ago

Parameters with properties are described in http://usejsdoc.org/tags-param.html#parameters-with-properties

The paramters with properties are required to generate d.ts files for additional DOCUMENTS modules like DocumentsContext.

At the moment all parameter properties are added to the parameters in the function declaration.

wehrstedt commented 6 years ago

TODO: Add a test for this type of annotation:

/**
 * Assign the project to a list of employees.
 * @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 
 */
wehrstedt commented 6 years ago

Solved with #15

wehrstedt commented 6 years ago

Forgot to add the test described above..

tineheller commented 6 years ago

Support and test for array parameters is added with #31