cppdoxygen.h 7.08 KB
Newer Older
hjk's avatar
hjk committed
1
/****************************************************************************
2
**
3 4
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
5
**
hjk's avatar
hjk committed
6
** This file is part of Qt Creator.
7
**
hjk's avatar
hjk committed
8 9 10 11
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
12 13 14
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
15
**
16 17 18 19 20 21 22
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 as published by the Free Software
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
con's avatar
con committed
23
**
hjk's avatar
hjk committed
24
****************************************************************************/
25

hjk's avatar
hjk committed
26
#pragma once
27

28 29
#include "cpptools_global.h"

30 31
QT_FORWARD_DECLARE_CLASS(QChar)

32
namespace CppTools {
33 34

enum DoxygenReservedWord {
Roberto Raggi's avatar
Roberto Raggi committed
35
    T_DOXY_IDENTIFIER,
36

Roberto Raggi's avatar
Roberto Raggi committed
37
    T_DOXY_A,
38 39
    T_DOXY_ABSTRACT,
    T_DOXY_ADDINDEX,
Roberto Raggi's avatar
Roberto Raggi committed
40 41
    T_DOXY_ADDTOGROUP,
    T_DOXY_ANCHOR,
42
    T_DOXY_ANNOTATEDLIST,
43 44 45
    T_DOXY_ARG,
    T_DOXY_ATTENTION,
    T_DOXY_AUTHOR,
46
    T_DOXY_AUTHORS,
Roberto Raggi's avatar
Roberto Raggi committed
47
    T_DOXY_B,
48 49 50 51 52
    T_DOXY_BADCODE,
    T_DOXY_BASENAME,
    T_DOXY_BOLD,
    T_DOXY_BRIEF,
    T_DOXY_BUG,
Roberto Raggi's avatar
Roberto Raggi committed
53
    T_DOXY_C,
54
    T_DOXY_CALLERGRAPH,
55 56
    T_DOXY_CALLGRAPH,
    T_DOXY_CAPTION,
57
    T_DOXY_CATEGORY,
58
    T_DOXY_CHAPTER,
59
    T_DOXY_CITE,
Roberto Raggi's avatar
Roberto Raggi committed
60
    T_DOXY_CLASS,
61 62 63
    T_DOXY_CODE,
    T_DOXY_CODELINE,
    T_DOXY_COMPAT,
Roberto Raggi's avatar
Roberto Raggi committed
64
    T_DOXY_COND,
65
    T_DOXY_CONTENTSPAGE,
66 67
    T_DOXY_COPYBRIEF,
    T_DOXY_COPYDETAILS,
Roberto Raggi's avatar
Roberto Raggi committed
68
    T_DOXY_COPYDOC,
69
    T_DOXY_COPYRIGHT,
70 71
    T_DOXY_CORELIB,
    T_DOXY_DATE,
Roberto Raggi's avatar
Roberto Raggi committed
72
    T_DOXY_DEF,
73
    T_DOXY_DEFAULT,
74 75
    T_DOXY_DEFGROUP,
    T_DOXY_DEPRECATED,
76 77 78
    T_DOXY_DETAILS,
    T_DOXY_DIAFILE,
    T_DOXY_DIR,
79
    T_DOXY_DIV,
80
    T_DOXY_DOCBOOKONLY,
Roberto Raggi's avatar
Roberto Raggi committed
81
    T_DOXY_DONTINCLUDE,
82
    T_DOXY_DOT,
Roberto Raggi's avatar
Roberto Raggi committed
83
    T_DOXY_DOTFILE,
84
    T_DOXY_DOTS,
Roberto Raggi's avatar
Roberto Raggi committed
85
    T_DOXY_E,
86
    T_DOXY_ELSE,
Roberto Raggi's avatar
Roberto Raggi committed
87 88 89 90
    T_DOXY_ELSEIF,
    T_DOXY_EM,
    T_DOXY_ENDABSTRACT,
    T_DOXY_ENDCHAPTER,
91 92
    T_DOXY_ENDCODE,
    T_DOXY_ENDCOND,
93
    T_DOXY_ENDDOCBOOKONLY,
94
    T_DOXY_ENDDOT,
Roberto Raggi's avatar
Roberto Raggi committed
95
    T_DOXY_ENDFOOTNOTE,
96 97
    T_DOXY_ENDHTMLONLY,
    T_DOXY_ENDIF,
98
    T_DOXY_ENDINTERNAL,
99
    T_DOXY_ENDLATEXONLY,
Roberto Raggi's avatar
Roberto Raggi committed
100
    T_DOXY_ENDLEGALESE,
101
    T_DOXY_ENDLINK,
Roberto Raggi's avatar
Roberto Raggi committed
102
    T_DOXY_ENDLIST,
103
    T_DOXY_ENDMANONLY,
104
    T_DOXY_ENDMSC,
Roberto Raggi's avatar
Roberto Raggi committed
105
    T_DOXY_ENDOMIT,
106
    T_DOXY_ENDPARBLOCK,
Roberto Raggi's avatar
Roberto Raggi committed
107 108 109
    T_DOXY_ENDPART,
    T_DOXY_ENDQUOTATION,
    T_DOXY_ENDRAW,
110 111
    T_DOXY_ENDRTFONLY,
    T_DOXY_ENDSECREFLIST,
Roberto Raggi's avatar
Roberto Raggi committed
112 113 114 115 116 117
    T_DOXY_ENDSECTION1,
    T_DOXY_ENDSECTION2,
    T_DOXY_ENDSECTION3,
    T_DOXY_ENDSECTION4,
    T_DOXY_ENDSIDEBAR,
    T_DOXY_ENDTABLE,
118
    T_DOXY_ENDUML,
119 120 121 122 123 124
    T_DOXY_ENDVERBATIM,
    T_DOXY_ENDXMLONLY,
    T_DOXY_ENUM,
    T_DOXY_EXAMPLE,
    T_DOXY_EXCEPTION,
    T_DOXY_EXCEPTIONS,
Roberto Raggi's avatar
Roberto Raggi committed
125
    T_DOXY_EXPIRE,
126
    T_DOXY_EXTENDS,
127 128 129
    T_DOXY_EXTERNALPAGE,
    T_DOXY_FILE,
    T_DOXY_FN,
Roberto Raggi's avatar
Roberto Raggi committed
130 131 132
    T_DOXY_FOOTNOTE,
    T_DOXY_GENERATELIST,
    T_DOXY_GRANULARITY,
133 134
    T_DOXY_GROUP,
    T_DOXY_GUI,
Roberto Raggi's avatar
Roberto Raggi committed
135
    T_DOXY_HEADER,
136
    T_DOXY_HEADERFILE,
137 138
    T_DOXY_HIDECALLERGRAPH,
    T_DOXY_HIDECALLGRAPH,
139 140 141
    T_DOXY_HIDEINITIALIZER,
    T_DOXY_HTMLINCLUDE,
    T_DOXY_HTMLONLY,
Roberto Raggi's avatar
Roberto Raggi committed
142
    T_DOXY_I,
143
    T_DOXY_IDLEXCEPT,
144 145 146
    T_DOXY_IF,
    T_DOXY_IFNOT,
    T_DOXY_IMAGE,
147
    T_DOXY_IMPLEMENTS,
148
    T_DOXY_INCLUDE,
149
    T_DOXY_INCLUDELINENO,
Roberto Raggi's avatar
Roberto Raggi committed
150
    T_DOXY_INDEX,
151 152 153
    T_DOXY_INDEXPAGE,
    T_DOXY_INGROUP,
    T_DOXY_INHEADERFILE,
154
    T_DOXY_INHERITS,
Roberto Raggi's avatar
Roberto Raggi committed
155
    T_DOXY_INLINEIMAGE,
156 157
    T_DOXY_INMODULE,
    T_DOXY_INPUBLICGROUP,
158 159
    T_DOXY_INQMLMODULE,
    T_DOXY_INSTANTIATES,
160 161 162
    T_DOXY_INTERFACE,
    T_DOXY_INTERNAL,
    T_DOXY_INVARIANT,
Roberto Raggi's avatar
Roberto Raggi committed
163 164
    T_DOXY_KEYWORD,
    T_DOXY_L,
165
    T_DOXY_LATEXINCLUDE,
166
    T_DOXY_LATEXONLY,
Roberto Raggi's avatar
Roberto Raggi committed
167
    T_DOXY_LEGALESE,
168 169 170
    T_DOXY_LI,
    T_DOXY_LINE,
    T_DOXY_LINK,
Roberto Raggi's avatar
Roberto Raggi committed
171
    T_DOXY_LIST,
172 173 174 175
    T_DOXY_MACRO,
    T_DOXY_MAINCLASS,
    T_DOXY_MAINPAGE,
    T_DOXY_MANONLY,
176
    T_DOXY_MEMBEROF,
Roberto Raggi's avatar
Roberto Raggi committed
177
    T_DOXY_META,
178
    T_DOXY_MODULE,
179 180
    T_DOXY_MSC,
    T_DOXY_MSCFILE,
181 182 183 184
    T_DOXY_N,
    T_DOXY_NAME,
    T_DOXY_NAMESPACE,
    T_DOXY_NETWORK,
Roberto Raggi's avatar
Roberto Raggi committed
185
    T_DOXY_NEWCODE,
186
    T_DOXY_NEXTPAGE,
187
    T_DOXY_NOAUTOLIST,
188 189 190
    T_DOXY_NONREENTRANT,
    T_DOXY_NOSUBGROUPING,
    T_DOXY_NOTE,
Roberto Raggi's avatar
Roberto Raggi committed
191
    T_DOXY_O,
192
    T_DOXY_OBSOLETE,
Roberto Raggi's avatar
Roberto Raggi committed
193 194 195
    T_DOXY_OLDCODE,
    T_DOXY_OMIT,
    T_DOXY_OMITVALUE,
196 197 198 199 200 201 202 203 204
    T_DOXY_ONLY,
    T_DOXY_OPENGL,
    T_DOXY_OVERLOAD,
    T_DOXY_P,
    T_DOXY_PACKAGE,
    T_DOXY_PAGE,
    T_DOXY_PAR,
    T_DOXY_PARAGRAPH,
    T_DOXY_PARAM,
205
    T_DOXY_PARBLOCK,
Roberto Raggi's avatar
Roberto Raggi committed
206
    T_DOXY_PART,
207 208 209 210
    T_DOXY_POST,
    T_DOXY_PRE,
    T_DOXY_PRELIMINARY,
    T_DOXY_PREVIOUSPAGE,
Roberto Raggi's avatar
Roberto Raggi committed
211 212 213
    T_DOXY_PRINTLINE,
    T_DOXY_PRINTTO,
    T_DOXY_PRINTUNTIL,
214 215
    T_DOXY_PRIVATE,
    T_DOXY_PRIVATESECTION,
216
    T_DOXY_PROPERTY,
217 218 219 220 221 222
    T_DOXY_PROTECTED,
    T_DOXY_PROTECTEDSECTION,
    T_DOXY_PROTOCOL,
    T_DOXY_PUBLIC,
    T_DOXY_PUBLICSECTION,
    T_DOXY_PURE,
223 224 225 226 227 228 229 230 231 232
    T_DOXY_QMLABSTRACT,
    T_DOXY_QMLATTACHEDPROPERTY,
    T_DOXY_QMLATTACHEDSIGNAL,
    T_DOXY_QMLBASICTYPE,
    T_DOXY_QMLCLASS,
    T_DOXY_QMLMETHOD,
    T_DOXY_QMLMODULE,
    T_DOXY_QMLPROPERTY,
    T_DOXY_QMLSIGNAL,
    T_DOXY_QMLTYPE,
233 234
    T_DOXY_QT3SUPPORT,
    T_DOXY_QTESTLIB,
Roberto Raggi's avatar
Roberto Raggi committed
235 236 237 238 239
    T_DOXY_QUOTATION,
    T_DOXY_QUOTEFILE,
    T_DOXY_QUOTEFROMFILE,
    T_DOXY_QUOTEFUNCTION,
    T_DOXY_RAW,
240 241
    T_DOXY_REENTRANT,
    T_DOXY_REF,
242
    T_DOXY_REFITEM,
243
    T_DOXY_REIMP,
244 245
    T_DOXY_RELATED,
    T_DOXY_RELATEDALSO,
246 247
    T_DOXY_RELATES,
    T_DOXY_RELATESALSO,
248
    T_DOXY_REMARK,
249
    T_DOXY_REMARKS,
250
    T_DOXY_RESULT,
251 252 253
    T_DOXY_RETURN,
    T_DOXY_RETURNS,
    T_DOXY_RETVAL,
Roberto Raggi's avatar
Roberto Raggi committed
254
    T_DOXY_ROW,
255
    T_DOXY_RTFONLY,
256
    T_DOXY_SA,
257
    T_DOXY_SECREFLIST,
258
    T_DOXY_SECTION,
Roberto Raggi's avatar
Roberto Raggi committed
259 260 261 262
    T_DOXY_SECTION1,
    T_DOXY_SECTION2,
    T_DOXY_SECTION3,
    T_DOXY_SECTION4,
263 264 265 266
    T_DOXY_SEE,
    T_DOXY_SERVICE,
    T_DOXY_SHORT,
    T_DOXY_SHOWINITIALIZER,
Roberto Raggi's avatar
Roberto Raggi committed
267
    T_DOXY_SIDEBAR,
268 269 270
    T_DOXY_SINCE,
    T_DOXY_SKIP,
    T_DOXY_SKIPLINE,
Roberto Raggi's avatar
Roberto Raggi committed
271 272 273
    T_DOXY_SKIPTO,
    T_DOXY_SKIPUNTIL,
    T_DOXY_SNIPPET,
274
    T_DOXY_SPAN,
275 276
    T_DOXY_SQL,
    T_DOXY_STARTPAGE,
277
    T_DOXY_STARTUML,
278
    T_DOXY_STRUCT,
Roberto Raggi's avatar
Roberto Raggi committed
279
    T_DOXY_SUB,
280
    T_DOXY_SUBPAGE,
281 282 283
    T_DOXY_SUBSECTION,
    T_DOXY_SUBSUBSECTION,
    T_DOXY_SUBTITLE,
Roberto Raggi's avatar
Roberto Raggi committed
284
    T_DOXY_SUP,
285
    T_DOXY_SVG,
Roberto Raggi's avatar
Roberto Raggi committed
286 287 288
    T_DOXY_TABLE,
    T_DOXY_TABLEOFCONTENTS,
    T_DOXY_TARGET,
289 290 291 292 293 294
    T_DOXY_TEST,
    T_DOXY_THREADSAFE,
    T_DOXY_THROW,
    T_DOXY_THROWS,
    T_DOXY_TITLE,
    T_DOXY_TODO,
295
    T_DOXY_TPARAM,
Roberto Raggi's avatar
Roberto Raggi committed
296
    T_DOXY_TT,
297
    T_DOXY_TYPEDEF,
298
    T_DOXY_UICONTROL,
299
    T_DOXY_UITOOLS,
Roberto Raggi's avatar
Roberto Raggi committed
300 301
    T_DOXY_UNDERLINE,
    T_DOXY_UNICODE,
302 303
    T_DOXY_UNION,
    T_DOXY_UNTIL,
Roberto Raggi's avatar
Roberto Raggi committed
304
    T_DOXY_VALUE,
305
    T_DOXY_VAR,
Roberto Raggi's avatar
Roberto Raggi committed
306
    T_DOXY_VARIABLE,
307 308 309
    T_DOXY_VERBATIM,
    T_DOXY_VERBINCLUDE,
    T_DOXY_VERSION,
310
    T_DOXY_VHDLFLOW,
311 312
    T_DOXY_WARNING,
    T_DOXY_WEAKGROUP,
Roberto Raggi's avatar
Roberto Raggi committed
313 314
    T_DOXY_WEBKIT,
    T_DOXY_XML,
315 316
    T_DOXY_XMLONLY,
    T_DOXY_XREFITEM,
317

Roberto Raggi's avatar
Roberto Raggi committed
318
    T_DOXY_LAST_TAG
319
};
320

321 322
CPPTOOLS_EXPORT int classifyDoxygenTag(const QChar *s, int n);
CPPTOOLS_EXPORT const char *doxygenTagSpell(int index);
323

Roberto Raggi's avatar
Roberto Raggi committed
324
} // namespace ::CppTools