basis/xmode/modes/doxygen.xml

   1 <?xml version="1.0"?>
   2
   3 <!DOCTYPE MODE SYSTEM "xmode.dtd">
   4
   5 <MODE>
   6     <PROPS>
   7         <PROPERTY NAME="lineComment" VALUE="#" />
   8     </PROPS>
   9     <!-- just in case someone wonders just like me, what this set of rules is for,
  10          it's actually for doxygen configuration files, a sample of which can
  11          be found here http://www.stack.nl/~dimitri/doxygen/config.html#cfg_extract_static
  12       -->
  13     <RULES IGNORE_CASE="FALSE" HIGHLIGHT_DIGITS="TRUE">
  14         <!-- Comment -->
  15         <EOL_SPAN TYPE="COMMENT1">#</EOL_SPAN>
  16
  17         <MARK_PREVIOUS TYPE="KEYWORD1"
  18             AT_LINE_START="TRUE" MATCH_TYPE="OPERATOR">=</MARK_PREVIOUS>
  19         <MARK_PREVIOUS TYPE="KEYWORD1"
  20             AT_LINE_START="TRUE" MATCH_TYPE="OPERATOR">+=</MARK_PREVIOUS>
  21
  22         <!-- Literals -->
  23         <SPAN TYPE="LITERAL1" ESCAPE="\" NO_LINE_BREAK="TRUE">
  24             <BEGIN>"</BEGIN>
  25             <END>"</END>
  26         </SPAN>
  27         <SPAN TYPE="LITERAL1" ESCAPE="\" NO_LINE_BREAK="TRUE">
  28             <BEGIN>'</BEGIN>
  29             <END>'</END>
  30         </SPAN>
  31         <SPAN TYPE="LITERAL1" ESCAPE="\" NO_LINE_BREAK="TRUE">
  32             <BEGIN>`</BEGIN>
  33             <END>`</END>
  34         </SPAN>
  35         <KEYWORDS>
  36             <KEYWORD2>YES</KEYWORD2>
  37             <KEYWORD3>NO</KEYWORD3>
  38         </KEYWORDS>
  39     </RULES>
  40
  41     <!-- this rule set is used as a delegate in c and d modes -->
  42     <RULES SET="DOXYGEN" DEFAULT="COMMENT3" IGNORE_CASE="TRUE">
  43         <!-- so that *@param is highlighted -->
  44         <SEQ TYPE="COMMENT3">*</SEQ>
  45
  46         <!-- quoted strings -->
  47         <SPAN TYPE="LITERAL1" ESCAPE="\" NO_LINE_BREAK="TRUE">
  48             <BEGIN>"</BEGIN>
  49             <END>"</END>
  50         </SPAN>
  51
  52         <!-- HTML comments -->
  53         <SPAN TYPE="COMMENT1">
  54             <BEGIN>&lt;!--</BEGIN>
  55             <END>--&gt;</END>
  56         </SPAN>
  57
  58         <!-- Doxygen allows this -->
  59         <SEQ TYPE="COMMENT3">&lt;&lt;</SEQ>
  60         <SEQ TYPE="COMMENT3">&lt;=</SEQ>
  61         <SEQ TYPE="COMMENT3">&lt; </SEQ>
  62
  63         <!-- HTML tags -->
  64         <SPAN TYPE="MARKUP" DELEGATE="xml::TAGS"
  65             NO_LINE_BREAK="TRUE">
  66             <BEGIN>&lt;</BEGIN>
  67             <END>&gt;</END>
  68         </SPAN>
  69
  70         <KEYWORDS>
  71             <LABEL>\a</LABEL>
  72             <LABEL>\addindex</LABEL>
  73             <LABEL>\addtogroup</LABEL>
  74             <LABEL>\anchor</LABEL>
  75             <LABEL>\arg</LABEL>
  76             <LABEL>\attention</LABEL>
  77             <LABEL>\author</LABEL>
  78             <LABEL>\b</LABEL>
  79             <LABEL>\brief</LABEL>
  80             <LABEL>\bug</LABEL>
  81             <LABEL>\c</LABEL>
  82             <LABEL>\callgraph</LABEL>
  83             <LABEL>\callergraph</LABEL>
  84             <LABEL>\category</LABEL>
  85             <LABEL>\class</LABEL>
  86             <LABEL>\code</LABEL>
  87             <LABEL>\cond</LABEL>
  88             <LABEL>\copybrief</LABEL>
  89             <LABEL>\copydetails</LABEL>
  90             <LABEL>\copydoc</LABEL>
  91             <LABEL>\date</LABEL>
  92             <LABEL>\def</LABEL>
  93             <LABEL>\defgroup</LABEL>
  94             <LABEL>\deprecated</LABEL>
  95             <LABEL>\details</LABEL>
  96             <LABEL>\dir</LABEL>
  97             <LABEL>\dontinclude</LABEL>
  98             <LABEL>\dot</LABEL>
  99             <LABEL>\dotfile</LABEL>
 100             <LABEL>\e</LABEL>
 101             <LABEL>\else</LABEL>
 102             <LABEL>\elseif</LABEL>
 103             <LABEL>\em</LABEL>
 104             <LABEL>\endcode</LABEL>
 105             <LABEL>\endcond</LABEL>
 106             <LABEL>\enddot</LABEL>
 107             <LABEL>\endhtmlonly</LABEL>
 108             <LABEL>\endif</LABEL>
 109             <LABEL>\endlatexonly</LABEL>
 110             <LABEL>\endlink</LABEL>
 111             <LABEL>\endmanonly</LABEL>
 112             <LABEL>\endmsc</LABEL>
 113             <LABEL>\endverbatim</LABEL>
 114             <LABEL>\endxmlonly</LABEL>
 115             <LABEL>\enum</LABEL>
 116             <LABEL>\example</LABEL>
 117             <LABEL>\exception</LABEL>
 118             <LABEL>\extends</LABEL>
 119             <LABEL>\f$</LABEL>
 120             <LABEL>\f[</LABEL>
 121             <LABEL>\f]</LABEL>
 122             <LABEL>\f{</LABEL>
 123             <LABEL>\f}</LABEL>
 124             <LABEL>\file</LABEL>
 125             <LABEL>\fn</LABEL>
 126             <LABEL>\headerfile</LABEL>
 127             <LABEL>\hideinitializer</LABEL>
 128             <LABEL>\htmlinclude</LABEL>
 129             <LABEL>\htmlonly</LABEL>
 130             <LABEL>\if</LABEL>
 131             <LABEL>\ifnot</LABEL>
 132             <LABEL>\image</LABEL>
 133             <LABEL>\implements</LABEL>
 134             <LABEL>\include</LABEL>
 135             <LABEL>\includelineno</LABEL>
 136             <LABEL>\ingroup</LABEL>
 137             <LABEL>\internal</LABEL>
 138             <LABEL>\invariant</LABEL>
 139             <LABEL>\interface</LABEL>
 140             <LABEL>\latexonly</LABEL>
 141             <LABEL>\li</LABEL>
 142             <LABEL>\line</LABEL>
 143             <LABEL>\link</LABEL>
 144             <LABEL>\mainpage</LABEL>
 145             <LABEL>\manonly</LABEL>
 146             <LABEL>\memberof</LABEL>
 147             <LABEL>\msc</LABEL>
 148             <LABEL>\n</LABEL>
 149             <LABEL>\name</LABEL>
 150             <LABEL>\namespace</LABEL>
 151             <LABEL>\nosubgrouping</LABEL>
 152             <LABEL>\note</LABEL>
 153             <LABEL>\overload</LABEL>
 154             <LABEL>\p</LABEL>
 155             <LABEL>\package</LABEL>
 156             <LABEL>\page</LABEL>
 157             <LABEL>\par</LABEL>
 158             <LABEL>\paragraph</LABEL>
 159             <LABEL>\param</LABEL>
 160             <LABEL>\param[in]</LABEL>
 161             <LABEL>\param[out]</LABEL>
 162             <LABEL>\param[in,out]</LABEL>
 163             <LABEL>\post</LABEL>
 164             <LABEL>\pre</LABEL>
 165             <LABEL>\private</LABEL>
 166             <LABEL>\privatesection</LABEL>
 167             <LABEL>\property</LABEL>
 168             <LABEL>\protected</LABEL>
 169             <LABEL>\protectedsection</LABEL>
 170             <LABEL>\protocol</LABEL>
 171             <LABEL>\public</LABEL>
 172             <LABEL>\publicsection</LABEL>
 173             <LABEL>\ref</LABEL>
 174             <LABEL>\relates</LABEL>
 175             <LABEL>\relatesalso</LABEL>
 176             <LABEL>\remarks</LABEL>
 177             <LABEL>\return</LABEL>
 178             <LABEL>\retval</LABEL>
 179             <LABEL>\sa</LABEL>
 180             <LABEL>\section</LABEL>
 181             <LABEL>\see</LABEL>
 182             <LABEL>\showinitializer</LABEL>
 183             <LABEL>\since</LABEL>
 184             <LABEL>\skip</LABEL>
 185             <LABEL>\skipline</LABEL>
 186             <LABEL>\struct</LABEL>
 187             <LABEL>\subpage</LABEL>
 188             <LABEL>\subsection</LABEL>
 189             <LABEL>\subsubsection</LABEL>
 190             <LABEL>\test</LABEL>
 191             <LABEL>\throw</LABEL>
 192             <LABEL>\todo</LABEL>
 193             <LABEL>\tparam</LABEL>
 194             <LABEL>\typedef</LABEL>
 195             <LABEL>\union</LABEL>
 196             <LABEL>\until</LABEL>
 197             <LABEL>\var</LABEL>
 198             <LABEL>\verbatim</LABEL>
 199             <LABEL>\verbinclude</LABEL>
 200             <LABEL>\version</LABEL>
 201             <LABEL>\warning</LABEL>
 202             <LABEL>\weakgroup</LABEL>
 203             <LABEL>\xmlonly</LABEL>
 204             <LABEL>\xrefitem</LABEL>
 205             <LABEL>\$</LABEL>
 206             <LABEL>\@</LABEL>
 207             <LABEL>\\</LABEL>
 208             <LABEL>\&amp;</LABEL>
 209             <LABEL>\~</LABEL>
 210             <LABEL>\&lt;</LABEL>
 211             <LABEL>\&gt;</LABEL>
 212             <LABEL>\#</LABEL>
 213             <LABEL>\%</LABEL>
 214             <LABEL>\"</LABEL>
 215             <LABEL>@a</LABEL>
 216             <LABEL>@addindex</LABEL>
 217             <LABEL>@addtogroup</LABEL>
 218             <LABEL>@anchor</LABEL>
 219             <LABEL>@arg</LABEL>
 220             <LABEL>@attention</LABEL>
 221             <LABEL>@author</LABEL>
 222             <LABEL>@b</LABEL>
 223             <LABEL>@brief</LABEL>
 224             <LABEL>@bug</LABEL>
 225             <LABEL>@c</LABEL>
 226             <LABEL>@callgraph</LABEL>
 227             <LABEL>@callergraph</LABEL>
 228             <LABEL>@category</LABEL>
 229             <LABEL>@class</LABEL>
 230             <LABEL>@code</LABEL>
 231             <LABEL>@cond</LABEL>
 232             <LABEL>@copybrief</LABEL>
 233             <LABEL>@copydetails</LABEL>
 234             <LABEL>@copydoc</LABEL>
 235             <LABEL>@date</LABEL>
 236             <LABEL>@def</LABEL>
 237             <LABEL>@defgroup</LABEL>
 238             <LABEL>@deprecated</LABEL>
 239             <LABEL>@details</LABEL>
 240             <LABEL>@dir</LABEL>
 241             <LABEL>@dontinclude</LABEL>
 242             <LABEL>@dot</LABEL>
 243             <LABEL>@dotfile</LABEL>
 244             <LABEL>@e</LABEL>
 245             <LABEL>@else</LABEL>
 246             <LABEL>@elseif</LABEL>
 247             <LABEL>@em</LABEL>
 248             <LABEL>@endcode</LABEL>
 249             <LABEL>@endcond</LABEL>
 250             <LABEL>@enddot</LABEL>
 251             <LABEL>@endhtmlonly</LABEL>
 252             <LABEL>@endif</LABEL>
 253             <LABEL>@endlatexonly</LABEL>
 254             <LABEL>@endlink</LABEL>
 255             <LABEL>@endmanonly</LABEL>
 256             <LABEL>@endmsc</LABEL>
 257             <LABEL>@endverbatim</LABEL>
 258             <LABEL>@endxmlonly</LABEL>
 259             <LABEL>@enum</LABEL>
 260             <LABEL>@example</LABEL>
 261             <LABEL>@exception</LABEL>
 262             <LABEL>@extends</LABEL>
 263             <LABEL>@f$</LABEL>
 264             <LABEL>@f[</LABEL>
 265             <LABEL>@f]</LABEL>
 266             <LABEL>@f{</LABEL>
 267             <LABEL>@f}</LABEL>
 268             <LABEL>@file</LABEL>
 269             <LABEL>@fn</LABEL>
 270             <LABEL>@headerfile</LABEL>
 271             <LABEL>@hideinitializer</LABEL>
 272             <LABEL>@htmlinclude</LABEL>
 273             <LABEL>@htmlonly</LABEL>
 274             <LABEL>@if</LABEL>
 275             <LABEL>@ifnot</LABEL>
 276             <LABEL>@image</LABEL>
 277             <LABEL>@implements</LABEL>
 278             <LABEL>@include</LABEL>
 279             <LABEL>@includelineno</LABEL>
 280             <LABEL>@ingroup</LABEL>
 281             <LABEL>@internal</LABEL>
 282             <LABEL>@invariant</LABEL>
 283             <LABEL>@interface</LABEL>
 284             <LABEL>@latexonly</LABEL>
 285             <LABEL>@li</LABEL>
 286             <LABEL>@line</LABEL>
 287             <LABEL>@link</LABEL>
 288             <LABEL>@mainpage</LABEL>
 289             <LABEL>@manonly</LABEL>
 290             <LABEL>@memberof</LABEL>
 291             <LABEL>@msc</LABEL>
 292             <LABEL>@n</LABEL>
 293             <LABEL>@name</LABEL>
 294             <LABEL>@namespace</LABEL>
 295             <LABEL>@nosubgrouping</LABEL>
 296             <LABEL>@note</LABEL>
 297             <LABEL>@overload</LABEL>
 298             <LABEL>@p</LABEL>
 299             <LABEL>@package</LABEL>
 300             <LABEL>@page</LABEL>
 301             <LABEL>@par</LABEL>
 302             <LABEL>@paragraph</LABEL>
 303             <LABEL>@param</LABEL>
 304             <LABEL>@param[in]</LABEL>
 305             <LABEL>@param[out]</LABEL>
 306             <LABEL>@param[in,out]</LABEL>
 307             <LABEL>@post</LABEL>
 308             <LABEL>@pre</LABEL>
 309             <LABEL>@private</LABEL>
 310             <LABEL>@privatesection</LABEL>
 311             <LABEL>@property</LABEL>
 312             <LABEL>@protected</LABEL>
 313             <LABEL>@protectedsection</LABEL>
 314             <LABEL>@protocol</LABEL>
 315             <LABEL>@public</LABEL>
 316             <LABEL>@publicsection</LABEL>
 317             <LABEL>@ref</LABEL>
 318             <LABEL>@relates</LABEL>
 319             <LABEL>@relatesalso</LABEL>
 320             <LABEL>@remarks</LABEL>
 321             <LABEL>@return</LABEL>
 322             <LABEL>@retval</LABEL>
 323             <LABEL>@sa</LABEL>
 324             <LABEL>@section</LABEL>
 325             <LABEL>@see</LABEL>
 326             <LABEL>@showinitializer</LABEL>
 327             <LABEL>@since</LABEL>
 328             <LABEL>@skip</LABEL>
 329             <LABEL>@skipline</LABEL>
 330             <LABEL>@struct</LABEL>
 331             <LABEL>@subpage</LABEL>
 332             <LABEL>@subsection</LABEL>
 333             <LABEL>@subsubsection</LABEL>
 334             <LABEL>@test</LABEL>
 335             <LABEL>@throw</LABEL>
 336             <LABEL>@todo</LABEL>
 337             <LABEL>@tparam</LABEL>
 338             <LABEL>@typedef</LABEL>
 339             <LABEL>@union</LABEL>
 340             <LABEL>@until</LABEL>
 341             <LABEL>@var</LABEL>
 342             <LABEL>@verbatim</LABEL>
 343             <LABEL>@verbinclude</LABEL>
 344             <LABEL>@version</LABEL>
 345             <LABEL>@warning</LABEL>
 346             <LABEL>@weakgroup</LABEL>
 347             <LABEL>@xmlonly</LABEL>
 348             <LABEL>@xrefitem</LABEL>
 349             <LABEL>@$</LABEL>
 350             <LABEL>@@</LABEL>
 351             <LABEL>@\</LABEL>
 352             <LABEL>@&amp;</LABEL>
 353             <LABEL>@~</LABEL>
 354             <LABEL>@&lt;</LABEL>
 355             <LABEL>@&gt;</LABEL>
 356             <LABEL>@#</LABEL>
 357             <LABEL>@%</LABEL>
 358         </KEYWORDS>
 359     </RULES>
 360
 361 </MODE>