Skip to content

Commit d2637ad

Browse files
committed
Add placeholder comments for remaining tags
1 parent 0011523 commit d2637ad

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

lib/parse.js

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,18 +19,22 @@ var flatteners = {
1919
result.augments.push(tag);
2020
},
2121
'author': flattenDescription,
22+
// 'borrows'
2223
'callback': flattenDescription,
2324
'class': flattenTypedName,
2425
'classdesc': flattenDescription,
2526
'const': synonym('constant'),
2627
'constant': flattenTypedName,
2728
'constructor': synonym('class'),
29+
// 'constructs'
2830
'copyright': flattenDescription,
31+
// 'default'
2932
'defaultvalue': synonym('default'),
3033
'deprecated': flattenDescription,
3134
'desc': synonym('description'),
3235
'description': flattenDescription,
3336
'emits': synonym('fires'),
37+
// 'enum'
3438
'event': flattenDescription,
3539
'example': function (result, tag) {
3640
if (!tag.description) {
@@ -56,36 +60,45 @@ var flatteners = {
5660
result.examples.push(example);
5761
},
5862
'exception': synonym('throws'),
63+
// 'exports'
5964
'extends': synonym('augments'),
6065
'external': flattenDescription,
6166
'file': flattenDescription,
6267
'fileoverview': synonym('file'),
68+
// 'fires'
6369
'func': synonym('function'),
6470
'function': flattenName,
6571
'global': function (result) {
6672
result.scope = 'global';
6773
},
6874
'host': synonym('external'),
75+
// 'ignore'
76+
// 'implements'
77+
// 'inheritdoc'
6978
'inner': function (result) {
7079
result.scope = 'inner';
7180
},
7281
'instance': function (result) {
7382
result.scope = 'instance';
7483
},
84+
// 'interface'
7585
'kind': function (result, tag) {
7686
result.kind = tag.kind;
7787
},
7888
'lends': flattenDescription,
7989
'license': flattenDescription,
8090
'linkcode': synonym('link'),
8191
'linkplain': synonym('link'),
92+
// 'listens'
8293
'member': flattenTypedName,
8394
'memberof': flattenDescription,
8495
'method': synonym('function'),
96+
// 'mixes'
8597
'mixin': flattenName,
8698
'module': flattenTypedName,
8799
'name': flattenName,
88100
'namespace': flattenTypedName,
101+
// 'override'
89102
'overview': synonym('file'),
90103
'param': function (result, tag) {
91104
if (!result.params) {
@@ -109,6 +122,8 @@ var flatteners = {
109122
'public': function (result) {
110123
result.access = 'public';
111124
},
125+
// 'readonly'
126+
// 'requires'
112127
'return': synonym('returns'),
113128
'returns': function (result, tag) {
114129
if (!result.returns) {
@@ -127,6 +142,7 @@ var flatteners = {
127142
result.scope = 'static';
128143
},
129144
'summary': flattenDescription,
145+
// 'this'
130146
'throws': function (result, tag) {
131147
if (!result.throws) {
132148
result.throws = [];
@@ -139,8 +155,11 @@ var flatteners = {
139155
}
140156
result.todos.push(tag.description);
141157
},
158+
// 'tutorial'
159+
// 'type'
142160
'typedef': flattenTypedName,
143161
'var': synonym('member'),
162+
// 'variation'
144163
'version': flattenDescription,
145164
'virtual': synonym('abstract')
146165
};

0 commit comments

Comments
 (0)