1 # Doxyfile 1.5.1

     1 # Doxyfile 1.5.6

     2 

     3 # This file describes the settings to be used by the documentation system

     4 # doxygen (www.doxygen.org) for a project

     5 #

     6 # All text after a hash (#) is considered a comment and will be ignored

     7 # The format is:

     8 #       TAG = value [value, ...]

     9 # For lists items can also be appended using:

    10 #       TAG += value [value, ...]

    11 # Values that contain spaces should be placed between quotes (" ")

     6 PROJECT_NAME = CanFestival

    16 

     7 PROJECT_NUMBER = 3

    17 # This tag specifies the encoding used for all characters in the config file 

     8 OUTPUT_DIRECTORY = ./

    18 # that follow. The default is UTF-8 which is also the encoding used for all 

     9 CREATE_SUBDIRS = NO

    19 # text before the first occurrence of this tag. Doxygen uses libiconv (or the 

    10 OUTPUT_LANGUAGE = English

    20 # iconv built into libc) for the transcoding. See 

    11 USE_WINDOWS_ENCODING = NO

    21 # http://www.gnu.org/software/libiconv for the list of possible encodings.

    12 BRIEF_MEMBER_DESC = YES

    22 

    13 REPEAT_BRIEF = YES

    23 DOXYFILE_ENCODING      = UTF-8

    14 ABBREVIATE_BRIEF = "The $name class" "The $name widget" "The $name file" is provides specifies contains represents a an the

    24 

    15 ALWAYS_DETAILED_SEC = NO

    25 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded 

    16 INLINE_INHERITED_MEMB = NO

    26 # by quotes) that should identify the project.

    17 FULL_PATH_NAMES = YES

    27 

    18 STRIP_FROM_PATH = ../../

    28 PROJECT_NAME           = CanFestival

    19 STRIP_FROM_INC_PATH = 

    29 

    20 SHORT_NAMES = NO

    30 # The PROJECT_NUMBER tag can be used to enter a project or revision number. 

    21 JAVADOC_AUTOBRIEF = NO

    31 # This could be handy for archiving the generated documentation or 

    32 # if some version control system is used.

    33 

    34 PROJECT_NUMBER         = 3

    35 

    36 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 

    37 # base path where the generated documentation will be put. 

    38 # If a relative path is entered, it will be relative to the location 

    39 # where doxygen was started. If left blank the current directory will be used.

    40 

    41 OUTPUT_DIRECTORY       = ./

    42 

    43 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 

    44 # 4096 sub-directories (in 2 levels) under the output directory of each output 

    45 # format and will distribute the generated files over these directories. 

    46 # Enabling this option can be useful when feeding doxygen a huge amount of 

    47 # source files, where putting all generated files in the same directory would 

    48 # otherwise cause performance problems for the file system.

    49 

    50 CREATE_SUBDIRS         = NO

    51 

    52 # The OUTPUT_LANGUAGE tag is used to specify the language in which all 

    53 # documentation generated by doxygen is written. Doxygen will use this 

    54 # information to generate all constant output in the proper language. 

    55 # The default language is English, other supported languages are: 

    56 # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, 

    57 # Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek, 

    58 # Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages), 

    59 # Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish, 

    60 # Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, 

    61 # and Ukrainian.

    62 

    63 OUTPUT_LANGUAGE        = English

    64 

    65 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 

    66 # include brief member descriptions after the members that are listed in 

    67 # the file and class documentation (similar to JavaDoc). 

    68 # Set to NO to disable this.

    69 

    70 BRIEF_MEMBER_DESC      = YES

    71 

    72 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 

    73 # the brief description of a member or function before the detailed description. 

    74 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 

    75 # brief descriptions will be completely suppressed.

    76 

    77 REPEAT_BRIEF           = YES

    78 

    79 # This tag implements a quasi-intelligent brief description abbreviator 

    80 # that is used to form the text in various listings. Each string 

    81 # in this list, if found as the leading text of the brief description, will be 

    82 # stripped from the text and the result after processing the whole list, is 

    83 # used as the annotated text. Otherwise, the brief description is used as-is. 

    84 # If left blank, the following values are used ("$name" is automatically 

    85 # replaced with the name of the entity): "The $name class" "The $name widget" 

    86 # "The $name file" "is" "provides" "specifies" "contains" 

    87 # "represents" "a" "an" "the"

    88 

    89 ABBREVIATE_BRIEF       = "The $name class" \

    90                          "The $name widget" \

    91                          "The $name file" \

    92                          is \

    93                          provides \

    94                          specifies \

    95                          contains \

    96                          represents \

    97                          a \

    98                          an \

    99                          the

   100 

   101 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 

   102 # Doxygen will generate a detailed section even if there is only a brief 

   103 # description.

   104 

   105 ALWAYS_DETAILED_SEC    = NO

   106 

   107 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 

   108 # inherited members of a class in the documentation of that class as if those 

   109 # members were ordinary class members. Constructors, destructors and assignment 

   110 # operators of the base classes will not be shown.

   111 

   112 INLINE_INHERITED_MEMB  = NO

   113 

   114 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 

   115 # path before files name in the file list and in the header files. If set 

   116 # to NO the shortest path that makes the file name unique will be used.

   117 

   118 FULL_PATH_NAMES        = YES

   119 

   120 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 

   121 # can be used to strip a user-defined part of the path. Stripping is 

   122 # only done if one of the specified strings matches the left-hand part of 

   123 # the path. The tag can be used to show relative paths in the file list. 

   124 # If left blank the directory from which doxygen is run is used as the 

   125 # path to strip.

   126 

   127 STRIP_FROM_PATH        = ../../

   128 

   129 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 

   130 # the path mentioned in the documentation of a class, which tells 

   131 # the reader which header file to include in order to use a class. 

   132 # If left blank only the name of the header file containing the class 

   133 # definition is used. Otherwise one should specify the include paths that 

   134 # are normally passed to the compiler using the -I flag.

   135 

   136 STRIP_FROM_INC_PATH    = 

   137 

   138 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 

   139 # (but less readable) file names. This can be useful is your file systems 

   140 # doesn't support long names like on DOS, Mac, or CD-ROM.

   141 

   142 SHORT_NAMES            = NO

   143 

   144 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 

   145 # will interpret the first line (until the first dot) of a JavaDoc-style 

   146 # comment as the brief description. If set to NO, the JavaDoc 

   147 # comments will behave just like regular Qt-style comments 

   148 # (thus requiring an explicit @brief command for a brief description.)

   149 

   150 JAVADOC_AUTOBRIEF      = NO

   151 

   152 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will 

   153 # interpret the first line (until the first dot) of a Qt-style 

   154 # comment as the brief description. If set to NO, the comments 

   155 # will behave just like regular Qt-style comments (thus requiring 

   156 # an explicit \brief command for a brief description.)

   157 

   158 QT_AUTOBRIEF           = NO

   159 

   160 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 

   161 # treat a multi-line C++ special comment block (i.e. a block of //! or /// 

   162 # comments) as a brief description. This used to be the default behaviour. 

   163 # The new default is to treat a multi-line C++ comment block as a detailed 

   164 # description. Set this tag to YES if you prefer the old behaviour instead.

   165 

    23 DETAILS_AT_TOP = NO

   167 

    24 INHERIT_DOCS = YES

   168 # If the DETAILS_AT_TOP tag is set to YES then Doxygen 

    25 SEPARATE_MEMBER_PAGES = NO

   169 # will output the detailed description near the top, like JavaDoc.

    26 TAB_SIZE = 8

   170 # If set to NO, the detailed description appears after the member 

    27 ALIASES = 

   171 # documentation.

    28 OPTIMIZE_OUTPUT_FOR_C = YES

   172 

    29 OPTIMIZE_OUTPUT_JAVA = NO

   173 DETAILS_AT_TOP         = NO

    30 BUILTIN_STL_SUPPORT = NO

   174 

    31 DISTRIBUTE_GROUP_DOC = NO

   175 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 

    32 SUBGROUPING = YES

   176 # member inherits the documentation from any documented member that it 

   177 # re-implements.

   178 

   179 INHERIT_DOCS           = YES

   180 

   181 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce 

   182 # a new page for each member. If set to NO, the documentation of a member will 

   183 # be part of the file/class/namespace that contains it.

   184 

   185 SEPARATE_MEMBER_PAGES  = NO

   186 

   187 # The TAB_SIZE tag can be used to set the number of spaces in a tab. 

   188 # Doxygen uses this value to replace tabs by spaces in code fragments.

   189 

   190 TAB_SIZE               = 8

   191 

   192 # This tag can be used to specify a number of aliases that acts 

   193 # as commands in the documentation. An alias has the form "name=value". 

   194 # For example adding "sideeffect=\par Side Effects:\n" will allow you to 

   195 # put the command \sideeffect (or @sideeffect) in the documentation, which 

   196 # will result in a user-defined paragraph with heading "Side Effects:". 

   197 # You can put \n's in the value part of an alias to insert newlines.

   198 

   199 ALIASES                = 

   200 

   201 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 

   202 # sources only. Doxygen will then generate output that is more tailored for C. 

   203 # For instance, some of the names that are used will be different. The list 

   204 # of all members will be omitted, etc.

   205 

   206 OPTIMIZE_OUTPUT_FOR_C  = YES

   207 

   208 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java 

   209 # sources only. Doxygen will then generate output that is more tailored for 

   210 # Java. For instance, namespaces will be presented as packages, qualified 

   211 # scopes will look different, etc.

   212 

   213 OPTIMIZE_OUTPUT_JAVA   = NO

   214 

   215 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 

   216 # sources only. Doxygen will then generate output that is more tailored for 

   217 # Fortran.

   218 

   219 OPTIMIZE_FOR_FORTRAN   = NO

   220 

   221 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 

   222 # sources. Doxygen will then generate output that is tailored for 

   223 # VHDL.

   224 

   225 OPTIMIZE_OUTPUT_VHDL   = NO

   226 

   227 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 

   228 # to include (a tag file for) the STL sources as input, then you should 

   229 # set this tag to YES in order to let doxygen match functions declarations and 

   230 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s. 

   231 # func(std::string) {}). This also make the inheritance and collaboration 

   232 # diagrams that involve STL classes more complete and accurate.

   233 

   234 BUILTIN_STL_SUPPORT    = NO

   235 

   236 # If you use Microsoft's C++/CLI language, you should set this option to YES to

   237 # enable parsing support.

   238 

   239 CPP_CLI_SUPPORT        = NO

   240 

   241 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. 

   242 # Doxygen will parse them like normal C++ but will assume all classes use public 

   243 # instead of private inheritance when no explicit protection keyword is present.

   244 

   245 SIP_SUPPORT            = NO

   246 

   247 # For Microsoft's IDL there are propget and propput attributes to indicate getter 

   248 # and setter methods for a property. Setting this option to YES (the default) 

   249 # will make doxygen to replace the get and set methods by a property in the 

   250 # documentation. This will only work if the methods are indeed getting or 

   251 # setting a simple type. If this is not the case, or you want to show the 

   252 # methods anyway, you should set this option to NO.

   253 

   254 IDL_PROPERTY_SUPPORT   = YES

   255 

   256 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 

   257 # tag is set to YES, then doxygen will reuse the documentation of the first 

   258 # member in the group (if any) for the other members of the group. By default 

   259 # all members of a group must be documented explicitly.

   260 

   261 DISTRIBUTE_GROUP_DOC   = NO

   262 

   263 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of 

   264 # the same type (for instance a group of public functions) to be put as a 

   265 # subgroup of that type (e.g. under the Public Functions section). Set it to 

   266 # NO to prevent subgrouping. Alternatively, this can be done per class using 

   267 # the \nosubgrouping command.

   268 

   269 SUBGROUPING            = YES

   270 

   271 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum 

   272 # is documented as struct, union, or enum with the name of the typedef. So 

   273 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct 

   274 # with name TypeT. When disabled the typedef will appear as a member of a file, 

   275 # namespace, or class. And the struct will be named TypeS. This can typically 

   276 # be useful for C code in case the coding convention dictates that all compound 

   277 # types are typedef'ed and only the typedef is referenced, never the tag name.

   278 

   279 TYPEDEF_HIDES_STRUCT   = NO

   280 

    36 EXTRACT_ALL = YES

   284 

    37 EXTRACT_PRIVATE = YES

   285 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 

    38 EXTRACT_STATIC = NO

   286 # documentation are documented, even if no documentation was available. 

    39 EXTRACT_LOCAL_CLASSES = YES

   287 # Private class members and static file members will be hidden unless 

    40 EXTRACT_LOCAL_METHODS = NO

   288 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES

    41 HIDE_UNDOC_MEMBERS = NO

   289 

    42 HIDE_UNDOC_CLASSES = NO

   290 EXTRACT_ALL            = YES

    43 HIDE_FRIEND_COMPOUNDS = NO

   291 

    44 HIDE_IN_BODY_DOCS = NO

   292 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class 

    45 INTERNAL_DOCS = NO

   293 # will be included in the documentation.

    46 CASE_SENSE_NAMES = YES

   294 

    47 HIDE_SCOPE_NAMES = NO

   295 EXTRACT_PRIVATE        = YES

    48 SHOW_INCLUDE_FILES = YES

   296 

    49 INLINE_INFO = YES

   297 # If the EXTRACT_STATIC tag is set to YES all static members of a file 

    50 SORT_MEMBER_DOCS = YES

   298 # will be included in the documentation.

    51 SORT_BRIEF_DOCS = NO

   299 

    52 SORT_BY_SCOPE_NAME = NO

   300 EXTRACT_STATIC         = YES

    53 GENERATE_TODOLIST = YES

   301 

    54 GENERATE_TESTLIST = YES

   302 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 

    55 GENERATE_BUGLIST = YES

   303 # defined locally in source files will be included in the documentation. 

    56 GENERATE_DEPRECATEDLIST = YES

   304 # If set to NO only classes defined in header files are included.

    57 ENABLED_SECTIONS = 

   305 

    58 MAX_INITIALIZER_LINES = 30

   306 EXTRACT_LOCAL_CLASSES  = YES

    59 SHOW_USED_FILES = YES

   307 

    60 SHOW_DIRECTORIES = YES

   308 # This flag is only useful for Objective-C code. When set to YES local 

    61 FILE_VERSION_FILTER = 

   309 # methods, which are defined in the implementation section but not in 

   310 # the interface are included in the documentation. 

   311 # If set to NO (the default) only methods in the interface are included.

   312 

   313 EXTRACT_LOCAL_METHODS  = NO

   314 

   315 # If this flag is set to YES, the members of anonymous namespaces will be 

   316 # extracted and appear in the documentation as a namespace called 

   317 # 'anonymous_namespace{file}', where file will be replaced with the base 

   318 # name of the file that contains the anonymous namespace. By default 

   319 # anonymous namespace are hidden.

   320 

   321 EXTRACT_ANON_NSPACES   = NO

   322 

   323 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 

   324 # undocumented members of documented classes, files or namespaces. 

   325 # If set to NO (the default) these members will be included in the 

   326 # various overviews, but no documentation section is generated. 

   327 # This option has no effect if EXTRACT_ALL is enabled.

   328 

   329 HIDE_UNDOC_MEMBERS     = NO

   330 

   331 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 

   332 # undocumented classes that are normally visible in the class hierarchy. 

   333 # If set to NO (the default) these classes will be included in the various 

   334 # overviews. This option has no effect if EXTRACT_ALL is enabled.

   335 

   336 HIDE_UNDOC_CLASSES     = NO

   337 

   338 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 

   339 # friend (class|struct|union) declarations. 

   340 # If set to NO (the default) these declarations will be included in the 

   341 # documentation.

   342 

   343 HIDE_FRIEND_COMPOUNDS  = NO

   344 

   345 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 

   346 # documentation blocks found inside the body of a function. 

   347 # If set to NO (the default) these blocks will be appended to the 

   348 # function's detailed documentation block.

   349 

   350 HIDE_IN_BODY_DOCS      = NO

   351 

   352 # The INTERNAL_DOCS tag determines if documentation 

   353 # that is typed after a \internal command is included. If the tag is set 

   354 # to NO (the default) then the documentation will be excluded. 

   355 # Set it to YES to include the internal documentation.

   356 

   357 INTERNAL_DOCS          = YES

   358 

   359 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 

   360 # file names in lower-case letters. If set to YES upper-case letters are also 

   361 # allowed. This is useful if you have classes or files whose names only differ 

   362 # in case and if your file system supports case sensitive file names. Windows 

   363 # and Mac users are advised to set this option to NO.

   364 

   365 CASE_SENSE_NAMES       = YES

   366 

   367 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 

   368 # will show members with their full class and namespace scopes in the 

   369 # documentation. If set to YES the scope will be hidden.

   370 

   371 HIDE_SCOPE_NAMES       = NO

   372 

   373 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 

   374 # will put a list of the files that are included by a file in the documentation 

   375 # of that file.

   376 

   377 SHOW_INCLUDE_FILES     = YES

   378 

   379 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 

   380 # is inserted in the documentation for inline members.

   381 

   382 INLINE_INFO            = YES

   383 

   384 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 

   385 # will sort the (detailed) documentation of file and class members 

   386 # alphabetically by member name. If set to NO the members will appear in 

   387 # declaration order.

   388 

   389 SORT_MEMBER_DOCS       = YES

   390 

   391 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 

   392 # brief documentation of file, namespace and class members alphabetically 

   393 # by member name. If set to NO (the default) the members will appear in 

   394 # declaration order.

   395 

   396 SORT_BRIEF_DOCS        = NO

   397 

   398 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the 

   399 # hierarchy of group names into alphabetical order. If set to NO (the default) 

   400 # the group names will appear in their defined order.

   401 

   402 SORT_GROUP_NAMES       = NO

   403 

   404 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 

   405 # sorted by fully-qualified names, including namespaces. If set to 

   406 # NO (the default), the class list will be sorted only by class name, 

   407 # not including the namespace part. 

   408 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.

   409 # Note: This option applies only to the class list, not to the 

   410 # alphabetical list.

   411 

   412 SORT_BY_SCOPE_NAME     = NO

   413 

   414 # The GENERATE_TODOLIST tag can be used to enable (YES) or 

   415 # disable (NO) the todo list. This list is created by putting \todo 

   416 # commands in the documentation.

   417 

   418 GENERATE_TODOLIST      = YES

   419 

   420 # The GENERATE_TESTLIST tag can be used to enable (YES) or 

   421 # disable (NO) the test list. This list is created by putting \test 

   422 # commands in the documentation.

   423 

   424 GENERATE_TESTLIST      = YES

   425 

   426 # The GENERATE_BUGLIST tag can be used to enable (YES) or 

   427 # disable (NO) the bug list. This list is created by putting \bug 

   428 # commands in the documentation.

   429 

   430 GENERATE_BUGLIST       = YES

   431 

   432 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 

   433 # disable (NO) the deprecated list. This list is created by putting 

   434 # \deprecated commands in the documentation.

   435 

   436 GENERATE_DEPRECATEDLIST= YES

   437 

   438 # The ENABLED_SECTIONS tag can be used to enable conditional 

   439 # documentation sections, marked by \if sectionname ... \endif.

   440 

   441 ENABLED_SECTIONS       = 

   442 

   443 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines 

   444 # the initial value of a variable or define consists of for it to appear in 

   445 # the documentation. If the initializer consists of more lines than specified 

   446 # here it will be hidden. Use a value of 0 to hide initializers completely. 

   447 # The appearance of the initializer of individual variables and defines in the 

   448 # documentation can be controlled using \showinitializer or \hideinitializer 

   449 # command in the documentation regardless of this setting.

   450 

   451 MAX_INITIALIZER_LINES  = 30

   452 

   453 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated 

   454 # at the bottom of the documentation of classes and structs. If set to YES the 

   455 # list will mention the files that were used to generate the documentation.

   456 

   457 SHOW_USED_FILES        = YES

   458 

   459 # If the sources in your project are distributed over multiple directories 

   460 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy 

   461 # in the documentation. The default is NO.

   462 

   463 SHOW_DIRECTORIES       = YES

   464 

   465 # Set the SHOW_FILES tag to NO to disable the generation of the Files page.

   466 # This will remove the Files entry from the Quick Index and from the 

   467 # Folder Tree View (if specified). The default is YES.

   468 

   469 SHOW_FILES             = YES

   470 

   471 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the 

   472 # Namespaces page.  This will remove the Namespaces entry from the Quick Index

   473 # and from the Folder Tree View (if specified). The default is YES.

   474 

   475 SHOW_NAMESPACES        = YES

   476 

   477 # The FILE_VERSION_FILTER tag can be used to specify a program or script that 

   478 # doxygen should invoke to get the current version for each file (typically from 

   479 # the version control system). Doxygen will invoke the program by executing (via 

   480 # popen()) the command <command> <input-file>, where <command> is the value of 

   481 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file 

   482 # provided by doxygen. Whatever the program writes to standard output 

   483 # is used as the file version. See the manual for examples.

   484 

   485 FILE_VERSION_FILTER    = 

   486 

    65 QUIET = NO

   490 

    66 WARNINGS = YES

   491 # The QUIET tag can be used to turn on/off the messages that are generated 

    67 WARN_IF_UNDOCUMENTED = YES

   492 # by doxygen. Possible values are YES and NO. If left blank NO is used.

    68 WARN_IF_DOC_ERROR = YES

   493 

    69 WARN_NO_PARAMDOC = NO

   494 QUIET                  = NO

    70 WARN_FORMAT = "$file:$line: $text"

   495 

    71 WARN_LOGFILE = 

   496 # The WARNINGS tag can be used to turn on/off the warning messages that are 

   497 # generated by doxygen. Possible values are YES and NO. If left blank 

   498 # NO is used.

   499 

   500 WARNINGS               = YES

   501 

   502 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 

   503 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will 

   504 # automatically be disabled.

   505 

   506 WARN_IF_UNDOCUMENTED   = YES

   507 

   508 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 

   509 # potential errors in the documentation, such as not documenting some 

   510 # parameters in a documented function, or documenting parameters that 

   511 # don't exist or using markup commands wrongly.

   512 

   513 WARN_IF_DOC_ERROR      = YES

   514 

   515 # This WARN_NO_PARAMDOC option can be abled to get warnings for 

   516 # functions that are documented, but have no documentation for their parameters 

   517 # or return value. If set to NO (the default) doxygen will only warn about 

   518 # wrong or incomplete parameter documentation, but not about the absence of 

   519 # documentation.

   520 

   521 WARN_NO_PARAMDOC       = NO

   522 

   523 # The WARN_FORMAT tag determines the format of the warning messages that 

   524 # doxygen can produce. The string should contain the $file, $line, and $text 

   525 # tags, which will be replaced by the file and line number from which the 

   526 # warning originated and the warning text. Optionally the format may contain 

   527 # $version, which will be replaced by the version of the file (if it could 

   528 # be obtained via FILE_VERSION_FILTER)

   529 

   530 WARN_FORMAT            = "$file:$line: $text"

   531 

   532 # The WARN_LOGFILE tag can be used to specify a file to which warning 

   533 # and error messages should be written. If left blank the output is written 

   534 # to stderr.

   535 

   536 WARN_LOGFILE           = 

   537 

    75 INPUT = ../../src ../../drivers/can_lincan ../../drivers/can_peak_linux ../../drivers/can_vscom ../../drivers/can_peak_win32 ../../drivers/can_socket ../../drivers/can_uvccm_win32 ../../drivers/can_virtual ../../drivers/hcs12 ../../drivers/timers_unix ../../drivers/timers_xeno ../../drivers/unix ../../drivers/win32 ../../examples/gene_SYNC_HCS12 ../../examples/TestMasterSlave ../../examples/TestMasterMicroMod ../../examples/win32test ../../include ../../drivers/can_serial 

   541 

    76 

   542 # The INPUT tag can be used to specify the files and/or directories that contain 

    77 

   543 # documented source files. You may enter file names like "myfile.cpp" or 

    78  

   544 # directories like "/usr/src/myproject". Separate the files or directories 

    79 FILE_PATTERNS = *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py *.C *.CC *.C++ *.II *.I++ *.H *.HH *.H++ *.CS *.PHP *.PHP3 *.M *.MM *.PY

   545 # with spaces.

    80 RECURSIVE = YES

   546 

    81 EXCLUDE = 

   547 INPUT                  = ../../include

    82 EXCLUDE_SYMLINKS = NO

   548 

    83 EXCLUDE_PATTERNS = 

   549 # This tag can be used to specify the character encoding of the source files 

    84 EXAMPLE_PATH = 

   550 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is 

    85 EXAMPLE_PATTERNS = *

   551 # also the default input encoding. Doxygen uses libiconv (or the iconv built 

    86 EXAMPLE_RECURSIVE = NO

   552 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for 

    87 IMAGE_PATH = 

   553 # the list of possible encodings.

    88 INPUT_FILTER = 

   554 

    89 FILTER_PATTERNS = 

   555 INPUT_ENCODING         = UTF-8

    90 FILTER_SOURCE_FILES = NO

   556 

   557 # If the value of the INPUT tag contains directories, you can use the 

   558 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 

   559 # and *.h) to filter out the source-files in the directories. If left 

   560 # blank the following patterns are tested: 

   561 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx 

   562 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90

   563 

   564 FILE_PATTERNS          = *.c \

   565                          *.cc \

   566                          *.cxx \

   567                          *.cpp \

   568                          *.c++ \

   569                          *.d \

   570                          *.java \

   571                          *.ii \

   572                          *.ixx \

   573                          *.ipp \

   574                          *.i++ \

   575                          *.inl \

   576                          *.h \

   577                          *.hh \

   578                          *.hxx \

   579                          *.hpp \

   580                          *.h++ \

   581                          *.idl \

   582                          *.odl \

   583                          *.cs \

   584                          *.php \

   585                          *.php3 \

   586                          *.inc \

   587                          *.m \

   588                          *.mm \

   589                          *.dox \

   590                          *.py \

   591                          *.C \

   592                          *.CC \

   593                          *.C++ \

   594                          *.II \

   595                          *.I++ \

   596                          *.H \

   597                          *.HH \

   598                          *.H++ \

   599                          *.CS \

   600                          *.PHP \

   601                          *.PHP3 \

   602                          *.M \

   603                          *.MM \

   604                          *.PY

   605 

   606 # The RECURSIVE tag can be used to turn specify whether or not subdirectories 

   607 # should be searched for input files as well. Possible values are YES and NO. 

   608 # If left blank NO is used.

   609 

   610 RECURSIVE              = YES

   611 

   612 # The EXCLUDE tag can be used to specify files and/or directories that should 

   613 # excluded from the INPUT source files. This way you can easily exclude a 

   614 # subdirectory from a directory tree whose root is specified with the INPUT tag.

   615 

   616 EXCLUDE                = 

   617 

   618 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or 

   619 # directories that are symbolic links (a Unix filesystem feature) are excluded 

   620 # from the input.

   621 

   622 EXCLUDE_SYMLINKS       = NO

   623 

   624 # If the value of the INPUT tag contains directories, you can use the 

   625 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 

   626 # certain files from those directories. Note that the wildcards are matched 

   627 # against the file with absolute path, so to exclude all test directories 

   628 # for example use the pattern */test/*

   629 

   630 EXCLUDE_PATTERNS       = 

   631 

   632 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 

   633 # (namespaces, classes, functions, etc.) that should be excluded from the 

   634 # output. The symbol name can be a fully qualified name, a word, or if the 

   635 # wildcard * is used, a substring. Examples: ANamespace, AClass, 

   636 # AClass::ANamespace, ANamespace::*Test

   637 

   638 EXCLUDE_SYMBOLS        = 

   639 

   640 # The EXAMPLE_PATH tag can be used to specify one or more files or 

   641 # directories that contain example code fragments that are included (see 

   642 # the \include command).

   643 

   644 EXAMPLE_PATH           =

   645 

   646 # If the value of the EXAMPLE_PATH tag contains directories, you can use the 

   647 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 

   648 # and *.h) to filter out the source-files in the directories. If left 

   649 # blank all files are included.

   650 

   651 EXAMPLE_PATTERNS       = *

   652 

   653 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 

   654 # searched for input files to be used with the \include or \dontinclude 

   655 # commands irrespective of the value of the RECURSIVE tag. 

   656 # Possible values are YES and NO. If left blank NO is used.

   657 

   658 EXAMPLE_RECURSIVE      = NO

   659 

   660 # The IMAGE_PATH tag can be used to specify one or more files or 

   661 # directories that contain image that are included in the documentation (see 

   662 # the \image command).

   663 

   664 IMAGE_PATH             = 

   665 

   666 # The INPUT_FILTER tag can be used to specify a program that doxygen should 

   667 # invoke to filter for each input file. Doxygen will invoke the filter program 

   668 # by executing (via popen()) the command <filter> <input-file>, where <filter> 

   669 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an 

   670 # input file. Doxygen will then use the output that the filter program writes 

   671 # to standard output.  If FILTER_PATTERNS is specified, this tag will be 

   672 # ignored.

   673 

   674 INPUT_FILTER           = 

   675 

   676 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 

   677 # basis.  Doxygen will compare the file name with each pattern and apply the 

   678 # filter if there is a match.  The filters are a list of the form: 

   679 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 

   680 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER 

   681 # is applied to all files.

   682 

   683 FILTER_PATTERNS        = 

   684 

   685 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 

   686 # INPUT_FILTER) will be used to filter the input files when producing source 

   687 # files to browse (i.e. when SOURCE_BROWSER is set to YES).

   688 

   689 FILTER_SOURCE_FILES    = NO

   690 

    94 SOURCE_BROWSER = YES

   694 

    95 INLINE_SOURCES = NO

   695 # If the SOURCE_BROWSER tag is set to YES then a list of source files will 

    96 STRIP_CODE_COMMENTS = YES

   696 # be generated. Documented entities will be cross-referenced with these sources. 

   697 # Note: To get rid of all source code in the generated output, make sure also 

   698 # VERBATIM_HEADERS is set to NO.

   699 

   700 SOURCE_BROWSER         = YES

   701 

   702 # Setting the INLINE_SOURCES tag to YES will include the body 

   703 # of functions and classes directly in the documentation.

   704 

   705 INLINE_SOURCES         = NO

   706 

   707 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 

   708 # doxygen to hide any special comment blocks from generated source code 

   709 # fragments. Normal C and C++ comments will always remain visible.

   710 

   711 STRIP_CODE_COMMENTS    = YES

   712 

   713 # If the REFERENCED_BY_RELATION tag is set to YES 

   714 # then for each documented function all documented 

   715 # functions referencing it will be listed.

   716 

    98 REFERENCES_RELATION = YES

   718 

   719 # If the REFERENCES_RELATION tag is set to YES 

   720 # then for each documented function all documented entities 

   721 # called/used by that function will be listed.

   722 

   723 REFERENCES_RELATION    = YES

   724 

   725 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)

   726 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from

   727 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will

   728 # link to the source code.  Otherwise they will link to the documentstion.

   729 

   100 USE_HTAGS = NO

   731 

   101 VERBATIM_HEADERS = YES

   732 # If the USE_HTAGS tag is set to YES then the references to source code 

   733 # will point to the HTML generated by the htags(1) tool instead of doxygen 

   734 # built-in source browser. The htags tool is part of GNU's global source 

   735 # tagging system (see http://www.gnu.org/software/global/global.html). You 

   736 # will need version 4.8.6 or higher.

   737 

   738 USE_HTAGS              = NO

   739 

   740 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 

   741 # will generate a verbatim copy of the header file for each class for 

   742 # which an include is specified. Set to NO to disable this.

   743 

   744 VERBATIM_HEADERS       = YES

   745 

   105 ALPHABETICAL_INDEX = NO

   749 

   106 COLS_IN_ALPHA_INDEX = 5

   750 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 

   107 IGNORE_PREFIX = 

   751 # of all compounds will be generated. Enable this if the project 

   752 # contains a lot of classes, structs, unions or interfaces.

   753 

   754 ALPHABETICAL_INDEX     = NO

   755 

   756 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 

   757 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 

   758 # in which this list will be split (can be a number in the range [1..20])

   759 

   760 COLS_IN_ALPHA_INDEX    = 5

   761 

   762 # In case all classes in a project start with a common prefix, all 

   763 # classes will be put under the same header in the alphabetical index. 

   764 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that 

   765 # should be ignored while generating the index headers.

   766 

   767 IGNORE_PREFIX          = 

   768 

   111 GENERATE_HTML = YES

   772 

   112 HTML_OUTPUT = html

   773 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will 

   113 HTML_FILE_EXTENSION = .html

   774 # generate HTML output.

   114 HTML_HEADER = 

   775 

   115 HTML_FOOTER = 

   776 GENERATE_HTML          = YES

   116 HTML_STYLESHEET = 

   777 

   117 HTML_ALIGN_MEMBERS = YES

   778 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 

   118 GENERATE_HTMLHELP = NO

   779 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 

   119 CHM_FILE = 

   780 # put in front of it. If left blank `html' will be used as the default path.

   120 HHC_LOCATION = 

   781 

   121 GENERATE_CHI = NO

   782 HTML_OUTPUT            = html

   122 BINARY_TOC = NO

   783 

   123 TOC_EXPAND = NO

   784 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for 

   124 DISABLE_INDEX = NO

   785 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank 

   125 ENUM_VALUES_PER_LINE = 4

   786 # doxygen will generate files with .html extension.

   126 GENERATE_TREEVIEW = YES

   787 

   127 TREEVIEW_WIDTH = 250

   788 HTML_FILE_EXTENSION    = .html

   789 

   790 # The HTML_HEADER tag can be used to specify a personal HTML header for 

   791 # each generated HTML page. If it is left blank doxygen will generate a 

   792 # standard header.

   793 

   794 HTML_HEADER            = 

   795 

   796 # The HTML_FOOTER tag can be used to specify a personal HTML footer for 

   797 # each generated HTML page. If it is left blank doxygen will generate a 

   798 # standard footer.

   799 

   800 HTML_FOOTER            = 

   801 

   802 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading 

   803 # style sheet that is used by each HTML page. It can be used to 

   804 # fine-tune the look of the HTML output. If the tag is left blank doxygen 

   805 # will generate a default style sheet. Note that doxygen will try to copy 

   806 # the style sheet file to the HTML output directory, so don't put your own 

   807 # stylesheet in the HTML output directory as well, or it will be erased!

   808 

   809 HTML_STYLESHEET        = 

   810 

   811 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 

   812 # files or namespaces will be aligned in HTML using tables. If set to 

   813 # NO a bullet list will be used.

   814 

   815 HTML_ALIGN_MEMBERS     = YES

   816 

   817 # If the GENERATE_HTMLHELP tag is set to YES, additional index files 

   818 # will be generated that can be used as input for tools like the 

   819 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm) 

   820 # of the generated HTML documentation.

   821 

   822 GENERATE_HTMLHELP      = NO

   823 

   824 # If the GENERATE_DOCSET tag is set to YES, additional index files 

   825 # will be generated that can be used as input for Apple's Xcode 3 

   826 # integrated development environment, introduced with OSX 10.5 (Leopard). 

   827 # To create a documentation set, doxygen will generate a Makefile in the 

   828 # HTML output directory. Running make will produce the docset in that 

   829 # directory and running "make install" will install the docset in 

   830 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find 

   831 # it at startup.

   832 

   833 GENERATE_DOCSET        = NO

   834 

   835 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the 

   836 # feed. A documentation feed provides an umbrella under which multiple 

   837 # documentation sets from a single provider (such as a company or product suite) 

   838 # can be grouped.

   839 

   840 DOCSET_FEEDNAME        = "Doxygen generated docs"

   841 

   842 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that 

   843 # should uniquely identify the documentation set bundle. This should be a 

   844 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen 

   845 # will append .docset to the name.

   846 

   847 DOCSET_BUNDLE_ID       = org.doxygen.Project

   848 

   849 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 

   850 # documentation will contain sections that can be hidden and shown after the 

   851 # page has loaded. For this to work a browser that supports 

   852 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox 

   853 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).

   854 

   855 HTML_DYNAMIC_SECTIONS  = NO

   856 

   857 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 

   858 # be used to specify the file name of the resulting .chm file. You 

   859 # can add a path in front of the file if the result should not be 

   860 # written to the html output directory.

   861 

   862 CHM_FILE               = 

   863 

   864 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 

   865 # be used to specify the location (absolute path including file name) of 

   866 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 

   867 # the HTML help compiler on the generated index.hhp.

   868 

   869 HHC_LOCATION           = 

   870 

   871 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 

   872 # controls if a separate .chi index file is generated (YES) or that 

   873 # it should be included in the master .chm file (NO).

   874 

   875 GENERATE_CHI           = NO

   876 

   877 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING

   878 # is used to encode HtmlHelp index (hhk), content (hhc) and project file

   879 # content.

   880 

   881 CHM_INDEX_ENCODING     = 

   882 

   883 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 

   884 # controls whether a binary table of contents is generated (YES) or a 

   885 # normal table of contents (NO) in the .chm file.

   886 

   887 BINARY_TOC             = NO

   888 

   889 # The TOC_EXPAND flag can be set to YES to add extra items for group members 

   890 # to the contents of the HTML help documentation and to the tree view.

   891 

   892 TOC_EXPAND             = NO

   893 

   894 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at 

   895 # top of each HTML page. The value NO (the default) enables the index and 

   896 # the value YES disables it.

   897 

   898 DISABLE_INDEX          = NO

   899 

   900 # This tag can be used to set the number of enum values (range [1..20]) 

   901 # that doxygen will group on one line in the generated HTML documentation.

   902 

   903 ENUM_VALUES_PER_LINE   = 4

   904 

   905 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index

   906 # structure should be generated to display hierarchical information.

   907 # If the tag value is set to FRAME, a side panel will be generated

   908 # containing a tree-like index structure (just like the one that 

   909 # is generated for HTML Help). For this to work a browser that supports 

   910 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, 

   911 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are 

   912 # probably better off using the HTML help feature. Other possible values 

   913 # for this tag are: HIERARCHIES, which will generate the Groups, Directories,

   914 # and Class Hiererachy pages using a tree view instead of an ordered list;

   915 # ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which

   916 # disables this behavior completely. For backwards compatibility with previous

   917 # releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE

   918 # respectively.

   919 

   920 GENERATE_TREEVIEW      = YES

   921 

   922 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 

   923 # used to set the initial width (in pixels) of the frame in which the tree 

   924 # is shown.

   925 

   926 TREEVIEW_WIDTH         = 250

   927 

   928 # Use this tag to change the font size of Latex formulas included 

   929 # as images in the HTML documentation. The default is 10. Note that 

   930 # when you change the font size after a successful doxygen run you need 

   931 # to manually remove any form_*.png images from the HTML output directory 

   932 # to force them to be regenerated.

   933 

   934 FORMULA_FONTSIZE       = 10

   935 

   131 GENERATE_LATEX = NO

   939 

   132 LATEX_OUTPUT = latex

   940 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 

   133 LATEX_CMD_NAME = latex

   941 # generate Latex output.

   134 MAKEINDEX_CMD_NAME = makeindex

   942 

   135 COMPACT_LATEX = NO

   943 GENERATE_LATEX         = NO

   136 PAPER_TYPE = a4wide

   944 

   137 EXTRA_PACKAGES = 

   945 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 

   138 LATEX_HEADER = 

   946 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 

   139 PDF_HYPERLINKS = YES

   947 # put in front of it. If left blank `latex' will be used as the default path.

   140 USE_PDFLATEX = YES

   948 

   141 LATEX_BATCHMODE = NO

   949 LATEX_OUTPUT           = latex

   142 LATEX_HIDE_INDICES = NO

   950 

   951 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 

   952 # invoked. If left blank `latex' will be used as the default command name.

   953 

   954 LATEX_CMD_NAME         = latex

   955 

   956 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 

   957 # generate index for LaTeX. If left blank `makeindex' will be used as the 

   958 # default command name.

   959 

   960 MAKEINDEX_CMD_NAME     = makeindex

   961 

   962 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 

   963 # LaTeX documents. This may be useful for small projects and may help to 

   964 # save some trees in general.

   965 

   966 COMPACT_LATEX          = NO

   967 

   968 # The PAPER_TYPE tag can be used to set the paper type that is used 

   969 # by the printer. Possible values are: a4, a4wide, letter, legal and 

   970 # executive. If left blank a4wide will be used.

   971 

   972 PAPER_TYPE             = a4wide

   973 

   974 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 

   975 # packages that should be included in the LaTeX output.

   976 

   977 EXTRA_PACKAGES         = 

   978 

   979 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for 

   980 # the generated latex document. The header should contain everything until 

   981 # the first chapter. If it is left blank doxygen will generate a 

   982 # standard header. Notice: only use this tag if you know what you are doing!

   983 

   984 LATEX_HEADER           = 

   985 

   986 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 

   987 # is prepared for conversion to pdf (using ps2pdf). The pdf file will 

   988 # contain links (just like the HTML output) instead of page references 

   989 # This makes the output suitable for online browsing using a pdf viewer.

   990 

   991 PDF_HYPERLINKS         = YES

   992 

   993 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 

   994 # plain latex in the generated Makefile. Set this option to YES to get a 

   995 # higher quality PDF documentation.

   996 

   997 USE_PDFLATEX           = YES

   998 

   999 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 

  1000 # command to the generated LaTeX files. This will instruct LaTeX to keep 

  1001 # running if errors occur, instead of asking the user for help. 

  1002 # This option is also used when generating formulas in HTML.

  1003 

  1004 LATEX_BATCHMODE        = NO

  1005 

  1006 # If LATEX_HIDE_INDICES is set to YES then doxygen will not 

  1007 # include the index chapters (such as File Index, Compound Index, etc.) 

  1008 # in the output.

  1009 

  1010 LATEX_HIDE_INDICES     = NO

  1011 

   146 GENERATE_RTF = NO

  1015 

   147 RTF_OUTPUT = rtf

  1016 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 

   148 COMPACT_RTF = NO

  1017 # The RTF output is optimized for Word 97 and may not look very pretty with 

   149 RTF_HYPERLINKS = NO

  1018 # other RTF readers or editors.

   150 RTF_STYLESHEET_FILE = 

  1019 

   151 RTF_EXTENSIONS_FILE = 

  1020 GENERATE_RTF           = NO

  1021 

  1022 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 

  1023 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 

  1024 # put in front of it. If left blank `rtf' will be used as the default path.

  1025 

  1026 RTF_OUTPUT             = rtf

  1027 

  1028 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact 

  1029 # RTF documents. This may be useful for small projects and may help to 

  1030 # save some trees in general.

  1031 

  1032 COMPACT_RTF            = NO

  1033 

  1034 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 

  1035 # will contain hyperlink fields. The RTF file will 

  1036 # contain links (just like the HTML output) instead of page references. 

  1037 # This makes the output suitable for online browsing using WORD or other 

  1038 # programs which support those fields. 

  1039 # Note: wordpad (write) and others do not support links.

  1040 

  1041 RTF_HYPERLINKS         = NO

  1042 

  1043 # Load stylesheet definitions from file. Syntax is similar to doxygen's 

  1044 # config file, i.e. a series of assignments. You only have to provide 

  1045 # replacements, missing definitions are set to their default value.

  1046 

  1047 RTF_STYLESHEET_FILE    = 

  1048 

  1049 # Set optional variables used in the generation of an rtf document. 

  1050 # Syntax is similar to doxygen's config file.

  1051 

  1052 RTF_EXTENSIONS_FILE    = 

  1053 

   155 GENERATE_MAN = NO

  1057 

   156 MAN_OUTPUT = man

  1058 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will 

   157 MAN_EXTENSION = .3

  1059 # generate man pages

   158 MAN_LINKS = NO

  1060 

  1061 GENERATE_MAN           = NO

  1062 

  1063 # The MAN_OUTPUT tag is used to specify where the man pages will be put. 

  1064 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 

  1065 # put in front of it. If left blank `man' will be used as the default path.

  1066 

  1067 MAN_OUTPUT             = man

  1068 

  1069 # The MAN_EXTENSION tag determines the extension that is added to 

  1070 # the generated man pages (default is the subroutine's section .3)

  1071 

  1072 MAN_EXTENSION          = .3

  1073 

  1074 # If the MAN_LINKS tag is set to YES and Doxygen generates man output, 

  1075 # then it will generate one additional man file for each entity 

  1076 # documented in the real man page(s). These additional files 

  1077 # only source the real man page, but without them the man command 

  1078 # would be unable to find the correct page. The default is NO.

  1079 

  1080 MAN_LINKS              = NO

  1081 

   162 GENERATE_XML = NO

  1085 

   163 XML_OUTPUT = xml

  1086 # If the GENERATE_XML tag is set to YES Doxygen will 

   164 XML_SCHEMA = 

  1087 # generate an XML file that captures the structure of 

   165 XML_DTD = 

  1088 # the code including all documentation.

   166 XML_PROGRAMLISTING = YES

  1089 

  1090 GENERATE_XML           = NO

  1091 

  1092 # The XML_OUTPUT tag is used to specify where the XML pages will be put. 

  1093 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 

  1094 # put in front of it. If left blank `xml' will be used as the default path.

  1095 

  1096 XML_OUTPUT             = xml

  1097 

  1098 # The XML_SCHEMA tag can be used to specify an XML schema, 

  1099 # which can be used by a validating XML parser to check the 

  1100 # syntax of the XML files.

  1101 

  1102 XML_SCHEMA             = 

  1103 

  1104 # The XML_DTD tag can be used to specify an XML DTD, 

  1105 # which can be used by a validating XML parser to check the 

  1106 # syntax of the XML files.

  1107 

  1108 XML_DTD                = 

  1109 

  1110 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will 

  1111 # dump the program listings (including syntax highlighting 

  1112 # and cross-referencing information) to the XML output. Note that 

  1113 # enabling this will significantly increase the size of the XML output.

  1114 

  1115 XML_PROGRAMLISTING     = YES

  1116 

   170 GENERATE_AUTOGEN_DEF = NO

  1120 

  1121 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 

  1122 # generate an AutoGen Definitions (see autogen.sf.net) file 

  1123 # that captures the structure of the code including all 

  1124 # documentation. Note that this feature is still experimental 

  1125 # and incomplete at the moment.

  1126 

  1127 GENERATE_AUTOGEN_DEF   = NO

  1128 

   174 GENERATE_PERLMOD = NO

  1132 

   175 PERLMOD_LATEX = NO

  1133 # If the GENERATE_PERLMOD tag is set to YES Doxygen will 

   176 PERLMOD_PRETTY = YES

  1134 # generate a Perl module file that captures the structure of 

  1135 # the code including all documentation. Note that this