1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
|
"use strict";
Object.defineProperty(exports, "__esModule", {
value: true
});
exports.typeScriptTags = exports.jsdocTags = exports.closureTags = void 0;
const jsdocTagsUndocumented = {
// Undocumented but present; see
// https://github.com/jsdoc/jsdoc/issues/1283#issuecomment-516816802
// https://github.com/jsdoc/jsdoc/blob/master/packages/jsdoc/lib/jsdoc/tag/dictionary/definitions.js#L594
modifies: []
};
const jsdocTags = {
...jsdocTagsUndocumented,
abstract: ['virtual'],
access: [],
alias: [],
async: [],
augments: ['extends'],
author: [],
borrows: [],
callback: [],
class: ['constructor'],
classdesc: [],
constant: ['const'],
constructs: [],
copyright: [],
default: ['defaultvalue'],
deprecated: [],
description: ['desc'],
enum: [],
event: [],
example: [],
exports: [],
external: ['host'],
file: ['fileoverview', 'overview'],
fires: ['emits'],
function: ['func', 'method'],
generator: [],
global: [],
hideconstructor: [],
ignore: [],
implements: [],
inheritdoc: [],
// Allowing casing distinct from jsdoc `definitions.js` (required in Closure)
inheritDoc: [],
inner: [],
instance: [],
interface: [],
kind: [],
lends: [],
license: [],
listens: [],
member: ['var'],
memberof: [],
'memberof!': [],
mixes: [],
mixin: [],
module: [],
name: [],
namespace: [],
override: [],
package: [],
param: ['arg', 'argument'],
private: [],
property: ['prop'],
protected: [],
public: [],
readonly: [],
requires: [],
returns: ['return'],
see: [],
since: [],
static: [],
summary: [],
this: [],
throws: ['exception'],
todo: [],
tutorial: [],
type: [],
typedef: [],
variation: [],
version: [],
yields: ['yield']
};
exports.jsdocTags = jsdocTags;
const typeScriptTags = {
...jsdocTags,
// https://www.typescriptlang.org/tsconfig/#stripInternal
internal: [],
// `@template` is also in TypeScript per:
// https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html#supported-jsdoc
template: []
};
exports.typeScriptTags = typeScriptTags;
const undocumentedClosureTags = {
// These are in Closure source but not in jsdoc source nor in the Closure
// docs: https://github.com/google/closure-compiler/blob/master/src/com/google/javascript/jscomp/parsing/Annotation.java
closurePrimitive: [],
customElement: [],
expose: [],
hidden: [],
idGenerator: [],
meaning: [],
mixinClass: [],
mixinFunction: [],
ngInject: [],
owner: [],
typeSummary: [],
wizaction: []
};
const {
/* eslint-disable no-unused-vars */
inheritdoc,
internal,
// Will be inverted to prefer `return`
returns,
/* eslint-enable no-unused-vars */
...typeScriptTagsInClosure
} = typeScriptTags;
const closureTags = {
...typeScriptTagsInClosure,
...undocumentedClosureTags,
// From https://github.com/google/closure-compiler/wiki/Annotating-JavaScript-for-the-Closure-Compiler
// These are all recognized in https://github.com/jsdoc/jsdoc/blob/master/packages/jsdoc/lib/jsdoc/tag/dictionary/definitions.js
// except for the experimental `noinline` and the casing differences noted below
// Defined as a synonym of `const` in jsdoc `definitions.js`
define: [],
dict: [],
export: [],
externs: [],
final: [],
// With casing distinct from jsdoc `definitions.js`
implicitCast: [],
noalias: [],
nocollapse: [],
nocompile: [],
noinline: [],
nosideeffects: [],
polymer: [],
polymerBehavior: [],
preserve: [],
// Defined as a synonym of `interface` in jsdoc `definitions.js`
record: [],
return: ['returns'],
struct: [],
suppress: [],
unrestricted: []
};
exports.closureTags = closureTags;
//# sourceMappingURL=tagNames.js.map
|
