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

Add @interface support

Browse Source
This commit is contained in:
John Firebaugh 2016-03-14 18:25:57 -07:00
parent e9d17e8795
commit 40af71635f
2 changed files with 18 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
lib/parse.js
View File

@ -79,7 +79,12 @@ var flatteners = {
'instance': function (result) {
result.scope = 'instance';
},
// 'interface'
'interface': function (result, tag) {
result.interface = true;
if (tag.description) {
result.name = tag.description;
}
},
'kind': function (result, tag) {
result.kind = tag.kind;
},

12
test/lib/parse.js
View File

@ -254,6 +254,18 @@ test('parse - @instance', function (t) {
t.end();
});
test('parse - @interface', function (t) {
t.deepEqual(evaluate(function () {
/** @interface */
})[0].interface, true, 'anonymous');
t.deepEqual(evaluate(function () {
/** @interface Foo */
})[0].name, 'Foo', 'named');
t.end();
});
test('parse - @kind', function (t) {
t.equal(evaluate(function () {
/** @kind class */