Skip to content

Commit 11a7758

Browse files
committed
Add placeholders for remaining tags
1 parent bad9c47 commit 11a7758

File tree

2 files changed

+72
-14
lines changed

2 files changed

+72
-14
lines changed

lib/parse.js

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -17,22 +17,22 @@ var flatteners = {
1717
result.augments.push(tag);
1818
},
1919
'author': flattenDescription,
20-
// 'borrows'
20+
'borrows': todo,
2121
'callback': flattenDescription,
2222
'class': flattenTypedName,
2323
'classdesc': flattenDescription,
2424
'const': synonym('constant'),
2525
'constant': flattenTypedName,
2626
'constructor': synonym('class'),
27-
// 'constructs'
27+
'constructs': todo,
2828
'copyright': flattenDescription,
29-
// 'default'
29+
'default': todo,
3030
'defaultvalue': synonym('default'),
3131
'deprecated': flattenDescription,
3232
'desc': synonym('description'),
3333
'description': flattenDescription,
3434
'emits': synonym('fires'),
35-
// 'enum'
35+
'enum': todo,
3636
'event': flattenDescription,
3737
'example': function (result, tag) {
3838
if (!tag.description) {
@@ -58,21 +58,21 @@ var flatteners = {
5858
result.examples.push(example);
5959
},
6060
'exception': synonym('throws'),
61-
// 'exports'
61+
'exports': todo,
6262
'extends': synonym('augments'),
6363
'external': flattenDescription,
6464
'file': flattenDescription,
6565
'fileoverview': synonym('file'),
66-
// 'fires'
66+
'fires': todo,
6767
'func': synonym('function'),
6868
'function': flattenName,
6969
'global': function (result) {
7070
result.scope = 'global';
7171
},
7272
'host': synonym('external'),
7373
'ignore': flattenBoolean,
74-
// 'implements'
75-
// 'inheritdoc'
74+
'implements': todo,
75+
'inheritdoc': todo,
7676
'inner': function (result) {
7777
result.scope = 'inner';
7878
},
@@ -92,11 +92,11 @@ var flatteners = {
9292
'license': flattenDescription,
9393
'linkcode': synonym('link'),
9494
'linkplain': synonym('link'),
95-
// 'listens'
95+
'listens': todo,
9696
'member': flattenTypedName,
9797
'memberof': flattenDescription,
9898
'method': synonym('function'),
99-
// 'mixes'
99+
'mixes': todo,
100100
'mixin': flattenName,
101101
'module': flattenTypedName,
102102
'name': flattenName,
@@ -126,7 +126,7 @@ var flatteners = {
126126
result.access = 'public';
127127
},
128128
'readonly': flattenBoolean,
129-
// 'requires'
129+
'requires': todo,
130130
'return': synonym('returns'),
131131
'returns': function (result, tag) {
132132
if (!result.returns) {
@@ -145,7 +145,7 @@ var flatteners = {
145145
result.scope = 'static';
146146
},
147147
'summary': flattenDescription,
148-
// 'this'
148+
'this': todo,
149149
'throws': function (result, tag) {
150150
if (!result.throws) {
151151
result.throws = [];
@@ -158,8 +158,8 @@ var flatteners = {
158158
}
159159
result.todos.push(tag.description);
160160
},
161-
// 'tutorial'
162-
// 'type'
161+
'tutorial': todo,
162+
'type': todo,
163163
'typedef': flattenTypedName,
164164
'var': synonym('member'),
165165
'variation': function (result, tag) {
@@ -169,6 +169,8 @@ var flatteners = {
169169
'virtual': synonym('abstract')
170170
};
171171

172+
function todo() {}
173+
172174
function synonym(key) {
173175
return function (result, tag) {
174176
return flatteners[key](result, tag, key);

test/lib/parse.js

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,10 @@ test('parse - @author', function (t) {
5858
t.end();
5959
});
6060

61+
test('parse - @borrows', function (t) {
62+
t.end();
63+
});
64+
6165
test('parse - @callback', function (t) {
6266
t.equal(evaluate(function () {
6367
/** @callback name */
@@ -100,6 +104,10 @@ test('parse - @constructor', function (t) {
100104
t.end();
101105
});
102106

107+
test('parse - @constructs', function (t) {
108+
t.end();
109+
});
110+
103111
test('parse - @copyright', function (t) {
104112
t.equal(evaluate(function () {
105113
/** @copyright test */
@@ -108,6 +116,10 @@ test('parse - @copyright', function (t) {
108116
t.end();
109117
});
110118

119+
test('parse - @default', function (t) {
120+
t.end();
121+
});
122+
111123
test('parse - @defaultvalue', function (t) {
112124
t.end();
113125
});
@@ -136,6 +148,10 @@ test('parse - @emits', function (t) {
136148
t.end();
137149
});
138150

151+
test('parse - @enum', function (t) {
152+
t.end();
153+
});
154+
139155
test('parse - @event', function (t) {
140156
t.equal(evaluate(function () {
141157
/** @event name */
@@ -186,6 +202,10 @@ test('parse - @exception', function (t) {
186202
t.end();
187203
});
188204

205+
test('parse - @exports', function (t) {
206+
t.end();
207+
});
208+
189209
test('parse - @extends', function (t) {
190210
t.deepEqual(evaluate(function () {
191211
/** @extends Foo */
@@ -214,6 +234,10 @@ test('parse - @fileoverview', function (t) {
214234
t.end();
215235
});
216236

237+
test('parse - @fires', function (t) {
238+
t.end();
239+
});
240+
217241
test('parse - @func', function (t) {
218242
t.end();
219243
});
@@ -246,6 +270,14 @@ test('parse - @ignore', function (t) {
246270
t.end();
247271
});
248272

273+
test('parse - @implements', function (t) {
274+
t.end();
275+
});
276+
277+
test('parse - @inheritdoc', function (t) {
278+
t.end();
279+
});
280+
249281
test('parse - @inner', function (t) {
250282
t.equal(evaluate(function () {
251283
/** @inner*/
@@ -302,6 +334,10 @@ test('parse - @linkplain', function (t) {
302334
t.end();
303335
});
304336

337+
test('parse - @listens', function (t) {
338+
t.end();
339+
});
340+
305341
test('parse - @member', function (t) {
306342
t.equal(evaluate(function () {
307343
/** @member name */
@@ -322,6 +358,10 @@ test('parse - @method', function (t) {
322358
t.end();
323359
});
324360

361+
test('parse - @mixes', function (t) {
362+
t.end();
363+
});
364+
325365
test('parse - @mixin', function (t) {
326366
t.equal(evaluate(function () {
327367
/** @mixin name */
@@ -421,6 +461,10 @@ test('parse - @readonly', function (t) {
421461
t.end();
422462
});
423463

464+
test('parse - @requires', function (t) {
465+
t.end();
466+
});
467+
424468
test('parse - @return', function (t) {
425469
t.deepEqual(evaluate(function () {
426470
/** @return test */
@@ -465,6 +509,10 @@ test('parse - @summary', function (t) {
465509
t.end();
466510
});
467511

512+
test('parse - @this', function (t) {
513+
t.end();
514+
});
515+
468516
test('parse - @throws', function (t) {
469517
t.equal(evaluate(function () {
470518
/** @throws {Object} exception */
@@ -481,6 +529,14 @@ test('parse - @todo', function (t) {
481529
t.end();
482530
});
483531

532+
test('parse - @tutorial', function (t) {
533+
t.end();
534+
});
535+
536+
test('parse - @type', function (t) {
537+
t.end();
538+
});
539+
484540
test('parse - @typedef', function (t) {
485541
t.deepEqual(evaluate(function () {
486542
/** @typedef {Object} name */

0 commit comments

Comments
 (0)