Skip to content

Commit e9d17e8

Browse files
committed
Add @OverRide and @readonly support
1 parent d2637ad commit e9d17e8

File tree

2 files changed

+23
-5
lines changed

2 files changed

+23
-5
lines changed

lib/parse.js

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,7 @@
33
var doctrine = require('doctrine');
44

55
var flatteners = {
6-
'abstract': function (result) {
7-
result.abstract = true;
8-
},
6+
'abstract': flattenBoolean,
97
'access': function (result, tag) {
108
result.access = tag.access;
119
},
@@ -98,7 +96,7 @@ var flatteners = {
9896
'module': flattenTypedName,
9997
'name': flattenName,
10098
'namespace': flattenTypedName,
101-
// 'override'
99+
'override': flattenBoolean,
102100
'overview': synonym('file'),
103101
'param': function (result, tag) {
104102
if (!result.params) {
@@ -122,7 +120,7 @@ var flatteners = {
122120
'public': function (result) {
123121
result.access = 'public';
124122
},
125-
// 'readonly'
123+
'readonly': flattenBoolean,
126124
// 'requires'
127125
'return': synonym('returns'),
128126
'returns': function (result, tag) {
@@ -170,6 +168,10 @@ function synonym(key) {
170168
};
171169
}
172170

171+
function flattenBoolean(result, tag, key) {
172+
result[key] = true;
173+
}
174+
173175
function flattenName(result, tag, key) {
174176
result[key] = tag.name;
175177
}

test/lib/parse.js

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -341,6 +341,14 @@ test('parse - @namespace', function (t) {
341341
t.end();
342342
});
343343

344+
test('parse - @override', function (t) {
345+
t.equal(evaluate(function () {
346+
/** @override */
347+
})[0].override, true);
348+
349+
t.end();
350+
});
351+
344352
test('parse - @overview', function (t) {
345353
t.end();
346354
});
@@ -385,6 +393,14 @@ test('parse - @public', function (t) {
385393
t.end();
386394
});
387395

396+
test('parse - @readonly', function (t) {
397+
t.equal(evaluate(function () {
398+
/** @readonly */
399+
})[0].readonly, true);
400+
401+
t.end();
402+
});
403+
388404
test('parse - @return', function (t) {
389405
t.deepEqual(evaluate(function () {
390406
/** @return test */

0 commit comments

Comments
 (0)