cppdoxygen.h 3.65 KB
Newer Older
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
/***************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2008-2009 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact:  Qt Software Information (qt-info@nokia.com)
**
**
** Non-Open Source Usage
**
** Licensees may use this file in accordance with the Qt Beta Version
** License Agreement, Agreement version 2.2 provided with the Software or,
** alternatively, in accordance with the terms contained in a written
** agreement between you and Nokia.
**
** GNU General Public License Usage
**
** Alternatively, this file may be used under the terms of the GNU General
** Public License versions 2.0 or 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the packaging
** of this file.  Please review the following information to ensure GNU
** General Public Licensing requirements will be met:
**
** http://www.fsf.org/licensing/licenses/info/GPLv2.html and
** http://www.gnu.org/copyleft/gpl.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights. These rights are described in the Nokia Qt GPL Exception
** version 1.3, included in the file GPL_EXCEPTION.txt in this package.
**
***************************************************************************/
33 34 35 36

#include "cpptools_global.h"

namespace CppTools {
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

enum DoxygenReservedWord {
  T_DOXY_IDENTIFIER = 0,

  T_DOXY_ARG,
  T_DOXY_ATTENTION,
  T_DOXY_AUTHOR,
  T_DOXY_CALLGRAPH,
  T_DOXY_CODE,
  T_DOXY_DOT,
  T_DOXY_ELSE,
  T_DOXY_ENDCODE,
  T_DOXY_ENDCOND,
  T_DOXY_ENDDOT,
  T_DOXY_ENDHTMLONLY,
  T_DOXY_ENDIF,
  T_DOXY_ENDLATEXONLY,
  T_DOXY_ENDLINK,
  T_DOXY_ENDMANONLY,
  T_DOXY_ENDVERBATIM,
  T_DOXY_ENDXMLONLY,
  T_DOXY_HIDEINITIALIZER,
  T_DOXY_HTMLONLY,
  T_DOXY_INTERFACE,
  T_DOXY_INTERNAL,
  T_DOXY_INVARIANT,
  T_DOXY_LATEXONLY,
  T_DOXY_LI,
  T_DOXY_MANONLY,
  T_DOXY_N,
  T_DOXY_NOSUBGROUPING,
  T_DOXY_NOTE,
  T_DOXY_ONLY,
  T_DOXY_POST,
  T_DOXY_PRE,
  T_DOXY_REMARKS,
  T_DOXY_RETURN,
  T_DOXY_RETURNS,
  T_DOXY_SA,
  T_DOXY_SEE,
  T_DOXY_SHOWINITIALIZER,
  T_DOXY_SINCE,
  T_DOXY_TEST,
  T_DOXY_TODO,
  T_DOXY_VERBATIM,
  T_DOXY_WARNING,
  T_DOXY_XMLONLY,

  T_DOXY_A,
  T_DOXY_ADDTOGROUP,
  T_DOXY_ANCHOR,
  T_DOXY_B,
  T_DOXY_C,
  T_DOXY_CLASS,
  T_DOXY_COND,
  T_DOXY_COPYDOC,
  T_DOXY_DEF,
  T_DOXY_DONTINCLUDE,
  T_DOXY_DOTFILE,
  T_DOXY_E,
  T_DOXY_ELSEIF,
  T_DOXY_EM,
  T_DOXY_ENUM,
  T_DOXY_EXAMPLE,
  T_DOXY_EXCEPTION,
  T_DOXY_EXCEPTIONS,
  T_DOXY_FILE,
  T_DOXY_HTMLINCLUDE,
  T_DOXY_IF,
  T_DOXY_IFNOT,
  T_DOXY_INCLUDE,
  T_DOXY_LINK,
  T_DOXY_NAMESPACE,
  T_DOXY_P,
  T_DOXY_PACKAGE,
  T_DOXY_REF,
  T_DOXY_RELATES,
  T_DOXY_RELATESALSO,
  T_DOXY_RETVAL,
  T_DOXY_THROW,
  T_DOXY_THROWS,
  T_DOXY_VERBINCLUDE,
  T_DOXY_VERSION,
  T_DOXY_XREFITEM,

  T_DOXY_PARAM,

  T_DOXY_IMAGE,

  T_DOXY_DEFGROUP,
  T_DOXY_PAGE,
  T_DOXY_PARAGRAPH,
  T_DOXY_SECTION,
  T_DOXY_STRUCT,
  T_DOXY_SUBSECTION,
  T_DOXY_SUBSUBSECTION,
  T_DOXY_UNION,
  T_DOXY_WEAKGROUP,

  T_DOXY_ADDINDEX,
  T_DOXY_BRIEF,
  T_DOXY_BUG,
  T_DOXY_DATE,
  T_DOXY_DEPRECATED,
  T_DOXY_FN,
  T_DOXY_INGROUP,
  T_DOXY_LINE,
  T_DOXY_MAINPAGE,
  T_DOXY_NAME,
  T_DOXY_OVERLOAD,
  T_DOXY_PAR,
  T_DOXY_SHORT,
  T_DOXY_SKIP,
  T_DOXY_SKIPLINE,
  T_DOXY_TYPEDEF,
  T_DOXY_UNTIL,
  T_DOXY_VAR,

155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170
  // qdoc
  T_DOXY_ENDLIST,
  T_DOXY_ENDTABLE,
  T_DOXY_HEADER,
  T_DOXY_I,
  T_DOXY_L,
  T_DOXY_LIST,
  T_DOXY_MAINCLASS,
  T_DOXY_NEWCODE,
  T_DOXY_O,
  T_DOXY_OLDCODE,
  T_DOXY_PROPERTY,
  T_DOXY_ROW,
  T_DOXY_SECTION1,
  T_DOXY_TABLE,

171
  T_DOXY_LAST_TAG
172

173
};
174

175 176
CPPTOOLS_EXPORT int classifyDoxygenTag(const QChar *s, int n);
CPPTOOLS_EXPORT const char *doxygenTagSpell(int index);
177 178 179

} // namespace CppEditor::Internal