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

Roberto Raggi's avatar
Roberto Raggi committed
252
    T_DOXY_LAST_TAG
253
};
254

255 256
CPPTOOLS_EXPORT int classifyDoxygenTag(const QChar *s, int n);
CPPTOOLS_EXPORT const char *doxygenTagSpell(int index);
257

Roberto Raggi's avatar
Roberto Raggi committed
258
} // namespace ::CppTools
259

260
#endif // CPPDOXYGEN_H