3 # This file describes the settings to be used by the documentation system 
    4 # doxygen (www.doxygen.org) for a project. 
    6 # All text after a double hash (##) is considered a comment and is placed in 
    7 # front of the TAG it is preceding. 
    9 # All text after a single hash (#) is considered a comment and will be ignored. 
   11 # TAG = value [value, ...] 
   12 # For lists, items can also be appended using: 
   13 # TAG += value [value, ...] 
   14 # Values that contain spaces should be placed between quotes (\" \"). 
   16 #--------------------------------------------------------------------------- 
   17 # Project related configuration options 
   18 #--------------------------------------------------------------------------- 
   20 # This tag specifies the encoding used for all characters in the config file 
   21 # that follow. The default is UTF-8 which is also the encoding used for all text 
   22 # before the first occurrence of this tag. Doxygen uses libiconv (or the iconv 
   23 # built into libc) for the transcoding. See http://www.gnu.org/software/libiconv 
   24 # for the list of possible encodings. 
   25 # The default value is: UTF-8. 
   27 DOXYFILE_ENCODING      = UTF-8
 
   29 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by 
   30 # double-quotes, unless you are using Doxywizard) that should identify the 
   31 # project for which the documentation is generated. This name is used in the 
   32 # title of most generated pages and in a few other places. 
   33 # The default value is: My Project. 
   35 PROJECT_NAME           = 
"0.9.9 API documenation" 
   37 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This 
   38 # could be handy for archiving the generated documentation or if some version 
   39 # control system is used. 
   43 # Using the PROJECT_BRIEF tag one can provide an optional one line description 
   44 # for a project that appears at the top of each page and should give viewer a 
   45 # quick idea about the purpose of the project. Keep the description short. 
   49 # With the PROJECT_LOGO tag one can specify a logo or an icon that is included 
   50 # in the documentation. The maximum height of the logo should not exceed 55 
   51 # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy 
   52 # the logo to the output directory. 
   54 PROJECT_LOGO           = G:/Source/G-Truc/
glm/doc/manual/logo-mini.png
 
   56 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path 
   57 # into which the generated documentation will be written. If a relative path is 
   58 # entered, it will be relative to the location where doxygen was started. If 
   59 # left blank the current directory will be used. 
   63 # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
 
   64 # directories (in 2 levels) under the output directory of each output format and 
   65 # will distribute the generated files over these directories. Enabling this 
   66 # option can be useful when feeding doxygen a huge amount of source files, where 
   67 # putting all generated files in the same directory would otherwise causes 
   68 # performance problems for the file system. 
   69 # The default value is: NO. 
   73 # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII 
   74 # characters to appear in the names of generated files. If set to NO, non-ASCII 
   75 # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode 
   77 # The default value is: NO. 
   79 ALLOW_UNICODE_NAMES    = NO
 
   81 # The OUTPUT_LANGUAGE tag is used to specify the language in which all 
   82 # documentation generated by doxygen is written. Doxygen will use this 
   83 # information to generate all constant output in the proper language. 
   84 # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, 
   85 # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), 
   86 # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, 
   87 # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), 
   88 # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, 
   89 # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, 
   90 # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, 
   91 # Ukrainian and Vietnamese. 
   92 # The default value is: English. 
   94 OUTPUT_LANGUAGE        = English
 
   96 # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member 
   97 # descriptions after the members that are listed in the file and class 
   98 # documentation (similar to Javadoc). Set to NO to disable this. 
   99 # The default value is: YES. 
  101 BRIEF_MEMBER_DESC      = YES
 
  103 # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief 
  104 # description of a member or function before the detailed description 
  106 # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 
  107 # brief descriptions will be completely suppressed. 
  108 # The default value is: YES. 
  112 # This tag implements a quasi-intelligent brief description abbreviator that is 
  113 # used to form the text in various listings. Each string in this list, if found 
  114 # as the leading text of the brief description, will be stripped from the text 
  115 # and the result, after processing the whole list, is used as the annotated 
  116 # text. Otherwise, the brief description is used as-is. If left blank, the 
  117 # following values are used ($name is automatically replaced with the name of 
  118 # the entity):The $name class, The $name widget, The $name file, is, provides, 
  119 # specifies, contains, represents, a, an and the. 
  121 ABBREVIATE_BRIEF       = 
