cppdoxygen.h 6.1 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

26 27 28
#ifndef CPPDOXYGEN_H
#define CPPDOXYGEN_H

29 30
#include "cpptools_global.h"

31 32
QT_FORWARD_DECLARE_CLASS(QChar)

33
namespace CppTools {
34 35

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

Roberto Raggi's avatar
Roberto Raggi committed
38
    T_DOXY_A,
39 40
    T_DOXY_ABSTRACT,
    T_DOXY_ADDINDEX,
Roberto Raggi's avatar
Roberto Raggi committed
41 42
    T_DOXY_ADDTOGROUP,
    T_DOXY_ANCHOR,
43
    T_DOXY_ANNOTATEDLIST,
44 45 46
    T_DOXY_ARG,
    T_DOXY_ATTENTION,
    T_DOXY_AUTHOR,
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 55 56
    T_DOXY_CALLGRAPH,
    T_DOXY_CAPTION,
    T_DOXY_CHAPTER,
Roberto Raggi's avatar
Roberto Raggi committed
57
    T_DOXY_CLASS,
58 59 60
    T_DOXY_CODE,
    T_DOXY_CODELINE,
    T_DOXY_COMPAT,
Roberto Raggi's avatar
Roberto Raggi committed
61
    T_DOXY_COND,
62
    T_DOXY_CONTENTSPAGE,
Roberto Raggi's avatar
Roberto Raggi committed
63
    T_DOXY_COPYDOC,
64 65
    T_DOXY_CORELIB,
    T_DOXY_DATE,
Roberto Raggi's avatar
Roberto Raggi committed
66
    T_DOXY_DEF,
67
    T_DOXY_DEFAULT,
68 69
    T_DOXY_DEFGROUP,
    T_DOXY_DEPRECATED,
70
    T_DOXY_DIV,
Roberto Raggi's avatar
Roberto Raggi committed
71
    T_DOXY_DONTINCLUDE,
72
    T_DOXY_DOT,
Roberto Raggi's avatar
Roberto Raggi committed
73
    T_DOXY_DOTFILE,
74
    T_DOXY_DOTS,
Roberto Raggi's avatar
Roberto Raggi committed
75
    T_DOXY_E,
76
    T_DOXY_ELSE,
Roberto Raggi's avatar
Roberto Raggi committed
77 78 79 80
    T_DOXY_ELSEIF,
    T_DOXY_EM,
    T_DOXY_ENDABSTRACT,
    T_DOXY_ENDCHAPTER,
81 82 83
    T_DOXY_ENDCODE,
    T_DOXY_ENDCOND,
    T_DOXY_ENDDOT,
Roberto Raggi's avatar
Roberto Raggi committed
84
    T_DOXY_ENDFOOTNOTE,
85 86 87
    T_DOXY_ENDHTMLONLY,
    T_DOXY_ENDIF,
    T_DOXY_ENDLATEXONLY,
Roberto Raggi's avatar
Roberto Raggi committed
88
    T_DOXY_ENDLEGALESE,
89
    T_DOXY_ENDLINK,
Roberto Raggi's avatar
Roberto Raggi committed
90
    T_DOXY_ENDLIST,
91
    T_DOXY_ENDMANONLY,
Roberto Raggi's avatar
Roberto Raggi committed
92 93 94 95 96 97 98 99 100 101
    T_DOXY_ENDOMIT,
    T_DOXY_ENDPART,
    T_DOXY_ENDQUOTATION,
    T_DOXY_ENDRAW,
    T_DOXY_ENDSECTION1,
    T_DOXY_ENDSECTION2,
    T_DOXY_ENDSECTION3,
    T_DOXY_ENDSECTION4,
    T_DOXY_ENDSIDEBAR,
    T_DOXY_ENDTABLE,
102 103 104 105 106 107
    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
108
    T_DOXY_EXPIRE,
109 110 111
    T_DOXY_EXTERNALPAGE,
    T_DOXY_FILE,
    T_DOXY_FN,
Roberto Raggi's avatar
Roberto Raggi committed
112 113 114
    T_DOXY_FOOTNOTE,
    T_DOXY_GENERATELIST,
    T_DOXY_GRANULARITY,
115 116
    T_DOXY_GROUP,
    T_DOXY_GUI,
Roberto Raggi's avatar
Roberto Raggi committed
117
    T_DOXY_HEADER,
118 119 120 121
    T_DOXY_HEADERFILE,
    T_DOXY_HIDEINITIALIZER,
    T_DOXY_HTMLINCLUDE,
    T_DOXY_HTMLONLY,
Roberto Raggi's avatar
Roberto Raggi committed
122
    T_DOXY_I,
123 124 125 126
    T_DOXY_IF,
    T_DOXY_IFNOT,
    T_DOXY_IMAGE,
    T_DOXY_INCLUDE,
Roberto Raggi's avatar
Roberto Raggi committed
127
    T_DOXY_INDEX,
128 129 130
    T_DOXY_INDEXPAGE,
    T_DOXY_INGROUP,
    T_DOXY_INHEADERFILE,
131
    T_DOXY_INHERITS,
Roberto Raggi's avatar
Roberto Raggi committed
132
    T_DOXY_INLINEIMAGE,
133 134
    T_DOXY_INMODULE,
    T_DOXY_INPUBLICGROUP,
135 136
    T_DOXY_INQMLMODULE,
    T_DOXY_INSTANTIATES,
137 138 139
    T_DOXY_INTERFACE,
    T_DOXY_INTERNAL,
    T_DOXY_INVARIANT,
Roberto Raggi's avatar
Roberto Raggi committed
140 141
    T_DOXY_KEYWORD,
    T_DOXY_L,
142
    T_DOXY_LATEXONLY,
Roberto Raggi's avatar
Roberto Raggi committed
143
    T_DOXY_LEGALESE,
144 145 146
    T_DOXY_LI,
    T_DOXY_LINE,
    T_DOXY_LINK,
Roberto Raggi's avatar
Roberto Raggi committed
147
    T_DOXY_LIST,
148 149 150 151
    T_DOXY_MACRO,
    T_DOXY_MAINCLASS,
    T_DOXY_MAINPAGE,
    T_DOXY_MANONLY,
Roberto Raggi's avatar
Roberto Raggi committed
152
    T_DOXY_META,
153 154 155 156 157
    T_DOXY_MODULE,
    T_DOXY_N,
    T_DOXY_NAME,
    T_DOXY_NAMESPACE,
    T_DOXY_NETWORK,
Roberto Raggi's avatar
Roberto Raggi committed
158
    T_DOXY_NEWCODE,
159
    T_DOXY_NEXTPAGE,
160
    T_DOXY_NOAUTOLIST,
161 162 163
    T_DOXY_NONREENTRANT,
    T_DOXY_NOSUBGROUPING,
    T_DOXY_NOTE,
Roberto Raggi's avatar
Roberto Raggi committed
164
    T_DOXY_O,
165
    T_DOXY_OBSOLETE,
Roberto Raggi's avatar
Roberto Raggi committed
166 167 168
    T_DOXY_OLDCODE,
    T_DOXY_OMIT,
    T_DOXY_OMITVALUE,
169 170 171 172 173 174 175 176 177
    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,
Roberto Raggi's avatar
Roberto Raggi committed
178
    T_DOXY_PART,
179 180 181 182
    T_DOXY_POST,
    T_DOXY_PRE,
    T_DOXY_PRELIMINARY,
    T_DOXY_PREVIOUSPAGE,
Roberto Raggi's avatar
Roberto Raggi committed
183 184 185
    T_DOXY_PRINTLINE,
    T_DOXY_PRINTTO,
    T_DOXY_PRINTUNTIL,
186
    T_DOXY_PROPERTY,
187 188 189 190 191 192 193 194 195 196
    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,
197 198
    T_DOXY_QT3SUPPORT,
    T_DOXY_QTESTLIB,
Roberto Raggi's avatar
Roberto Raggi committed
199 200 201 202 203
    T_DOXY_QUOTATION,
    T_DOXY_QUOTEFILE,
    T_DOXY_QUOTEFROMFILE,
    T_DOXY_QUOTEFUNCTION,
    T_DOXY_RAW,
204 205 206 207 208 209 210 211 212
    T_DOXY_REENTRANT,
    T_DOXY_REF,
    T_DOXY_REIMP,
    T_DOXY_RELATES,
    T_DOXY_RELATESALSO,
    T_DOXY_REMARKS,
    T_DOXY_RETURN,
    T_DOXY_RETURNS,
    T_DOXY_RETVAL,
Roberto Raggi's avatar
Roberto Raggi committed
213
    T_DOXY_ROW,
214 215
    T_DOXY_SA,
    T_DOXY_SECTION,
Roberto Raggi's avatar
Roberto Raggi committed
216 217 218 219
    T_DOXY_SECTION1,
    T_DOXY_SECTION2,
    T_DOXY_SECTION3,
    T_DOXY_SECTION4,
220 221 222 223
    T_DOXY_SEE,
    T_DOXY_SERVICE,
    T_DOXY_SHORT,
    T_DOXY_SHOWINITIALIZER,
Roberto Raggi's avatar
Roberto Raggi committed
224
    T_DOXY_SIDEBAR,
225 226 227
    T_DOXY_SINCE,
    T_DOXY_SKIP,
    T_DOXY_SKIPLINE,
Roberto Raggi's avatar
Roberto Raggi committed
228 229 230
    T_DOXY_SKIPTO,
    T_DOXY_SKIPUNTIL,
    T_DOXY_SNIPPET,
231
    T_DOXY_SPAN,
232 233 234
    T_DOXY_SQL,
    T_DOXY_STARTPAGE,
    T_DOXY_STRUCT,
Roberto Raggi's avatar
Roberto Raggi committed
235
    T_DOXY_SUB,
236 237 238
    T_DOXY_SUBSECTION,
    T_DOXY_SUBSUBSECTION,
    T_DOXY_SUBTITLE,
Roberto Raggi's avatar
Roberto Raggi committed
239
    T_DOXY_SUP,
240
    T_DOXY_SVG,
Roberto Raggi's avatar
Roberto Raggi committed
241 242 243
    T_DOXY_TABLE,
    T_DOXY_TABLEOFCONTENTS,
    T_DOXY_TARGET,
244 245 246 247 248 249
    T_DOXY_TEST,
    T_DOXY_THREADSAFE,
    T_DOXY_THROW,
    T_DOXY_THROWS,
    T_DOXY_TITLE,
    T_DOXY_TODO,
Roberto Raggi's avatar
Roberto Raggi committed
250
    T_DOXY_TT,
251
    T_DOXY_TYPEDEF,
252
    T_DOXY_UICONTROL,
253
    T_DOXY_UITOOLS,
Roberto Raggi's avatar
Roberto Raggi committed
254 255
    T_DOXY_UNDERLINE,
    T_DOXY_UNICODE,
256 257
    T_DOXY_UNION,
    T_DOXY_UNTIL,
Roberto Raggi's avatar
Roberto Raggi committed
258
    T_DOXY_VALUE,
259
    T_DOXY_VAR,
Roberto Raggi's avatar
Roberto Raggi committed
260
    T_DOXY_VARIABLE,
261 262 263 264 265
    T_DOXY_VERBATIM,
    T_DOXY_VERBINCLUDE,
    T_DOXY_VERSION,
    T_DOXY_WARNING,
    T_DOXY_WEAKGROUP,
Roberto Raggi's avatar
Roberto Raggi committed
266 267
    T_DOXY_WEBKIT,
    T_DOXY_XML,
268 269
    T_DOXY_XMLONLY,
    T_DOXY_XREFITEM,
270

Roberto Raggi's avatar
Roberto Raggi committed
271
    T_DOXY_LAST_TAG
272
};
273

274 275
CPPTOOLS_EXPORT int classifyDoxygenTag(const QChar *s, int n);
CPPTOOLS_EXPORT const char *doxygenTagSpell(int index);
276

Roberto Raggi's avatar
Roberto Raggi committed
277
} // namespace ::CppTools
278

279
#endif // CPPDOXYGEN_H