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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
|
/*******************************************************************************
* Copyright (c) 2000, 2019 IBM Corporation and others.
*
* This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.jdt.internal.compiler.parser;
import org.eclipse.jdt.core.compiler.CharOperation;
/**
* Javadoc tag constants.
*
* @since 3.2
*/
public interface JavadocTagConstants {
// recognized tags
public static final char[] TAG_DEPRECATED = "deprecated".toCharArray(); //$NON-NLS-1$
public static final char[] TAG_PARAM = "param".toCharArray(); //$NON-NLS-1$
public static final char[] TAG_RETURN = "return".toCharArray(); //$NON-NLS-1$
public static final char[] TAG_THROWS = "throws".toCharArray(); //$NON-NLS-1$
public static final char[] TAG_EXCEPTION = "exception".toCharArray(); //$NON-NLS-1$
public static final char[] TAG_SEE = "see".toCharArray(); //$NON-NLS-1$
public static final char[] TAG_LINK = "link".toCharArray(); //$NON-NLS-1$
public static final char[] TAG_LINKPLAIN = "linkplain".toCharArray(); //$NON-NLS-1$
public static final char[] TAG_INHERITDOC = "inheritDoc".toCharArray(); //$NON-NLS-1$
public static final char[] TAG_VALUE = "value".toCharArray(); //$NON-NLS-1$
public static final char[] TAG_AUTHOR = "author".toCharArray(); //$NON-NLS-1$
public static final char[] TAG_CODE = "code".toCharArray(); //$NON-NLS-1$
public static final char[] TAG_DOC_ROOT = "docRoot".toCharArray(); //$NON-NLS-1$
public static final char[] TAG_LITERAL = "literal".toCharArray(); //$NON-NLS-1$
public static final char[] TAG_SERIAL = "serial".toCharArray(); //$NON-NLS-1$
public static final char[] TAG_SERIAL_DATA = "serialData".toCharArray(); //$NON-NLS-1$
public static final char[] TAG_SERIAL_FIELD = "serialField".toCharArray(); //$NON-NLS-1$
public static final char[] TAG_SINCE = "since".toCharArray(); //$NON-NLS-1$
public static final char[] TAG_VERSION = "version".toCharArray(); //$NON-NLS-1$
public static final char[] TAG_CATEGORY = "category".toCharArray(); //$NON-NLS-1$
public static final char[] TAG_SYSTEM_PROPERTY = "systemProperty".toCharArray(); //$NON-NLS-1$
public static final char[] TAG_USES = "uses".toCharArray(); //$NON-NLS-1$
public static final char[] TAG_PROVIDES = "provides".toCharArray(); //$NON-NLS-1$
public static final char[] TAG_HIDDEN = "hidden".toCharArray(); //$NON-NLS-1$
public static final char[] TAG_INDEX = "index".toCharArray(); //$NON-NLS-1$
public static final char[] TAG_SUMMARY = "summary".toCharArray(); //$NON-NLS-1$
// tags lengthes
public static final int TAG_DEPRECATED_LENGTH = TAG_DEPRECATED.length;
public static final int TAG_PARAM_LENGTH = TAG_PARAM.length;
public static final int TAG_RETURN_LENGTH = TAG_RETURN.length;
public static final int TAG_THROWS_LENGTH = TAG_THROWS.length;
public static final int TAG_EXCEPTION_LENGTH = TAG_EXCEPTION.length;
public static final int TAG_SEE_LENGTH = TAG_SEE.length;
public static final int TAG_LINK_LENGTH = TAG_LINK.length;
public static final int TAG_LINKPLAIN_LENGTH = TAG_LINKPLAIN.length;
public static final int TAG_INHERITDOC_LENGTH = TAG_INHERITDOC.length;
public static final int TAG_VALUE_LENGTH = TAG_VALUE.length;
public static final int TAG_CATEGORY_LENGTH = TAG_CATEGORY.length;
public static final int TAG_AUTHOR_LENGTH = TAG_AUTHOR.length;
public static final int TAG_SERIAL_LENGTH = TAG_SERIAL.length;
public static final int TAG_SERIAL_DATA_LENGTH = TAG_SERIAL_DATA.length;
public static final int TAG_SERIAL_FIELD_LENGTH = TAG_SERIAL_FIELD.length;
public static final int TAG_SINCE_LENGTH = TAG_SINCE.length;
public static final int TAG_VERSION_LENGTH = TAG_VERSION.length;
public static final int TAG_CODE_LENGTH = TAG_CODE.length;
public static final int TAG_LITERAL_LENGTH = TAG_LITERAL.length;
public static final int TAG_DOC_ROOT_LENGTH = TAG_DOC_ROOT.length;
public static final int TAG_SYSTEM_PROPERTY_LENGTH = TAG_SYSTEM_PROPERTY.length;
public static final int TAG_USES_LENGTH = TAG_USES.length;
public static final int TAG_PROVIDES_LENGTH = TAG_PROVIDES.length;
public static final int TAG_HIDDEN_LENGTH = TAG_HIDDEN.length;
public static final int TAG_INDEX_LENGTH = TAG_INDEX.length;
public static final int TAG_SUMMARY_LENGTH = TAG_SUMMARY.length;
// tags value
public static final int NO_TAG_VALUE = 0;
public static final int TAG_DEPRECATED_VALUE = 1;
public static final int TAG_PARAM_VALUE = 2;
public static final int TAG_RETURN_VALUE = 3;
public static final int TAG_THROWS_VALUE = 4;
public static final int TAG_EXCEPTION_VALUE = 5;
public static final int TAG_SEE_VALUE = 6;
public static final int TAG_LINK_VALUE = 7;
public static final int TAG_LINKPLAIN_VALUE = 8;
public static final int TAG_INHERITDOC_VALUE = 9;
public static final int TAG_VALUE_VALUE = 10;
public static final int TAG_CATEGORY_VALUE = 11;
public static final int TAG_AUTHOR_VALUE = 12;
public static final int TAG_SERIAL_VALUE = 13;
public static final int TAG_SERIAL_DATA_VALUE = 14;
public static final int TAG_SERIAL_FIELD_VALUE = 15;
public static final int TAG_SINCE_VALUE = 16;
public static final int TAG_VERSION_VALUE = 17;
public static final int TAG_CODE_VALUE = 18;
public static final int TAG_LITERAL_VALUE = 19;
public static final int TAG_DOC_ROOT_VALUE = 20;
public static final int TAG_SYSTEM_PROPERTY_VALUE=21;
public static final int TAG_USES_VALUE=21;
public static final int TAG_PROVIDES_VALUE=22;
public static final int TAG_HIDDEN_VALUE = 23;
public static final int TAG_INDEX_VALUE = 24;
public static final int TAG_SUMMARY_VALUE = 25;
public static final int TAG_OTHERS_VALUE = 100;
// Tag names array
public static final char[][] TAG_NAMES = {
CharOperation.NO_CHAR,
TAG_DEPRECATED, /* 1 */
TAG_PARAM, /* 2 */
TAG_RETURN, /* 3 */
TAG_THROWS, /* 4 */
TAG_EXCEPTION, /* 5 */
TAG_SEE, /* 6 */
TAG_LINK, /* 7 */
TAG_LINKPLAIN, /* 8 */
TAG_INHERITDOC, /* 9 */
TAG_VALUE, /* 10 */
TAG_CATEGORY, /* 11 */
TAG_AUTHOR, /* 12 */
TAG_SERIAL, /* 13 */
TAG_SERIAL_DATA, /* 14 */
TAG_SERIAL_FIELD, /* 15 */
TAG_SINCE, /* 16 */
TAG_VERSION, /* 17 */
TAG_CODE, /* 18 */
TAG_LITERAL, /* 19 */
TAG_DOC_ROOT, /* 20 */
TAG_SYSTEM_PROPERTY, /* 21 */
TAG_USES, /* 22 */
TAG_PROVIDES, /* 23 */
TAG_HIDDEN, /* 24 */
TAG_INDEX, /* 25 */
TAG_SUMMARY, /* 26 */
};
// tags expected positions
public final static int ORDERED_TAGS_NUMBER = 3;
public final static int PARAM_TAG_EXPECTED_ORDER = 0;
public final static int THROWS_TAG_EXPECTED_ORDER = 1;
public final static int SEE_TAG_EXPECTED_ORDER = 2;
/*
* Tag kinds indexes
*/
public final static int BLOCK_IDX = 0;
public final static int INLINE_IDX = 1;
// href tag
public final static char[] HREF_TAG = {'h', 'r', 'e', 'f'};
/*
* Tags versions
*/
public static final char[][][] BLOCK_TAGS = {
// since 1.0
{ TAG_AUTHOR, TAG_DEPRECATED, TAG_EXCEPTION, TAG_PARAM, TAG_RETURN, TAG_SEE, TAG_VERSION, TAG_CATEGORY /* 1.6 tag but put here as we support it for all compliances */ },
// since 1.1
{ TAG_SINCE },
// since 1.2
{ TAG_SERIAL, TAG_SERIAL_DATA, TAG_SERIAL_FIELD , TAG_THROWS },
// since 1.3
{},
// since 1.4
{},
// since 1.5
{},
// since 1.6
{},
// since 1.7
{},
// since 1.8
{},
// since 9
{ TAG_HIDDEN, TAG_USES, TAG_PROVIDES },
// since 10
{},
// since 11
{},
//since 12
{}
};
public static final char[][][] INLINE_TAGS = {
// since 1.0
{},
// since 1.1
{},
// since 1.2
{ TAG_LINK },
// since 1.3
{ TAG_DOC_ROOT },
// since 1.4
{ TAG_INHERITDOC, TAG_LINKPLAIN, TAG_VALUE },
// since 1.5
{ TAG_CODE, TAG_LITERAL },
// since 1.6
{},
// since 1.7
{},
// since 1.8
{},
// since 9
{ TAG_INDEX },
// since 10
{ TAG_SUMMARY },
// since 11
{},
//since 12
{TAG_SYSTEM_PROPERTY}
};
public final static int INLINE_TAGS_LENGTH = INLINE_TAGS.length;
public final static int BLOCK_TAGS_LENGTH = BLOCK_TAGS.length;
public final static int ALL_TAGS_LENGTH = BLOCK_TAGS_LENGTH+INLINE_TAGS_LENGTH;
public final static short TAG_TYPE_NONE = 0;
public final static short TAG_TYPE_INLINE = 1;
public final static short TAG_TYPE_BLOCK = 2;
public static final short[] JAVADOC_TAG_TYPE = {
TAG_TYPE_NONE, // NO_TAG_VALUE = 0;
TAG_TYPE_BLOCK, // TAG_DEPRECATED_VALUE = 1;
TAG_TYPE_BLOCK, // TAG_PARAM_VALUE = 2;
TAG_TYPE_BLOCK, // TAG_RETURN_VALUE = 3;
TAG_TYPE_BLOCK, // TAG_THROWS_VALUE = 4;
TAG_TYPE_BLOCK, // TAG_EXCEPTION_VALUE = 5;
TAG_TYPE_BLOCK, // TAG_SEE_VALUE = 6;
TAG_TYPE_INLINE, // TAG_LINK_VALUE = 7;
TAG_TYPE_INLINE, // TAG_LINKPLAIN_VALUE = 8;
TAG_TYPE_INLINE, // TAG_INHERITDOC_VALUE = 9;
TAG_TYPE_INLINE, // TAG_VALUE_VALUE = 10;
TAG_TYPE_BLOCK, // TAG_CATEGORY_VALUE = 11;
TAG_TYPE_BLOCK, // TAG_AUTHOR_VALUE = 12;
TAG_TYPE_BLOCK, // TAG_SERIAL_VALUE = 13;
TAG_TYPE_BLOCK, // TAG_SERIAL_DATA_VALUE = 14;
TAG_TYPE_BLOCK, // TAG_SERIAL_FIELD_VALUE = 15;
TAG_TYPE_BLOCK, // TAG_SINCE_VALUE = 16;
TAG_TYPE_BLOCK, // TAG_VERSION_VALUE = 17;
TAG_TYPE_INLINE, // TAG_CODE_VALUE = 18;
TAG_TYPE_INLINE, // TAG_LITERAL_VALUE = 19;
TAG_TYPE_INLINE, // TAG_DOC_ROOT_VALUE = 20;
TAG_TYPE_INLINE, // TAG_DOC_ROOT_VALUE = 21
TAG_TYPE_BLOCK, // TAG_HIDDEN_VALUE = 22;
TAG_TYPE_BLOCK, // TAG_PROVIDES_VALUE = 23;
TAG_TYPE_BLOCK, // TAG_USES_VALUE = 24;
TAG_TYPE_INLINE, // TAG_INDEX_VALUE = 25;
TAG_TYPE_INLINE, // TAG_SUMMARY_VALUE = 26;
};
/*
* Tags usage
*/
public static final char[][] PACKAGE_TAGS = {
TAG_SEE,
TAG_SINCE,
TAG_SERIAL,
TAG_AUTHOR,
TAG_VERSION,
TAG_CATEGORY,
TAG_LINK,
TAG_LINKPLAIN,
TAG_DOC_ROOT,
TAG_VALUE,
TAG_SYSTEM_PROPERTY,
TAG_HIDDEN,
TAG_INDEX,
TAG_SUMMARY,
};
public static final char[][] COMPILATION_UNIT_TAGS = {};
public static final char[][] CLASS_TAGS = {
TAG_SEE,
TAG_SINCE,
TAG_DEPRECATED,
TAG_SERIAL,
TAG_AUTHOR,
TAG_VERSION,
TAG_PARAM,
TAG_CATEGORY,
TAG_LINK,
TAG_LINKPLAIN,
TAG_DOC_ROOT,
TAG_VALUE,
TAG_CODE,
TAG_LITERAL,
TAG_SYSTEM_PROPERTY,
TAG_HIDDEN,
TAG_INDEX,
TAG_SUMMARY,
};
public static final char[][] FIELD_TAGS = {
TAG_SEE,
TAG_SINCE,
TAG_DEPRECATED,
TAG_SERIAL,
TAG_SERIAL_FIELD,
TAG_CATEGORY,
TAG_LINK,
TAG_LINKPLAIN,
TAG_DOC_ROOT,
TAG_VALUE,
TAG_CODE,
TAG_LITERAL,
TAG_SYSTEM_PROPERTY,
TAG_INDEX,
TAG_HIDDEN,
TAG_SUMMARY,
};
public static final char[][] METHOD_TAGS = {
TAG_SEE,
TAG_SINCE,
TAG_DEPRECATED,
TAG_PARAM,
TAG_RETURN,
TAG_THROWS,
TAG_EXCEPTION,
TAG_SERIAL_DATA,
TAG_CATEGORY,
TAG_LINK,
TAG_LINKPLAIN,
TAG_INHERITDOC,
TAG_DOC_ROOT,
TAG_VALUE,
TAG_CODE,
TAG_LITERAL,
TAG_SYSTEM_PROPERTY,
TAG_HIDDEN,
TAG_INDEX,
TAG_SUMMARY,
};
public static final char[][] MODULE_TAGS = {
TAG_SEE,
TAG_SINCE,
TAG_DEPRECATED,
TAG_SERIAL,
TAG_AUTHOR,
TAG_VERSION,
TAG_CATEGORY,
TAG_LINK,
TAG_LINKPLAIN,
TAG_DOC_ROOT,
TAG_VALUE,
TAG_CODE,
TAG_LITERAL,
TAG_USES,
TAG_PROVIDES,
TAG_HIDDEN,
TAG_INDEX,
TAG_SUMMARY
};
}
|
