Skip to content

Commit 09a4faa

Browse files
tmcwtmcw
committed
Cover lib/parse
1 parent 02df59c commit 09a4faa

File tree

1 file changed

+147
-0
lines changed

1 file changed

+147
-0
lines changed

‎lib/parse.js

Lines changed: 147 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,26 @@ var parseMarkdown = require('./parse_markdown');
1212
*/
1313
var flatteners = {
1414
'abstract': flattenBoolean,
15+
/**
16+
* Parse tag
17+
* @private
18+
* @param {Object} result target comment
19+
* @param {Object} tag the tag
20+
* @returns {undefined} has side-effects
21+
*/
1522
'access': function (result, tag) {
1623
result.access = tag.access;
1724
},
1825
'alias': flattenName,
1926
'arg': synonym('param'),
2027
'argument': synonym('param'),
28+
/**
29+
* Parse tag
30+
* @private
31+
* @param {Object} result target comment
32+
* @param {Object} tag the tag
33+
* @returns {undefined} has side-effects
34+
*/
2135
'augments': function (result, tag) {
2236
if (!result.augments) {
2337
result.augments = [];
@@ -26,6 +40,13 @@ var flatteners = {
2640
},
2741
'author': flattenDescription,
2842
'borrows': todo,
43+
/**
44+
* Parse tag
45+
* @private
46+
* @param {Object} result target comment
47+
* @param {Object} tag the tag
48+
* @returns {undefined} has side-effects
49+
*/
2950
'callback': function (result, tag) {
3051
result.kind = 'typedef';
3152

@@ -52,13 +73,27 @@ var flatteners = {
5273
'description': flattenMarkdownDescription,
5374
'emits': synonym('fires'),
5475
'enum': todo,
76+
/**
77+
* Parse tag
78+
* @private
79+
* @param {Object} result target comment
80+
* @param {Object} tag the tag
81+
* @returns {undefined} has side-effects
82+
*/
5583
'event': function (result, tag) {
5684
result.kind = 'event';
5785

5886
if (tag.description) {
5987
result.name = tag.description;
6088
}
6189
},
90+
/**
91+
* Parse tag
92+
* @private
93+
* @param {Object} result target comment
94+
* @param {Object} tag the tag
95+
* @returns {undefined} has side-effects
96+
*/
6297
'example': function (result, tag) {
6398
if (!tag.description) {
6499
result.errors.push({
@@ -85,13 +120,27 @@ var flatteners = {
85120
'exception': synonym('throws'),
86121
'exports': todo,
87122
'extends': synonym('augments'),
123+
/**
124+
* Parse tag
125+
* @private
126+
* @param {Object} result target comment
127+
* @param {Object} tag the tag
128+
* @returns {undefined} has side-effects
129+
*/
88130
'external': function (result, tag) {
89131
result.kind = 'external';
90132

91133
if (tag.description) {
92134
result.name = tag.description;
93135
}
94136
},
137+
/**
138+
* Parse tag
139+
* @private
140+
* @param {Object} result target comment
141+
* @param {Object} tag the tag
142+
* @returns {undefined} has side-effects
143+
*/
95144
'file': function (result, tag) {
96145
result.kind = 'file';
97146

@@ -103,25 +152,57 @@ var flatteners = {
103152
'fires': todo,
104153
'func': synonym('function'),
105154
'function': flattenKindShorthand,
155+
/**
156+
* Parse tag
157+
* @private
158+
* @param {Object} result target comment
159+
* @returns {undefined} has side-effects
160+
*/
106161
'global': function (result) {
107162
result.scope = 'global';
108163
},
109164
'host': synonym('external'),
110165
'ignore': flattenBoolean,
111166
'implements': todo,
112167
'inheritdoc': todo,
168+
/**
169+
* Parse tag
170+
* @private
171+
* @param {Object} result target comment
172+
* @returns {undefined} has side-effects
173+
*/
113174
'inner': function (result) {
114175
result.scope = 'inner';
115176
},
177+
/**
178+
* Parse tag
179+
* @private
180+
* @param {Object} result target comment
181+
* @returns {undefined} has side-effects
182+
*/
116183
'instance': function (result) {
117184
result.scope = 'instance';
118185
},
186+
/**
187+
* Parse tag
188+
* @private
189+
* @param {Object} result target comment
190+
* @param {Object} tag the tag
191+
* @returns {undefined} has side-effects
192+
*/
119193
'interface': function (result, tag) {
120194
result.interface = true;
121195
if (tag.description) {
122196
result.name = tag.description;
123197
}
124198
},
199+
/**
200+
* Parse tag
201+
* @private
202+
* @param {Object} result target comment
203+
* @param {Object} tag the tag
204+
* @returns {undefined} has side-effects
205+
*/
125206
'kind': function (result, tag) {
126207
result.kind = tag.kind;
127208
},
@@ -138,6 +219,13 @@ var flatteners = {
138219
'namespace': flattenKindShorthand,
139220
'override': flattenBoolean,
140221
'overview': synonym('file'),
222+
/**
223+
* Parse tag
224+
* @private
225+
* @param {Object} result target comment
226+
* @param {Object} tag the tag
227+
* @returns {undefined} has side-effects
228+
*/
141229
'param': function (result, tag) {
142230
if (!result.params) {
143231
result.params = [];
@@ -162,6 +250,12 @@ var flatteners = {
162250

163251
result.params.push(param);
164252
},
253+
/**
254+
* Parse tag
255+
* @private
256+
* @param {Object} result target comment
257+
* @returns {undefined} has side-effects
258+
*/
165259
'private': function (result) {
166260
result.access = 'private';
167261
},
@@ -186,15 +280,34 @@ var flatteners = {
186280

187281
result.properties.push(property);
188282
},
283+
/**
284+
* Parse tag
285+
* @private
286+
* @param {Object} result target comment
287+
* @returns {undefined} has side-effects
288+
*/
189289
'protected': function (result) {
190290
result.access = 'protected';
191291
},
292+
/**
293+
* Parse tag
294+
* @private
295+
* @param {Object} result target comment
296+
* @returns {undefined} has side-effects
297+
*/
192298
'public': function (result) {
193299
result.access = 'public';
194300
},
195301
'readonly': flattenBoolean,
196302
'requires': todo,
197303
'return': synonym('returns'),
304+
/**
305+
* Parse tag
306+
* @private
307+
* @param {Object} result target comment
308+
* @param {Object} tag the tag
309+
* @returns {undefined} has side-effects
310+
*/
198311
'returns': function (result, tag) {
199312
if (!result.returns) {
200313
result.returns = [];
@@ -210,18 +323,38 @@ var flatteners = {
210323

211324
result.returns.push(returns);
212325
},
326+
/**
327+
* Parse tag
328+
* @private
329+
* @param {Object} result target comment
330+
* @param {Object} tag the tag
331+
* @returns {undefined} has side-effects
332+
*/
213333
'see': function (result, tag) {
214334
if (!result.sees) {
215335
result.sees = [];
216336
}
217337
result.sees.push(parseMarkdown(tag.description));
218338
},
219339
'since': flattenDescription,
340+
/**
341+
* Parse tag
342+
* @private
343+
* @param {Object} result target comment
344+
* @returns {undefined} has side-effects
345+
*/
220346
'static': function (result) {
221347
result.scope = 'static';
222348
},
223349
'summary': flattenMarkdownDescription,
224350
'this': todo,
351+
/**
352+
* Parse tag
353+
* @private
354+
* @param {Object} result target comment
355+
* @param {Object} tag the tag
356+
* @returns {undefined} has side-effects
357+
*/
225358
'throws': function (result, tag) {
226359
if (!result.throws) {
227360
result.throws = [];
@@ -239,6 +372,13 @@ var flatteners = {
239372

240373
result.throws.push(throws);
241374
},
375+
/**
376+
* Parse tag
377+
* @private
378+
* @param {Object} result target comment
379+
* @param {Object} tag the tag
380+
* @returns {undefined} has side-effects
381+
*/
242382
'todo': function (result, tag) {
243383
if (!result.todos) {
244384
result.todos = [];
@@ -249,6 +389,13 @@ var flatteners = {
249389
'type': todo,
250390
'typedef': flattenKindShorthand,
251391
'var': synonym('member'),
392+
/**
393+
* Parse tag
394+
* @private
395+
* @param {Object} result target comment
396+
* @param {Object} tag the tag
397+
* @returns {undefined} has side-effects
398+
*/
252399
'variation': function (result, tag) {
253400
result.variation = tag.variation;
254401
},

0 commit comments

Comments
 (0)