archive-gh-me/documentation
1
0
Fork 0
mirror of https://github.com/documentationjs/documentation.git synced 2026-01-18 14:17:30 +00:00
Code Issues Projects Releases Wiki Activity

Use @callback name if present (fixes #136)

Browse Source
This commit is contained in:
John Firebaugh 2015-08-30 16:54:37 -07:00
parent 6940c30943
commit 3920fd2279
2 changed files with 15 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
streams/infer/name.js
View File

@ -20,12 +20,13 @@ module.exports = function inferName() {
return callback(null, comment);
}
// If this comment has a @class, @event, or @typedef tag with a name,
// use it.
// If this comment has a @class, @event, @typedef, or @callback
// tag with a name, use it.
var explicitNameTags = {
'class': 'name',
'event': 'description',
'typedef': 'description'
'typedef': 'description',
'callback': 'description'
};
for (var title in explicitNameTags) {

11
test/streams/infer_name.js
View File

@ -144,3 +144,14 @@ test('inferName - typedef', function (t) {
t.end();
});
});
test('inferName - callback', function (t) {
evaluate(function () {
/** @callback explicitCallback */
function implicitName() {}
return implicitName;
}, function (result) {
t.equal(result[ 0 ].name, 'explicitCallback');
t.end();
});
});