1 /****************************************************************************
2 **
3 ** Copyright (C) 2016 The Qt Company Ltd.
4 ** Contact: https://www.qt.io/licensing/
5 **
6 ** This file is part of Qt Creator.
7 **
8 ** Commercial License Usage
9 ** Licensees holding valid commercial Qt licenses may use this file in
10 ** accordance with the commercial license agreement provided with the
11 ** Software or, alternatively, in accordance with the terms contained in
12 ** a written agreement between you and The Qt Company. For licensing terms
13 ** and conditions see https://www.qt.io/terms-conditions. For further
14 ** information use the contact form at https://www.qt.io/contact-us.
15 **
16 ** GNU General Public License Usage
17 ** Alternatively, this file may be used under the terms of the GNU
18 ** General Public License version 3 as published by the Free Software
19 ** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
20 ** included in the packaging of this file. Please review the following
21 ** information to ensure the GNU General Public License requirements will
22 ** be met: https://www.gnu.org/licenses/gpl-3.0.html.
23 **
24 ****************************************************************************/
25 
26 #pragma once
27 
28 #include "cpptools_global.h"
29 
QT_FORWARD_DECLARE_CLASS(QChar)30 QT_FORWARD_DECLARE_CLASS(QChar)
31 
32 namespace CppTools {
33 
34 enum DoxygenReservedWord {
35     T_DOXY_IDENTIFIER,
36 
37     T_DOXY_A,
38     T_DOXY_ABSTRACT,
39     T_DOXY_ADDINDEX,
40     T_DOXY_ADDTOGROUP,
41     T_DOXY_ANCHOR,
42     T_DOXY_ANNOTATEDLIST,
43     T_DOXY_ARG,
44     T_DOXY_ATTENTION,
45     T_DOXY_AUTHOR,
46     T_DOXY_AUTHORS,
47     T_DOXY_B,
48     T_DOXY_BADCODE,
49     T_DOXY_BASENAME,
50     T_DOXY_BOLD,
51     T_DOXY_BRIEF,
52     T_DOXY_BUG,
53     T_DOXY_C,
54     T_DOXY_CALLERGRAPH,
55     T_DOXY_CALLGRAPH,
56     T_DOXY_CAPTION,
57     T_DOXY_CATEGORY,
58     T_DOXY_CHAPTER,
59     T_DOXY_CITE,
60     T_DOXY_CLASS,
61     T_DOXY_CODE,
62     T_DOXY_CODELINE,
63     T_DOXY_COMPAT,
64     T_DOXY_COND,
65     T_DOXY_CONTENTSPAGE,
66     T_DOXY_COPYBRIEF,
67     T_DOXY_COPYDETAILS,
68     T_DOXY_COPYDOC,
69     T_DOXY_COPYRIGHT,
70     T_DOXY_CORELIB,
71     T_DOXY_DATE,
72     T_DOXY_DEF,
73     T_DOXY_DEFAULT,
74     T_DOXY_DEFGROUP,
75     T_DOXY_DEPRECATED,
76     T_DOXY_DETAILS,
77     T_DOXY_DIAFILE,
78     T_DOXY_DIR,
79     T_DOXY_DIV,
80     T_DOXY_DOCBOOKONLY,
81     T_DOXY_DONTINCLUDE,
82     T_DOXY_DOT,
83     T_DOXY_DOTFILE,
84     T_DOXY_DOTS,
85     T_DOXY_E,
86     T_DOXY_ELSE,
87     T_DOXY_ELSEIF,
88     T_DOXY_EM,
89     T_DOXY_ENDABSTRACT,
90     T_DOXY_ENDCHAPTER,
91     T_DOXY_ENDCODE,
92     T_DOXY_ENDCOND,
93     T_DOXY_ENDDOCBOOKONLY,
94     T_DOXY_ENDDOT,
95     T_DOXY_ENDFOOTNOTE,
96     T_DOXY_ENDHTMLONLY,
97     T_DOXY_ENDIF,
98     T_DOXY_ENDINTERNAL,
99     T_DOXY_ENDLATEXONLY,
100     T_DOXY_ENDLEGALESE,
101     T_DOXY_ENDLINK,
102     T_DOXY_ENDLIST,
103     T_DOXY_ENDMANONLY,
104     T_DOXY_ENDMSC,
105     T_DOXY_ENDOMIT,
106     T_DOXY_ENDPARBLOCK,
107     T_DOXY_ENDPART,
108     T_DOXY_ENDQUOTATION,
109     T_DOXY_ENDRAW,
110     T_DOXY_ENDRTFONLY,
111     T_DOXY_ENDSECREFLIST,
112     T_DOXY_ENDSECTION1,
113     T_DOXY_ENDSECTION2,
114     T_DOXY_ENDSECTION3,
115     T_DOXY_ENDSECTION4,
116     T_DOXY_ENDSIDEBAR,
117     T_DOXY_ENDTABLE,
118     T_DOXY_ENDUML,
119     T_DOXY_ENDVERBATIM,
120     T_DOXY_ENDXMLONLY,
121     T_DOXY_ENUM,
122     T_DOXY_EXAMPLE,
123     T_DOXY_EXCEPTION,
124     T_DOXY_EXCEPTIONS,
125     T_DOXY_EXPIRE,
126     T_DOXY_EXTENDS,
127     T_DOXY_EXTERNALPAGE,
128     T_DOXY_FILE,
129     T_DOXY_FN,
130     T_DOXY_FOOTNOTE,
131     T_DOXY_GENERATELIST,
132     T_DOXY_GRANULARITY,
133     T_DOXY_GROUP,
134     T_DOXY_GUI,
135     T_DOXY_HEADER,
136     T_DOXY_HEADERFILE,
137     T_DOXY_HIDECALLERGRAPH,
138     T_DOXY_HIDECALLGRAPH,
139     T_DOXY_HIDEINITIALIZER,
140     T_DOXY_HTMLINCLUDE,
141     T_DOXY_HTMLONLY,
142     T_DOXY_I,
143     T_DOXY_IDLEXCEPT,
144     T_DOXY_IF,
145     T_DOXY_IFNOT,
146     T_DOXY_IMAGE,
147     T_DOXY_IMPLEMENTS,
148     T_DOXY_INCLUDE,
149     T_DOXY_INCLUDELINENO,
150     T_DOXY_INDEX,
151     T_DOXY_INDEXPAGE,
152     T_DOXY_INGROUP,
153     T_DOXY_INHEADERFILE,
154     T_DOXY_INHERITS,
155     T_DOXY_INLINEIMAGE,
156     T_DOXY_INMODULE,
157     T_DOXY_INPUBLICGROUP,
158     T_DOXY_INQMLMODULE,
159     T_DOXY_INSTANTIATES,
160     T_DOXY_INTERFACE,
161     T_DOXY_INTERNAL,
162     T_DOXY_INVARIANT,
163     T_DOXY_KEYWORD,
164     T_DOXY_L,
165     T_DOXY_LATEXINCLUDE,
166     T_DOXY_LATEXONLY,
167     T_DOXY_LEGALESE,
168     T_DOXY_LI,
169     T_DOXY_LINE,
170     T_DOXY_LINK,
171     T_DOXY_LIST,
172     T_DOXY_MACRO,
173     T_DOXY_MAINCLASS,
174     T_DOXY_MAINPAGE,
175     T_DOXY_MANONLY,
176     T_DOXY_MEMBEROF,
177     T_DOXY_META,
178     T_DOXY_MODULE,
179     T_DOXY_MSC,
180     T_DOXY_MSCFILE,
181     T_DOXY_N,
182     T_DOXY_NAME,
183     T_DOXY_NAMESPACE,
184     T_DOXY_NETWORK,
185     T_DOXY_NEWCODE,
186     T_DOXY_NEXTPAGE,
187     T_DOXY_NOAUTOLIST,
188     T_DOXY_NONREENTRANT,
189     T_DOXY_NOSUBGROUPING,
190     T_DOXY_NOTE,
191     T_DOXY_O,
192     T_DOXY_OBSOLETE,
193     T_DOXY_OLDCODE,
194     T_DOXY_OMIT,
195     T_DOXY_OMITVALUE,
196     T_DOXY_ONLY,
197     T_DOXY_OPENGL,
198     T_DOXY_OVERLOAD,
199     T_DOXY_P,
200     T_DOXY_PACKAGE,
201     T_DOXY_PAGE,
202     T_DOXY_PAR,
203     T_DOXY_PARAGRAPH,
204     T_DOXY_PARAM,
205     T_DOXY_PARBLOCK,
206     T_DOXY_PART,
207     T_DOXY_POST,
208     T_DOXY_PRE,
209     T_DOXY_PRELIMINARY,
210     T_DOXY_PREVIOUSPAGE,
211     T_DOXY_PRINTLINE,
212     T_DOXY_PRINTTO,
213     T_DOXY_PRINTUNTIL,
214     T_DOXY_PRIVATE,
215     T_DOXY_PRIVATESECTION,
216     T_DOXY_PROPERTY,
217     T_DOXY_PROTECTED,
218     T_DOXY_PROTECTEDSECTION,
219     T_DOXY_PROTOCOL,
220     T_DOXY_PUBLIC,
221     T_DOXY_PUBLICSECTION,
222     T_DOXY_PURE,
223     T_DOXY_QMLABSTRACT,
224     T_DOXY_QMLATTACHEDPROPERTY,
225     T_DOXY_QMLATTACHEDSIGNAL,
226     T_DOXY_QMLBASICTYPE,
227     T_DOXY_QMLCLASS,
228     T_DOXY_QMLMETHOD,
229     T_DOXY_QMLMODULE,
230     T_DOXY_QMLPROPERTY,
231     T_DOXY_QMLSIGNAL,
232     T_DOXY_QMLTYPE,
233     T_DOXY_QT3SUPPORT,
234     T_DOXY_QTESTLIB,
235     T_DOXY_QUOTATION,
236     T_DOXY_QUOTEFILE,
237     T_DOXY_QUOTEFROMFILE,
238     T_DOXY_QUOTEFUNCTION,
239     T_DOXY_RAW,
240     T_DOXY_REENTRANT,
241     T_DOXY_REF,
242     T_DOXY_REFITEM,
243     T_DOXY_REIMP,
244     T_DOXY_RELATED,
245     T_DOXY_RELATEDALSO,
246     T_DOXY_RELATES,
247     T_DOXY_RELATESALSO,
248     T_DOXY_REMARK,
249     T_DOXY_REMARKS,
250     T_DOXY_RESULT,
251     T_DOXY_RETURN,
252     T_DOXY_RETURNS,
253     T_DOXY_RETVAL,
254     T_DOXY_ROW,
255     T_DOXY_RTFONLY,
256     T_DOXY_SA,
257     T_DOXY_SECREFLIST,
258     T_DOXY_SECTION,
259     T_DOXY_SECTION1,
260     T_DOXY_SECTION2,
261     T_DOXY_SECTION3,
262     T_DOXY_SECTION4,
263     T_DOXY_SEE,
264     T_DOXY_SERVICE,
265     T_DOXY_SHORT,
266     T_DOXY_SHOWINITIALIZER,
267     T_DOXY_SIDEBAR,
268     T_DOXY_SINCE,
269     T_DOXY_SKIP,
270     T_DOXY_SKIPLINE,
271     T_DOXY_SKIPTO,
272     T_DOXY_SKIPUNTIL,
273     T_DOXY_SNIPPET,
274     T_DOXY_SPAN,
275     T_DOXY_SQL,
276     T_DOXY_STARTPAGE,
277     T_DOXY_STARTUML,
278     T_DOXY_STRUCT,
279     T_DOXY_SUB,
280     T_DOXY_SUBPAGE,
281     T_DOXY_SUBSECTION,
282     T_DOXY_SUBSUBSECTION,
283     T_DOXY_SUBTITLE,
284     T_DOXY_SUP,
285     T_DOXY_SVG,
286     T_DOXY_TABLE,
287     T_DOXY_TABLEOFCONTENTS,
288     T_DOXY_TARGET,
289     T_DOXY_TEST,
290     T_DOXY_THREADSAFE,
291     T_DOXY_THROW,
292     T_DOXY_THROWS,
293     T_DOXY_TITLE,
294     T_DOXY_TODO,
295     T_DOXY_TPARAM,
296     T_DOXY_TT,
297     T_DOXY_TYPEDEF,
298     T_DOXY_UICONTROL,
299     T_DOXY_UITOOLS,
300     T_DOXY_UNDERLINE,
301     T_DOXY_UNICODE,
302     T_DOXY_UNION,
303     T_DOXY_UNTIL,
304     T_DOXY_VALUE,
305     T_DOXY_VAR,
306     T_DOXY_VARIABLE,
307     T_DOXY_VERBATIM,
308     T_DOXY_VERBINCLUDE,
309     T_DOXY_VERSION,
310     T_DOXY_VHDLFLOW,
311     T_DOXY_WARNING,
312     T_DOXY_WEAKGROUP,
313     T_DOXY_WEBKIT,
314     T_DOXY_XML,
315     T_DOXY_XMLONLY,
316     T_DOXY_XREFITEM,
317 
318     T_DOXY_LAST_TAG
319 };
320 
321 CPPTOOLS_EXPORT int classifyDoxygenTag(const QChar *s, int n);
322 CPPTOOLS_EXPORT const char *doxygenTagSpell(int index);
323 
324 } // namespace ::CppTools
325