Merge pull request #410 from thetrime/use_options_tsdoc

Correctly document params when useOptions is set
This commit is contained in:
Ferdi Koomen 2020-11-15 12:35:30 +01:00 committed by GitHub
commit c76d3c41e4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 8 additions and 5 deletions

View File

@ -23,11 +23,13 @@ export class {{{name}}} {
{{#if description}}
* {{{description}}}
{{/if}}
{{#if parameters}}
{{#each parameters}}
* @param {{{name}}} {{{description}}}
{{/each}}
{{/if}}
{{#unless @root.useOptions}}
{{#if parameters}}
{{#each parameters}}
* @param {{{name}}} {{{description}}}
{{/each}}
{{/if}}
{{/unless}}
{{#each results}}
* @result {{{type}}} {{{description}}}
{{/each}}

View File

@ -6,6 +6,7 @@
{{/each}}
}: {
{{#each parameters}}
/** {{{description}}} */
{{{name}}}{{>isRequired}}: {{>type}},
{{/each}}
}