"The $name class       " \
 
  122                          "The $name widget       " \
 
  133 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 
  134 # doxygen will generate a detailed section even if there is only a brief 
  136 # The default value is: NO. 
  138 ALWAYS_DETAILED_SEC    = NO
 
  140 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 
  141 # inherited members of a class in the documentation of that class as if those 
  142 # members were ordinary class members. Constructors, destructors and assignment 
  143 # operators of the base classes will not be shown. 
  144 # The default value is: NO. 
  146 INLINE_INHERITED_MEMB  = NO
 
  148 # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path 
  149 # before files name in the file list and in the header files. If set to NO the 
  150 # shortest path that makes the file name unique will be used 
  151 # The default value is: YES. 
  155 # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. 
  156 # Stripping is only done if one of the specified strings matches the left-hand 
  157 # part of the path. The tag can be used to show relative paths in the file list. 
  158 # If left blank the directory from which doxygen is run is used as the path to 
  161 # Note that you can specify absolute paths here, but also relative paths, which 
  162 # will be relative from the directory where doxygen is started. 
  163 # This tag requires that the tag FULL_PATH_NAMES is set to YES. 
  165 STRIP_FROM_PATH        = 
"C:/Documents and Settings/Groove/       " 
  167 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the 
  168 # path mentioned in the documentation of a class, which tells the reader which 
  169 # header file to include in order to use a class. If left blank only the name of 
  170 # the header file containing the class definition is used. Otherwise one should 
  171 # specify the list of include paths that are normally passed to the compiler 
  174 STRIP_FROM_INC_PATH    = 
 
  176 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but 
  177 # less readable) file names. This can be useful is your file systems doesn't 
  178 # support long names like on DOS, Mac, or CD-ROM. 
  179 # The default value is: NO. 
  183 # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the 
  184 # first line (until the first dot) of a Javadoc-style comment as the brief 
  185 # description. If set to NO, the Javadoc-style will behave just like regular Qt- 
  186 # style comments (thus requiring an explicit @brief command for a brief 
  188 # The default value is: NO. 
  190 JAVADOC_AUTOBRIEF      = YES
 
  192 # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first 
  193 # line (until the first dot) of a Qt-style comment as the brief description. If 
  194 # set to NO, the Qt-style will behave just like regular Qt-style comments (thus 
  195 # requiring an explicit \brief command for a brief description.) 
  196 # The default value is: NO. 
  200 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a 
  201 # multi-line C++ special comment block (i.e. a block of  
  202 # a brief description. This used to be the default behavior. The new default is 
  203 # to treat a multi-line C++ comment block as a detailed description. Set this 
  204 # tag to YES if you prefer the old behavior instead. 
  206 # Note that setting this tag to YES also means that rational rose comments are 
  207 # not recognized any more. 
  208 # The default value is: NO. 
  210 MULTILINE_CPP_IS_BRIEF = NO
 
  212 # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the 
  213 # documentation from any documented member that it re-implements. 
  214 # The default value is: YES. 
  218 # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new 
  219 # page for each member. If set to NO, the documentation of a member will be part 
  220 # of the file/class/namespace that contains it. 
  221 # The default value is: NO. 
  223 SEPARATE_MEMBER_PAGES  = NO
 
  225 # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen 
  226 # uses this value to replace tabs by spaces in code fragments. 
  227 # Minimum value: 1, maximum value: 16, default value: 4. 
  231 # This tag can be used to specify a number of aliases that act as commands in 
  232 # the documentation. An alias has the form: 
  235 # "sideeffect=@par Side Effects:\n" 
  236 # will allow you to put the command \sideeffect (or @sideeffect) in the 
  237 # documentation, which will result in a user-defined paragraph with heading 
  238 # "Side Effects:". You can put \n's in the value part of an alias to insert 
  243 # This tag can be used to specify a number of word-keyword mappings (TCL only). 
  244 # A mapping has the form "name=value". For example adding "class=itcl::class" 
  245 # will allow you to use the command class in the itcl::class meaning. 
  249 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources 
  250 # only. Doxygen will then generate output that is more tailored for C. For 
  251 # instance, some of the names that are used will be different. The list of all 
  252 # members will be omitted, etc. 
  253 # The default value is: NO. 
  255 OPTIMIZE_OUTPUT_FOR_C  = NO
 
  257 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or 
  258 # Python sources only. Doxygen will then generate output that is more tailored 
  259 # for that language. For instance, namespaces will be presented as packages, 
  260 # qualified scopes will look different, etc. 
  261 # The default value is: NO. 
  263 OPTIMIZE_OUTPUT_JAVA   = NO
 
  265 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 
  266 # sources. Doxygen will then generate output that is tailored for Fortran. 
  267 # The default value is: NO. 
  269 OPTIMIZE_FOR_FORTRAN   = NO
 
  271 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 
  272 # sources. Doxygen will then generate output that is tailored for VHDL. 
  273 # The default value is: NO. 
  275 OPTIMIZE_OUTPUT_VHDL   = NO
 
  277 # Doxygen selects the parser to use depending on the extension of the files it 
  278 # parses. With this tag you can assign which parser to use for a given 
  279 # extension. Doxygen has a built-in mapping, but you can override or extend it 
  280 # using this tag. The format is ext=language, where ext is a file extension, and 
  281 # language is one of the parsers supported by doxygen: IDL, Java, Javascript, 
  282 # C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: 
  283 # FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: 
  284 # Fortran. In the later case the parser tries to guess whether the code is fixed 
  285 # or free formatted code, this is the default for Fortran type files), VHDL. For 
  286 # instance to make doxygen treat .inc files as Fortran files (default is PHP), 
  287 # and .f files as C (default is Fortran), use: inc=Fortran f=C. 
  289 # Note: For files without extension you can use no_extension as a placeholder. 
  291 # Note that for custom extensions you also need to set FILE_PATTERNS otherwise 
  292 # the files are not read by doxygen. 
  296 # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments 
  297 # according to the Markdown format, which allows for more readable 
  298 # documentation. See http://daringfireball.net/projects/markdown/ for details. 
  299 # The output of markdown processing is further processed by doxygen, so you can 
  300 # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in 
  301 # case of backward compatibilities issues. 
  302 # The default value is: YES. 
  304 MARKDOWN_SUPPORT       = YES
 
  306 # When enabled doxygen tries to link words that correspond to documented 
  307 # classes, or namespaces to their corresponding documentation. Such a link can 
  308 # be prevented in individual cases by putting a % sign in front of the word or 
  309 # globally by setting AUTOLINK_SUPPORT to NO. 
  310 # The default value is: YES. 
  312 AUTOLINK_SUPPORT       = YES
 
  314 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 
  315 # to include (a tag file for) the STL sources as input, then you should set this 
  316 # tag to YES in order to let doxygen match functions declarations and 
  317 # definitions whose arguments contain STL classes (e.g. func(std::string); 
  318 # versus func(std::string) {}). This also make the inheritance and collaboration 
  319 # diagrams that involve STL classes more complete and accurate. 
  320 # The default value is: NO. 
  322 BUILTIN_STL_SUPPORT    = NO
 
  324 # If you use Microsoft's C++/CLI language, you should set this option to YES to 
  325 # enable parsing support. 
  326 # The default value is: NO. 
  330 # Set the SIP_SUPPORT tag to YES if your project consists of sip (see: 
  331 # http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen 
  332 # will parse them like normal C++ but will assume all classes use public instead 
  333 # of private inheritance when no explicit protection keyword is present. 
  334 # The default value is: NO. 
  338 # For Microsoft's IDL there are propget and propput attributes to indicate 
  339 # getter and setter methods for a property. Setting this option to YES will make 
  340 # doxygen to replace the get and set methods by a property in the documentation. 
  341 # This will only work if the methods are indeed getting or setting a simple 
  342 # type. If this is not the case, or you want to show the methods anyway, you 
  343 # should set this option to NO. 
  344 # The default value is: YES. 
  346 IDL_PROPERTY_SUPPORT   = YES
 
  348 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 
  349 # tag is set to YES then doxygen will reuse the documentation of the first 
  350 # member in the group (if any) for the other members of the group. By default 
  351 # all members of a group must be documented explicitly. 
  352 # The default value is: NO. 
  354 DISTRIBUTE_GROUP_DOC   = NO
 
  356 # If one adds a struct or class to a group and this option is enabled, then also 
  357 # any nested class or struct is added to the same group. By default this option 
  358 # is disabled and one has to add nested compounds explicitly via \ingroup. 
  359 # The default value is: NO. 
  361 GROUP_NESTED_COMPOUNDS = NO
 
  363 # Set the SUBGROUPING tag to YES to allow class member groups of the same type 
  364 # (for instance a group of public functions) to be put as a subgroup of that 
  365 # type (e.g. under the Public Functions section). Set it to NO to prevent 
  366 # subgrouping. Alternatively, this can be done per class using the 
  367 # \nosubgrouping command. 
  368 # The default value is: YES. 
  372 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions 
  373 # are shown inside the group in which they are included (e.g. using \ingroup) 
  374 # instead of on a separate page (for HTML and Man pages) or section (for LaTeX 
  377 # Note that this feature does not work in combination with 
  378 # SEPARATE_MEMBER_PAGES. 
  379 # The default value is: NO. 
  381 INLINE_GROUPED_CLASSES = NO
 
  383 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions 
  384 # with only public data fields or simple typedef fields will be shown inline in 
  385 # the documentation of the scope in which they are defined (i.e. file, 
  386 # namespace, or group documentation), provided this scope is documented. If set 
  387 # to NO, structs, classes, and unions are shown on a separate page (for HTML and 
  388 # Man pages) or section (for LaTeX and RTF). 
  389 # The default value is: NO. 
  391 INLINE_SIMPLE_STRUCTS  = NO
 
  393 # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or 
  394 # enum is documented as struct, union, or enum with the name of the typedef. So 
  395 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct 
  396 # with name TypeT. When disabled the typedef will appear as a member of a file, 
  397 # namespace, or class. And the struct will be named TypeS. This can typically be 
  398 # useful for C code in case the coding convention dictates that all compound 
  399 # types are typedef'ed and only the typedef is referenced, never the tag name. 
  400 # The default value is: NO. 
  402 TYPEDEF_HIDES_STRUCT   = NO
 
  404 # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This 
  405 # cache is used to resolve symbols given their name and scope. Since this can be 
  406 # an expensive process and often the same symbol appears multiple times in the 
  407 # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small 
  408 # doxygen will become slower. If the cache is too large, memory is wasted. The 
  409 # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range 
  410 # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 
  411 # symbols. At the end of a run doxygen will report the cache usage and suggest 
  412 # the optimal cache size from a speed point of view. 
  413 # Minimum value: 0, maximum value: 9, default value: 0. 
  415 LOOKUP_CACHE_SIZE      = 0
 
  417 #--------------------------------------------------------------------------- 
  418 # Build related configuration options 
  419 #--------------------------------------------------------------------------- 
  421 # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in 
  422 # documentation are documented, even if no documentation was available. Private 
  423 # class members and static file members will be hidden unless the 
  424 # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. 
  425 # Note: This will also disable the warnings about undocumented members that are 
  426 # normally produced when WARNINGS is set to YES. 
  427 # The default value is: NO. 
  431 # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will 
  432 # be included in the documentation. 
  433 # The default value is: NO. 
  437 # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal 
  438 # scope will be included in the documentation. 
  439 # The default value is: NO. 
  443 # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be 
  444 # included in the documentation. 
  445 # The default value is: NO. 
  449 # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined 
  450 # locally in source files will be included in the documentation. If set to NO, 
  451 # only classes defined in header files are included. Does not have any effect 
  453 # The default value is: YES. 
  455 EXTRACT_LOCAL_CLASSES  = NO
 
  457 # This flag is only useful for Objective-C code. If set to YES, local methods, 
  458 # which are defined in the implementation section but not in the interface are 
  459 # included in the documentation. If set to NO, only methods in the interface are 
  461 # The default value is: NO. 
  463 EXTRACT_LOCAL_METHODS  = NO
 
  465 # If this flag is set to YES, the members of anonymous namespaces will be 
  466 # extracted and appear in the documentation as a namespace called 
  467 # 'anonymous_namespace{file}', where file will be replaced with the base name of 
  468 # the file that contains the anonymous namespace. By default anonymous namespace 
  470 # The default value is: NO. 
  472 EXTRACT_ANON_NSPACES   = NO
 
  474 # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all 
  475 # undocumented members inside documented classes or files. If set to NO these 
  476 # members will be included in the various overviews, but no documentation 
  477 # section is generated. This option has no effect if EXTRACT_ALL is enabled. 
  478 # The default value is: NO. 
  480 HIDE_UNDOC_MEMBERS     = YES
 
  482 # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all 
  483 # undocumented classes that are normally visible in the class hierarchy. If set 
  484 # to NO, these classes will be included in the various overviews. This option 
  485 # has no effect if EXTRACT_ALL is enabled. 
  486 # The default value is: NO. 
  488 HIDE_UNDOC_CLASSES     = YES
 
  490 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend 
  491 # (class|struct|union) declarations. If set to NO, these declarations will be 
  492 # included in the documentation. 
  493 # The default value is: NO. 
  495 HIDE_FRIEND_COMPOUNDS  = YES
 
  497 # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any 
  498 # documentation blocks found inside the body of a function. If set to NO, these 
  499 # blocks will be appended to the function's detailed documentation block. 
  500 # The default value is: NO. 
  502 HIDE_IN_BODY_DOCS      = YES
 
  504 # The INTERNAL_DOCS tag determines if documentation that is typed after a 
  505 # \internal command is included. If the tag is set to NO then the documentation 
  506 # will be excluded. Set it to YES to include the internal documentation. 
  507 # The default value is: NO. 
  511 # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file 
  512 # names in lower-case letters. If set to YES, upper-case letters are also 
  513 # allowed. This is useful if you have classes or files whose names only differ 
  514 # in case and if your file system supports case sensitive file names. Windows 
  515 # and Mac users are advised to set this option to NO. 
  516 # The default value is: system dependent. 
  518 CASE_SENSE_NAMES       = YES
 
  520 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with 
  521 # their full class and namespace scopes in the documentation. If set to YES, the 
  522 # scope will be hidden. 
  523 # The default value is: NO. 
  525 HIDE_SCOPE_NAMES       = YES
 
  527 # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will 
  528 # append additional text to a page's title, such as Class Reference. If set to 
  529 # YES the compound reference will be hidden. 
  530 # The default value is: NO. 
  532 HIDE_COMPOUND_REFERENCE= NO
 
  534 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of 
  535 # the files that are included by a file in the documentation of that file. 
  536 # The default value is: YES. 
  538 SHOW_INCLUDE_FILES     = NO
 
  540 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each 
  541 # grouped member an include statement to the documentation, telling the reader 
  542 # which file to include in order to use the member. 
  543 # The default value is: NO. 
  545 SHOW_GROUPED_MEMB_INC  = NO
 
  547 # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include 
  548 # files with double quotes in the documentation rather than with sharp brackets. 
  549 # The default value is: NO. 
  551 FORCE_LOCAL_INCLUDES   = NO
 
  553 # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the 
  554 # documentation for inline members. 
  555 # The default value is: YES. 
  559 # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the 
  560 # (detailed) documentation of file and class members alphabetically by member 
  561 # name. If set to NO, the members will appear in declaration order. 
  562 # The default value is: YES. 
  564 SORT_MEMBER_DOCS       = YES
 
  566 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief 
  567 # descriptions of file, namespace and class members alphabetically by member 
  568 # name. If set to NO, the members will appear in declaration order. Note that 
  569 # this will also influence the order of the classes in the class list. 
  570 # The default value is: NO. 
  572 SORT_BRIEF_DOCS        = YES
 
  574 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the 
  575 # (brief and detailed) documentation of class members so that constructors and 
  576 # destructors are listed first. If set to NO the constructors will appear in the 
  577 # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. 
  578 # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief 
  579 # member documentation. 
  580 # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting 
  581 # detailed member documentation. 
  582 # The default value is: NO. 
  584 SORT_MEMBERS_CTORS_1ST = NO
 
  586 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy 
  587 # of group names into alphabetical order. If set to NO the group names will 
  588 # appear in their defined order. 
  589 # The default value is: NO. 
  591 SORT_GROUP_NAMES       = NO
 
  593 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by 
  594 # fully-qualified names, including namespaces. If set to NO, the class list will 
  595 # be sorted only by class name, not including the namespace part. 
  596 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 
  597 # Note: This option applies only to the class list, not to the alphabetical 
  599 # The default value is: NO. 
  601 SORT_BY_SCOPE_NAME     = YES
 
  603 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper 
  604 # type resolution of all parameters of a function it will reject a match between 
  605 # the prototype and the implementation of a member function even if there is 
  606 # only one candidate or it is obvious which candidate to choose by doing a 
  607 # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still 
  608 # accept a match between prototype and implementation in such cases. 
  609 # The default value is: NO. 
  611 STRICT_PROTO_MATCHING  = NO
 
  613 # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo 
  614 # list. This list is created by putting \todo commands in the documentation. 
  615 # The default value is: YES. 
  617 GENERATE_TODOLIST      = YES
 
  619 # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test 
  620 # list. This list is created by putting \test commands in the documentation. 
  621 # The default value is: YES. 
  623 GENERATE_TESTLIST      = YES
 
  625 # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug 
  626 # list. This list is created by putting \bug commands in the documentation. 
  627 # The default value is: YES. 
  629 GENERATE_BUGLIST       = YES
 
  631 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) 
  632 # the deprecated list. This list is created by putting \deprecated commands in 
  634 # The default value is: YES. 
  636 GENERATE_DEPRECATEDLIST= YES
 
  638 # The ENABLED_SECTIONS tag can be used to enable conditional documentation 
  639 # sections, marked by \if <section_label> ... \endif and \cond <section_label> 
  640 # ... \endcond blocks. 
  644 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the 
  645 # initial value of a variable or macro / define can have for it to appear in the 
  646 # documentation. If the initializer consists of more lines than specified here 
  647 # it will be hidden. Use a value of 0 to hide initializers completely. The 
  648 # appearance of the value of individual variables and macros / defines can be 
  649 # controlled using \showinitializer or \hideinitializer command in the 
  650 # documentation regardless of this setting. 
  651 # Minimum value: 0, maximum value: 10000, default value: 30. 
  653 MAX_INITIALIZER_LINES  = 30
 
  655 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at 
  656 # the bottom of the documentation of classes and structs. If set to YES, the 
  657 # list will mention the files that were used to generate the documentation. 
  658 # The default value is: YES. 
  662 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This 
  663 # will remove the Files entry from the Quick Index and from the Folder Tree View 
  665 # The default value is: YES. 
  669 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces 
  670 # page. This will remove the Namespaces entry from the Quick Index and from the 
  671 # Folder Tree View (if specified). 
  672 # The default value is: YES. 
  674 SHOW_NAMESPACES        = YES
 
  676 # The FILE_VERSION_FILTER tag can be used to specify a program or script that 
  677 # doxygen should invoke to get the current version for each file (typically from 
  678 # the version control system). Doxygen will invoke the program by executing (via 
  679 # popen()) the command command input-file, where command is the value of the 
  680 # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided 
  681 # by doxygen. Whatever the program writes to standard output is used as the file 
  682 # version. For an example see the documentation. 
  684 FILE_VERSION_FILTER    = 
 
  686 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed 
  687 # by doxygen. The layout file controls the global structure of the generated 
  688 # output files in an output format independent way. To create the layout file 
  689 # that represents doxygen's defaults, run doxygen with the -l option. You can 
  690 # optionally specify a file name after the option, if omitted DoxygenLayout.xml 
  691 # will be used as the name of the layout file. 
  693 # Note that if you run doxygen from a directory containing a file called 
  694 # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE 
  699 # The CITE_BIB_FILES tag can be used to specify one or more bib files containing 
  700 # the reference definitions. This must be a list of .bib files. The .bib 
  701 # extension is automatically appended if omitted. This requires the bibtex tool 
  702 # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. 
  703 # For LaTeX the style of the bibliography can be controlled using 
  704 # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the 
  705 # search path. See also \cite for info how to create references. 
  709 #--------------------------------------------------------------------------- 
  710 # Configuration options related to warning and progress messages 
  711 #--------------------------------------------------------------------------- 
  713 # The QUIET tag can be used to turn on/off the messages that are generated to 
  714 # standard output by doxygen. If QUIET is set to YES this implies that the 
  716 # The default value is: NO. 
  720 # The WARNINGS tag can be used to turn on/off the warning messages that are 
  721 # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES 
  722 # this implies that the warnings are on. 
  724 # Tip: Turn warnings on while writing the documentation. 
  725 # The default value is: YES. 
  729 # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate 
  730 # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag 
  731 # will automatically be disabled. 
  732 # The default value is: YES. 
  734 WARN_IF_UNDOCUMENTED   = YES
 
  736 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for 
  737 # potential errors in the documentation, such as not documenting some parameters 
  738 # in a documented function, or documenting parameters that don't exist or using 
  739 # markup commands wrongly. 
  740 # The default value is: YES. 
  742 WARN_IF_DOC_ERROR      = YES
 
  744 # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that 
  745 # are documented, but have no documentation for their parameters or return 
  746 # value. If set to NO, doxygen will only warn about wrong or incomplete 
  747 # parameter documentation, but not about the absence of documentation. 
  748 # The default value is: NO. 
  750 WARN_NO_PARAMDOC       = NO
 
  752 # The WARN_FORMAT tag determines the format of the warning messages that doxygen 
  753 # can produce. The string should contain the $file, $line, and $text tags, which 
  754 # will be replaced by the file and line number from which the warning originated 
  755 # and the warning text. Optionally the format may contain $version, which will 
  756 # be replaced by the version of the file (if it could be obtained via 
  757 # FILE_VERSION_FILTER) 
  758 # The default value is: $file:$line: $text. 
  760 WARN_FORMAT            = 
