Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 22 additions & 3 deletions lib/analyze.js
Original file line number Diff line number Diff line change
Expand Up @@ -100,10 +100,28 @@ module.exports = function(ast, argv) {
var fn = tag;
fn.params = tag.params || [];
fn.hasParams = !!fn.params.length;

fn.params.forEach(function(p) {
// rename to force parameter description
// being printed (ignoring function
// description)
p.pDescription = p.description;

// nest child params
if (p.name.indexOf('.') !== -1) {
p.nested = true;
}
});

// For the function signature
fn.paramsString = fn.params.map(function(p) {
return p.name;
}).join(', ');
fn.paramsString = fn.params
// Only include top level parameters (no object properties)
.filter(function(p) {
return !p.nested;
})
.map(function(p) {
return p.name;
}).join(', ');

// For param details
fn.params.forEach(setPipedTypesString);
Expand All @@ -112,6 +130,7 @@ module.exports = function(ast, argv) {
setPipedTypesString(ret);
ret.description = ret.description || false;
});

// To avoid reaching to the parent for these fields
fn.version = tag.version || false;
fn.fires = tag.fires || [];
Expand Down
4 changes: 2 additions & 2 deletions templates/function.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ Deprecated: {{{deprecated}}}

{{/hasParams}}
{{#params}}
**{{name}}**: {{#typesString}}`{{typesString}}`{{/typesString}}{{#description}}, {{{description}}}{{/description}}

{{#nested}} {{/nested}} - **{{name}}**: {{#typesString}}`{{typesString}}`{{/typesString}}{{#pDescription}}, {{{pDescription}}}{{/pDescription}}
{{/params}}

{{#fires}}
**Fires**: {{.}}

Expand Down