"$file:$line: $text" 
  762 # The WARN_LOGFILE tag can be used to specify a file to which warning and error 
  763 # messages should be written. If left blank the output is written to standard 
  768 #--------------------------------------------------------------------------- 
  769 # Configuration options related to the input files 
  770 #--------------------------------------------------------------------------- 
  772 # The INPUT tag is used to specify the files and/or directories that contain 
  773 # documented source files. You may enter file names like myfile.cpp or 
  774 # directories like /usr/src/myproject. Separate the files or directories with 
  775 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING 
  776 # Note: If this tag is empty the current directory is searched. 
  781 # This tag can be used to specify the character encoding of the source files
 
  782 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses 
  783 # libiconv (or the iconv built into libc) for the transcoding. See the libiconv 
  784 # documentation (see: http://www.gnu.org/software/libiconv) for the list of 
  785 # possible encodings. 
  786 # The default value is: UTF-8. 
  788 INPUT_ENCODING         = UTF-8
 
  790 # If the value of the INPUT tag contains directories, you can use the 
  791 # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and 
  792 # *.h) to filter out the source-files in the directories. 
  794 # Note that for custom extensions or not directly supported extensions you also 
  795 # need to set EXTENSION_MAPPING for the extension otherwise the files are not 
  798 # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, 
  799 # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, 
  800 # *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, 
  801 # *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, 
  802 # *.vhdl, *.ucf, *.qsf, *.as and *.js. 
  804 FILE_PATTERNS          = *.hpp \
 
  807 # The RECURSIVE tag can be used to specify whether or not subdirectories should 
  808 # be searched for input files as well. 
  809 # The default value is: NO. 
  813 # The EXCLUDE tag can be used to specify files and/or directories that should be 
  814 # excluded from the INPUT source files. This way you can easily exclude a 
  815 # subdirectory from a directory tree whose root is specified with the INPUT tag. 
  817 # Note that relative paths are relative to the directory from which doxygen is 
  822 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or 
  823 # directories that are symbolic links (a Unix file system feature) are excluded 
  825 # The default value is: NO. 
  827 EXCLUDE_SYMLINKS       = NO
 
  829 # If the value of the INPUT tag contains directories, you can use the 
  830 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 
  831 # certain files from those directories. 
  833 # Note that the wildcards are matched against the file with absolute path, so to 
  834 # exclude all test directories for example use the pattern */test