sdkcreationmw/sdkexamples/cppexamples/Doxyfiles/Doxyfile
changeset 0 b26acd06ea60
equal deleted inserted replaced
-1:000000000000 0:b26acd06ea60
       
     1 # Doxyfile 1.4.1
       
     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 (" ")
       
    12 
       
    13 #---------------------------------------------------------------------------
       
    14 # Project related configuration options
       
    15 #---------------------------------------------------------------------------
       
    16 
       
    17 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
       
    18 # by quotes) that should identify the project.
       
    19 
       
    20 PROJECT_NAME           =
       
    21 
       
    22 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
       
    23 # This could be handy for archiving the generated documentation or
       
    24 # if some version control system is used.
       
    25 
       
    26 PROJECT_NUMBER         =
       
    27 
       
    28 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
       
    29 # base path where the generated documentation will be put.
       
    30 # If a relative path is entered, it will be relative to the location
       
    31 # where doxygen was started. If left blank the current directory will be used.
       
    32 
       
    33 OUTPUT_DIRECTORY       =
       
    34 
       
    35 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
       
    36 # 4096 sub-directories (in 2 levels) under the output directory of each output
       
    37 # format and will distribute the generated files over these directories.
       
    38 # Enabling this option can be useful when feeding doxygen a huge amount of
       
    39 # source files, where putting all generated files in the same directory would
       
    40 # otherwise cause performance problems for the file system.
       
    41 
       
    42 CREATE_SUBDIRS         = NO
       
    43 
       
    44 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
       
    45 # documentation generated by doxygen is written. Doxygen will use this
       
    46 # information to generate all constant output in the proper language.
       
    47 # The default language is English, other supported languages are:
       
    48 # Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish,
       
    49 # Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese,
       
    50 # Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian,
       
    51 # Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish,
       
    52 # Swedish, and Ukrainian.
       
    53 
       
    54 OUTPUT_LANGUAGE        = English
       
    55 
       
    56 # This tag can be used to specify the encoding used in the generated output.
       
    57 # The encoding is not always determined by the language that is chosen,
       
    58 # but also whether or not the output is meant for Windows or non-Windows users.
       
    59 # In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES
       
    60 # forces the Windows encoding (this is the default for the Windows binary),
       
    61 # whereas setting the tag to NO uses a Unix-style encoding (the default for
       
    62 # all platforms other than Windows).
       
    63 
       
    64 USE_WINDOWS_ENCODING   = YES
       
    65 
       
    66 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
       
    67 # include brief member descriptions after the members that are listed in
       
    68 # the file and class documentation (similar to JavaDoc).
       
    69 # Set to NO to disable this.
       
    70 
       
    71 BRIEF_MEMBER_DESC      = YES
       
    72 
       
    73 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
       
    74 # the brief description of a member or function before the detailed description.
       
    75 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
       
    76 # brief descriptions will be completely suppressed.
       
    77 
       
    78 REPEAT_BRIEF           = YES
       
    79 
       
    80 # This tag implements a quasi-intelligent brief description abbreviator
       
    81 # that is used to form the text in various listings. Each string
       
    82 # in this list, if found as the leading text of the brief description, will be
       
    83 # stripped from the text and the result after processing the whole list, is
       
    84 # used as the annotated text. Otherwise, the brief description is used as-is.
       
    85 # If left blank, the following values are used ("$name" is automatically
       
    86 # replaced with the name of the entity): "The $name class" "The $name widget"
       
    87 # "The $name file" "is" "provides" "specifies" "contains"
       
    88 # "represents" "a" "an" "the"
       
    89 
       
    90 ABBREVIATE_BRIEF       =
       
    91 
       
    92 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
       
    93 # Doxygen will generate a detailed section even if there is only a brief
       
    94 # description.
       
    95 
       
    96 ALWAYS_DETAILED_SEC    = NO
       
    97 
       
    98 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
       
    99 # inherited members of a class in the documentation of that class as if those
       
   100 # members were ordinary class members. Constructors, destructors and assignment
       
   101 # operators of the base classes will not be shown.
       
   102 
       
   103 INLINE_INHERITED_MEMB  = YES
       
   104 
       
   105 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
       
   106 # path before files name in the file list and in the header files. If set
       
   107 # to NO the shortest path that makes the file name unique will be used.
       
   108 
       
   109 FULL_PATH_NAMES        = NO
       
   110 
       
   111 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
       
   112 # can be used to strip a user-defined part of the path. Stripping is
       
   113 # only done if one of the specified strings matches the left-hand part of
       
   114 # the path. The tag can be used to show relative paths in the file list.
       
   115 # If left blank the directory from which doxygen is run is used as the
       
   116 # path to strip.
       
   117 
       
   118 STRIP_FROM_PATH        =
       
   119 
       
   120 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
       
   121 # the path mentioned in the documentation of a class, which tells
       
   122 # the reader which header file to include in order to use a class.
       
   123 # If left blank only the name of the header file containing the class
       
   124 # definition is used. Otherwise one should specify the include paths that
       
   125 # are normally passed to the compiler using the -I flag.
       
   126 
       
   127 STRIP_FROM_INC_PATH    =
       
   128 
       
   129 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
       
   130 # (but less readable) file names. This can be useful is your file systems
       
   131 # doesn't support long names like on DOS, Mac, or CD-ROM.
       
   132 
       
   133 SHORT_NAMES            = NO
       
   134 
       
   135 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
       
   136 # will interpret the first line (until the first dot) of a JavaDoc-style
       
   137 # comment as the brief description. If set to NO, the JavaDoc
       
   138 # comments will behave just like the Qt-style comments (thus requiring an
       
   139 # explicit @brief command for a brief description.
       
   140 
       
   141 JAVADOC_AUTOBRIEF      = NO
       
   142 
       
   143 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
       
   144 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
       
   145 # comments) as a brief description. This used to be the default behaviour.
       
   146 # The new default is to treat a multi-line C++ comment block as a detailed
       
   147 # description. Set this tag to YES if you prefer the old behaviour instead.
       
   148 
       
   149 MULTILINE_CPP_IS_BRIEF = NO
       
   150 
       
   151 # If the DETAILS_AT_TOP tag is set to YES then Doxygen
       
   152 # will output the detailed description near the top, like JavaDoc.
       
   153 # If set to NO, the detailed description appears after the member
       
   154 # documentation.
       
   155 
       
   156 DETAILS_AT_TOP         = YES
       
   157 
       
   158 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
       
   159 # member inherits the documentation from any documented member that it
       
   160 # re-implements.
       
   161 
       
   162 INHERIT_DOCS           = YES
       
   163 
       
   164 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
       
   165 # tag is set to YES, then doxygen will reuse the documentation of the first
       
   166 # member in the group (if any) for the other members of the group. By default
       
   167 # all members of a group must be documented explicitly.
       
   168 
       
   169 DISTRIBUTE_GROUP_DOC   = NO
       
   170 
       
   171 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
       
   172 # Doxygen uses this value to replace tabs by spaces in code fragments.
       
   173 
       
   174 TAB_SIZE               = 8
       
   175 
       
   176 # This tag can be used to specify a number of aliases that acts
       
   177 # as commands in the documentation. An alias has the form "name=value".
       
   178 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
       
   179 # put the command \sideeffect (or @sideeffect) in the documentation, which
       
   180 # will result in a user-defined paragraph with heading "Side Effects:".
       
   181 # You can put \n's in the value part of an alias to insert newlines.
       
   182 
       
   183 ALIASES                =
       
   184 
       
   185 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
       
   186 # sources only. Doxygen will then generate output that is more tailored for C.
       
   187 # For instance, some of the names that are used will be different. The list
       
   188 # of all members will be omitted, etc.
       
   189 
       
   190 OPTIMIZE_OUTPUT_FOR_C  = NO
       
   191 
       
   192 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
       
   193 # only. Doxygen will then generate output that is more tailored for Java.
       
   194 # For instance, namespaces will be presented as packages, qualified scopes
       
   195 # will look different, etc.
       
   196 
       
   197 OPTIMIZE_OUTPUT_JAVA   = NO
       
   198 
       
   199 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
       
   200 # the same type (for instance a group of public functions) to be put as a
       
   201 # subgroup of that type (e.g. under the Public Functions section). Set it to
       
   202 # NO to prevent subgrouping. Alternatively, this can be done per class using
       
   203 # the \nosubgrouping command.
       
   204 
       
   205 SUBGROUPING            = YES
       
   206 
       
   207 #---------------------------------------------------------------------------
       
   208 # Build related configuration options
       
   209 #---------------------------------------------------------------------------
       
   210 
       
   211 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
       
   212 # documentation are documented, even if no documentation was available.
       
   213 # Private class members and static file members will be hidden unless
       
   214 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
       
   215 
       
   216 EXTRACT_ALL            = NO
       
   217 
       
   218 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
       
   219 # will be included in the documentation.
       
   220 
       
   221 EXTRACT_PRIVATE        = YES
       
   222 
       
   223 # If the EXTRACT_STATIC tag is set to YES all static members of a file
       
   224 # will be included in the documentation.
       
   225 
       
   226 EXTRACT_STATIC         = YES
       
   227 
       
   228 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
       
   229 # defined locally in source files will be included in the documentation.
       
   230 # If set to NO only classes defined in header files are included.
       
   231 
       
   232 EXTRACT_LOCAL_CLASSES  = YES
       
   233 
       
   234 # This flag is only useful for Objective-C code. When set to YES local
       
   235 # methods, which are defined in the implementation section but not in
       
   236 # the interface are included in the documentation.
       
   237 # If set to NO (the default) only methods in the interface are included.
       
   238 
       
   239 EXTRACT_LOCAL_METHODS  = NO
       
   240 
       
   241 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
       
   242 # undocumented members of documented classes, files or namespaces.
       
   243 # If set to NO (the default) these members will be included in the
       
   244 # various overviews, but no documentation section is generated.
       
   245 # This option has no effect if EXTRACT_ALL is enabled.
       
   246 
       
   247 HIDE_UNDOC_MEMBERS     = NO
       
   248 
       
   249 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
       
   250 # undocumented classes that are normally visible in the class hierarchy.
       
   251 # If set to NO (the default) these classes will be included in the various
       
   252 # overviews. This option has no effect if EXTRACT_ALL is enabled.
       
   253 
       
   254 HIDE_UNDOC_CLASSES     = NO
       
   255 
       
   256 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
       
   257 # friend (class|struct|union) declarations.
       
   258 # If set to NO (the default) these declarations will be included in the
       
   259 # documentation.
       
   260 
       
   261 HIDE_FRIEND_COMPOUNDS  = NO
       
   262 
       
   263 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
       
   264 # documentation blocks found inside the body of a function.
       
   265 # If set to NO (the default) these blocks will be appended to the
       
   266 # function's detailed documentation block.
       
   267 
       
   268 HIDE_IN_BODY_DOCS      = NO
       
   269 
       
   270 # The INTERNAL_DOCS tag determines if documentation
       
   271 # that is typed after a \internal command is included. If the tag is set
       
   272 # to NO (the default) then the documentation will be excluded.
       
   273 # Set it to YES to include the internal documentation.
       
   274 
       
   275 INTERNAL_DOCS          = NO
       
   276 
       
   277 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
       
   278 # file names in lower-case letters. If set to YES upper-case letters are also
       
   279 # allowed. This is useful if you have classes or files whose names only differ
       
   280 # in case and if your file system supports case sensitive file names. Windows
       
   281 # and Mac users are advised to set this option to NO.
       
   282 
       
   283 CASE_SENSE_NAMES       = NO
       
   284 
       
   285 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
       
   286 # will show members with their full class and namespace scopes in the
       
   287 # documentation. If set to YES the scope will be hidden.
       
   288 
       
   289 HIDE_SCOPE_NAMES       = NO
       
   290 
       
   291 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
       
   292 # will put a list of the files that are included by a file in the documentation
       
   293 # of that file.
       
   294 
       
   295 SHOW_INCLUDE_FILES     = YES
       
   296 
       
   297 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
       
   298 # is inserted in the documentation for inline members.
       
   299 
       
   300 INLINE_INFO            = YES
       
   301 
       
   302 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
       
   303 # will sort the (detailed) documentation of file and class members
       
   304 # alphabetically by member name. If set to NO the members will appear in
       
   305 # declaration order.
       
   306 
       
   307 SORT_MEMBER_DOCS       = NO
       
   308 
       
   309 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
       
   310 # brief documentation of file, namespace and class members alphabetically
       
   311 # by member name. If set to NO (the default) the members will appear in
       
   312 # declaration order.
       
   313 
       
   314 SORT_BRIEF_DOCS        = NO
       
   315 
       
   316 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
       
   317 # sorted by fully-qualified names, including namespaces. If set to
       
   318 # NO (the default), the class list will be sorted only by class name,
       
   319 # not including the namespace part.
       
   320 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
       
   321 # Note: This option applies only to the class list, not to the
       
   322 # alphabetical list.
       
   323 
       
   324 SORT_BY_SCOPE_NAME     = NO
       
   325 
       
   326 # The GENERATE_TODOLIST tag can be used to enable (YES) or
       
   327 # disable (NO) the todo list. This list is created by putting \todo
       
   328 # commands in the documentation.
       
   329 
       
   330 GENERATE_TODOLIST      = YES
       
   331 
       
   332 # The GENERATE_TESTLIST tag can be used to enable (YES) or
       
   333 # disable (NO) the test list. This list is created by putting \test
       
   334 # commands in the documentation.
       
   335 
       
   336 GENERATE_TESTLIST      = NO
       
   337 
       
   338 # The GENERATE_BUGLIST tag can be used to enable (YES) or
       
   339 # disable (NO) the bug list. This list is created by putting \bug
       
   340 # commands in the documentation.
       
   341 
       
   342 GENERATE_BUGLIST       = NO
       
   343 
       
   344 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
       
   345 # disable (NO) the deprecated list. This list is created by putting
       
   346 # \deprecated commands in the documentation.
       
   347 
       
   348 GENERATE_DEPRECATEDLIST= YES
       
   349 
       
   350 # The ENABLED_SECTIONS tag can be used to enable conditional
       
   351 # documentation sections, marked by \if sectionname ... \endif.
       
   352 
       
   353 ENABLED_SECTIONS       =
       
   354 
       
   355 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
       
   356 # the initial value of a variable or define consists of for it to appear in
       
   357 # the documentation. If the initializer consists of more lines than specified
       
   358 # here it will be hidden. Use a value of 0 to hide initializers completely.
       
   359 # The appearance of the initializer of individual variables and defines in the
       
   360 # documentation can be controlled using \showinitializer or \hideinitializer
       
   361 # command in the documentation regardless of this setting.
       
   362 
       
   363 MAX_INITIALIZER_LINES  = 30
       
   364 
       
   365 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
       
   366 # at the bottom of the documentation of classes and structs. If set to YES the
       
   367 # list will mention the files that were used to generate the documentation.
       
   368 
       
   369 SHOW_USED_FILES        = YES
       
   370 
       
   371 # If the sources in your project are distributed over multiple directories
       
   372 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
       
   373 # in the documentation.
       
   374 
       
   375 SHOW_DIRECTORIES       = NO
       
   376 
       
   377 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
       
   378 # doxygen should invoke to get the current version for each file (typically from the
       
   379 # version control system). Doxygen will invoke the program by executing (via
       
   380 # popen()) the command <command> <input-file>, where <command> is the value of
       
   381 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
       
   382 # provided by doxygen. Whatever the progam writes to standard output
       
   383 # is used as the file version. See the manual for examples.
       
   384 
       
   385 FILE_VERSION_FILTER    =
       
   386 
       
   387 #---------------------------------------------------------------------------
       
   388 # configuration options related to warning and progress messages
       
   389 #---------------------------------------------------------------------------
       
   390 
       
   391 # The QUIET tag can be used to turn on/off the messages that are generated
       
   392 # by doxygen. Possible values are YES and NO. If left blank NO is used.
       
   393 
       
   394 QUIET                  = YES
       
   395 
       
   396 # The WARNINGS tag can be used to turn on/off the warning messages that are
       
   397 # generated by doxygen. Possible values are YES and NO. If left blank
       
   398 # NO is used.
       
   399 
       
   400 WARNINGS               = YES
       
   401 
       
   402 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
       
   403 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
       
   404 # automatically be disabled.
       
   405 
       
   406 WARN_IF_UNDOCUMENTED   = NO
       
   407 
       
   408 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
       
   409 # potential errors in the documentation, such as not documenting some
       
   410 # parameters in a documented function, or documenting parameters that
       
   411 # don't exist or using markup commands wrongly.
       
   412 
       
   413 WARN_IF_DOC_ERROR      = YES
       
   414 
       
   415 # This WARN_NO_PARAMDOC option can be abled to get warnings for
       
   416 # functions that are documented, but have no documentation for their parameters
       
   417 # or return value. If set to NO (the default) doxygen will only warn about
       
   418 # wrong or incomplete parameter documentation, but not about the absence of
       
   419 # documentation.
       
   420 
       
   421 WARN_NO_PARAMDOC       = NO
       
   422 
       
   423 # The WARN_FORMAT tag determines the format of the warning messages that
       
   424 # doxygen can produce. The string should contain the $file, $line, and $text
       
   425 # tags, which will be replaced by the file and line number from which the
       
   426 # warning originated and the warning text. Optionally the format may contain
       
   427 # $version, which will be replaced by the version of the file (if it could
       
   428 # be obtained via FILE_VERSION_FILTER)
       
   429 
       
   430 WARN_FORMAT            = "$file:$line: $text"
       
   431 
       
   432 # The WARN_LOGFILE tag can be used to specify a file to which warning
       
   433 # and error messages should be written. If left blank the output is written
       
   434 # to stderr.
       
   435 
       
   436 WARN_LOGFILE           =
       
   437 
       
   438 #---------------------------------------------------------------------------
       
   439 # configuration options related to the input files
       
   440 #---------------------------------------------------------------------------
       
   441 
       
   442 # The INPUT tag can be used to specify the files and/or directories that contain
       
   443 # documented source files. You may enter file names like "myfile.cpp" or
       
   444 # directories like "/usr/src/myproject". Separate the files or directories
       
   445 # with spaces.
       
   446 
       
   447 INPUT                  =
       
   448 
       
   449 # If the value of the INPUT tag contains directories, you can use the
       
   450 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
       
   451 # and *.h) to filter out the source-files in the directories. If left
       
   452 # blank the following patterns are tested:
       
   453 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
       
   454 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm
       
   455 
       
   456 FILE_PATTERNS          = *.c *.cpp *.h *.hrh *.pan *.mmp *.dox
       
   457 
       
   458 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
       
   459 # should be searched for input files as well. Possible values are YES and NO.
       
   460 # If left blank NO is used.
       
   461 
       
   462 RECURSIVE              = YES
       
   463 
       
   464 # The EXCLUDE tag can be used to specify files and/or directories that should
       
   465 # excluded from the INPUT source files. This way you can easily exclude a
       
   466 # subdirectory from a directory tree whose root is specified with the INPUT tag.
       
   467 
       
   468 EXCLUDE                =
       
   469 
       
   470 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
       
   471 # directories that are symbolic links (a Unix filesystem feature) are excluded
       
   472 # from the input.
       
   473 
       
   474 EXCLUDE_SYMLINKS       = NO
       
   475 
       
   476 # If the value of the INPUT tag contains directories, you can use the
       
   477 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
       
   478 # certain files from those directories.
       
   479 
       
   480 EXCLUDE_PATTERNS       =
       
   481 
       
   482 # The EXAMPLE_PATH tag can be used to specify one or more files or
       
   483 # directories that contain example code fragments that are included (see
       
   484 # the \include command).
       
   485 
       
   486 EXAMPLE_PATH           =
       
   487 
       
   488 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
       
   489 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
       
   490 # and *.h) to filter out the source-files in the directories. If left
       
   491 # blank all files are included.
       
   492 
       
   493 EXAMPLE_PATTERNS       =
       
   494 
       
   495 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
       
   496 # searched for input files to be used with the \include or \dontinclude
       
   497 # commands irrespective of the value of the RECURSIVE tag.
       
   498 # Possible values are YES and NO. If left blank NO is used.
       
   499 
       
   500 EXAMPLE_RECURSIVE      = NO
       
   501 
       
   502 # The IMAGE_PATH tag can be used to specify one or more files or
       
   503 # directories that contain image that are included in the documentation (see
       
   504 # the \image command).
       
   505 
       
   506 IMAGE_PATH             =
       
   507 
       
   508 # The INPUT_FILTER tag can be used to specify a program that doxygen should
       
   509 # invoke to filter for each input file. Doxygen will invoke the filter program
       
   510 # by executing (via popen()) the command <filter> <input-file>, where <filter>
       
   511 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
       
   512 # input file. Doxygen will then use the output that the filter program writes
       
   513 # to standard output.  If FILTER_PATTERNS is specified, this tag will be
       
   514 # ignored.
       
   515 
       
   516 INPUT_FILTER           =
       
   517 
       
   518 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
       
   519 # basis.  Doxygen will compare the file name with each pattern and apply the
       
   520 # filter if there is a match.  The filters are a list of the form:
       
   521 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
       
   522 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
       
   523 # is applied to all files.
       
   524 
       
   525 FILTER_PATTERNS        =
       
   526 
       
   527 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
       
   528 # INPUT_FILTER) will be used to filter the input files when producing source
       
   529 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
       
   530 
       
   531 FILTER_SOURCE_FILES    = NO
       
   532 
       
   533 #---------------------------------------------------------------------------
       
   534 # configuration options related to source browsing
       
   535 #---------------------------------------------------------------------------
       
   536 
       
   537 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
       
   538 # be generated. Documented entities will be cross-referenced with these sources.
       
   539 # Note: To get rid of all source code in the generated output, make sure also
       
   540 # VERBATIM_HEADERS is set to NO.
       
   541 
       
   542 SOURCE_BROWSER         = YES
       
   543 
       
   544 # Setting the INLINE_SOURCES tag to YES will include the body
       
   545 # of functions and classes directly in the documentation.
       
   546 
       
   547 INLINE_SOURCES         = YES
       
   548 
       
   549 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
       
   550 # doxygen to hide any special comment blocks from generated source code
       
   551 # fragments. Normal C and C++ comments will always remain visible.
       
   552 
       
   553 STRIP_CODE_COMMENTS    = NO
       
   554 
       
   555 # If the REFERENCED_BY_RELATION tag is set to YES (the default)
       
   556 # then for each documented function all documented
       
   557 # functions referencing it will be listed.
       
   558 
       
   559 REFERENCED_BY_RELATION = YES
       
   560 
       
   561 # If the REFERENCES_RELATION tag is set to YES (the default)
       
   562 # then for each documented function all documented entities
       
   563 # called/used by that function will be listed.
       
   564 
       
   565 REFERENCES_RELATION    = YES
       
   566 
       
   567 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
       
   568 # will generate a verbatim copy of the header file for each class for
       
   569 # which an include is specified. Set to NO to disable this.
       
   570 
       
   571 VERBATIM_HEADERS       = NO
       
   572 
       
   573 #---------------------------------------------------------------------------
       
   574 # configuration options related to the alphabetical class index
       
   575 #---------------------------------------------------------------------------
       
   576 
       
   577 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
       
   578 # of all compounds will be generated. Enable this if the project
       
   579 # contains a lot of classes, structs, unions or interfaces.
       
   580 
       
   581 ALPHABETICAL_INDEX     = NO
       
   582 
       
   583 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
       
   584 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
       
   585 # in which this list will be split (can be a number in the range [1..20])
       
   586 
       
   587 COLS_IN_ALPHA_INDEX    = 5
       
   588 
       
   589 # In case all classes in a project start with a common prefix, all
       
   590 # classes will be put under the same header in the alphabetical index.
       
   591 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
       
   592 # should be ignored while generating the index headers.
       
   593 
       
   594 IGNORE_PREFIX          =
       
   595 
       
   596 #---------------------------------------------------------------------------
       
   597 # configuration options related to the HTML output
       
   598 #---------------------------------------------------------------------------
       
   599 
       
   600 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
       
   601 # generate HTML output.
       
   602 
       
   603 GENERATE_HTML          = YES
       
   604 
       
   605 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
       
   606 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
       
   607 # put in front of it. If left blank `html' will be used as the default path.
       
   608 
       
   609 HTML_OUTPUT            = doc
       
   610 
       
   611 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
       
   612 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
       
   613 # doxygen will generate files with .html extension.
       
   614 
       
   615 HTML_FILE_EXTENSION    = .html
       
   616 
       
   617 # The HTML_HEADER tag can be used to specify a personal HTML header for
       
   618 # each generated HTML page. If it is left blank doxygen will generate a
       
   619 # standard header.
       
   620 
       
   621 HTML_HEADER            = \Series60SDK_dev\ExamplesCpp\Doxyfiles\header.html
       
   622 
       
   623 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
       
   624 # each generated HTML page. If it is left blank doxygen will generate a
       
   625 # standard footer.
       
   626 
       
   627 HTML_FOOTER            = \Series60SDK_dev\ExamplesCpp\Doxyfiles\footer.html
       
   628 
       
   629 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
       
   630 # style sheet that is used by each HTML page. It can be used to
       
   631 # fine-tune the look of the HTML output. If the tag is left blank doxygen
       
   632 # will generate a default style sheet. Note that doxygen will try to copy
       
   633 # the style sheet file to the HTML output directory, so don't put your own
       
   634 # stylesheet in the HTML output directory as well, or it will be erased!
       
   635 
       
   636 HTML_STYLESHEET        =   \Series60SDK_dev\ExamplesCpp\Doxyfiles\style.css
       
   637 
       
   638 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
       
   639 # files or namespaces will be aligned in HTML using tables. If set to
       
   640 # NO a bullet list will be used.
       
   641 
       
   642 HTML_ALIGN_MEMBERS     = YES
       
   643 
       
   644 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
       
   645 # will be generated that can be used as input for tools like the
       
   646 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
       
   647 # of the generated HTML documentation.
       
   648 
       
   649 GENERATE_HTMLHELP      = NO
       
   650 
       
   651 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
       
   652 # be used to specify the file name of the resulting .chm file. You
       
   653 # can add a path in front of the file if the result should not be
       
   654 # written to the html output directory.
       
   655 
       
   656 CHM_FILE               =
       
   657 
       
   658 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
       
   659 # be used to specify the location (absolute path including file name) of
       
   660 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
       
   661 # the HTML help compiler on the generated index.hhp.
       
   662 
       
   663 HHC_LOCATION           =
       
   664 
       
   665 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
       
   666 # controls if a separate .chi index file is generated (YES) or that
       
   667 # it should be included in the master .chm file (NO).
       
   668 
       
   669 GENERATE_CHI           = NO
       
   670 
       
   671 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
       
   672 # controls whether a binary table of contents is generated (YES) or a
       
   673 # normal table of contents (NO) in the .chm file.
       
   674 
       
   675 BINARY_TOC             = NO
       
   676 
       
   677 # The TOC_EXPAND flag can be set to YES to add extra items for group members
       
   678 # to the contents of the HTML help documentation and to the tree view.
       
   679 
       
   680 TOC_EXPAND             = NO
       
   681 
       
   682 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
       
   683 # top of each HTML page. The value NO (the default) enables the index and
       
   684 # the value YES disables it.
       
   685 
       
   686 DISABLE_INDEX          = NO
       
   687 
       
   688 # This tag can be used to set the number of enum values (range [1..20])
       
   689 # that doxygen will group on one line in the generated HTML documentation.
       
   690 
       
   691 ENUM_VALUES_PER_LINE   = 4
       
   692 
       
   693 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
       
   694 # generated containing a tree-like index structure (just like the one that
       
   695 # is generated for HTML Help). For this to work a browser that supports
       
   696 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
       
   697 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
       
   698 # probably better off using the HTML help feature.
       
   699 
       
   700 GENERATE_TREEVIEW      = NO
       
   701 
       
   702 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
       
   703 # used to set the initial width (in pixels) of the frame in which the tree
       
   704 # is shown.
       
   705 
       
   706 TREEVIEW_WIDTH         = 250
       
   707 
       
   708 #---------------------------------------------------------------------------
       
   709 # configuration options related to the LaTeX output
       
   710 #---------------------------------------------------------------------------
       
   711 
       
   712 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
       
   713 # generate Latex output.
       
   714 
       
   715 GENERATE_LATEX         = NO
       
   716 
       
   717 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
       
   718 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
       
   719 # put in front of it. If left blank `latex' will be used as the default path.
       
   720 
       
   721 LATEX_OUTPUT           = latex
       
   722 
       
   723 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
       
   724 # invoked. If left blank `latex' will be used as the default command name.
       
   725 
       
   726 LATEX_CMD_NAME         = latex
       
   727 
       
   728 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
       
   729 # generate index for LaTeX. If left blank `makeindex' will be used as the
       
   730 # default command name.
       
   731 
       
   732 MAKEINDEX_CMD_NAME     = makeindex
       
   733 
       
   734 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
       
   735 # LaTeX documents. This may be useful for small projects and may help to
       
   736 # save some trees in general.
       
   737 
       
   738 COMPACT_LATEX          = NO
       
   739 
       
   740 # The PAPER_TYPE tag can be used to set the paper type that is used
       
   741 # by the printer. Possible values are: a4, a4wide, letter, legal and
       
   742 # executive. If left blank a4wide will be used.
       
   743 
       
   744 PAPER_TYPE             = a4wide
       
   745 
       
   746 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
       
   747 # packages that should be included in the LaTeX output.
       
   748 
       
   749 EXTRA_PACKAGES         =
       
   750 
       
   751 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
       
   752 # the generated latex document. The header should contain everything until
       
   753 # the first chapter. If it is left blank doxygen will generate a
       
   754 # standard header. Notice: only use this tag if you know what you are doing!
       
   755 
       
   756 LATEX_HEADER           =
       
   757 
       
   758 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
       
   759 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
       
   760 # contain links (just like the HTML output) instead of page references
       
   761 # This makes the output suitable for online browsing using a pdf viewer.
       
   762 
       
   763 PDF_HYPERLINKS         = NO
       
   764 
       
   765 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
       
   766 # plain latex in the generated Makefile. Set this option to YES to get a
       
   767 # higher quality PDF documentation.
       
   768 
       
   769 USE_PDFLATEX           = NO
       
   770 
       
   771 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
       
   772 # command to the generated LaTeX files. This will instruct LaTeX to keep
       
   773 # running if errors occur, instead of asking the user for help.
       
   774 # This option is also used when generating formulas in HTML.
       
   775 
       
   776 LATEX_BATCHMODE        = NO
       
   777 
       
   778 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
       
   779 # include the index chapters (such as File Index, Compound Index, etc.)
       
   780 # in the output.
       
   781 
       
   782 LATEX_HIDE_INDICES     = NO
       
   783 
       
   784 #---------------------------------------------------------------------------
       
   785 # configuration options related to the RTF output
       
   786 #---------------------------------------------------------------------------
       
   787 
       
   788 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
       
   789 # The RTF output is optimized for Word 97 and may not look very pretty with
       
   790 # other RTF readers or editors.
       
   791 
       
   792 GENERATE_RTF           = NO
       
   793 
       
   794 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
       
   795 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
       
   796 # put in front of it. If left blank `rtf' will be used as the default path.
       
   797 
       
   798 RTF_OUTPUT             = rtf
       
   799 
       
   800 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
       
   801 # RTF documents. This may be useful for small projects and may help to
       
   802 # save some trees in general.
       
   803 
       
   804 COMPACT_RTF            = NO
       
   805 
       
   806 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
       
   807 # will contain hyperlink fields. The RTF file will
       
   808 # contain links (just like the HTML output) instead of page references.
       
   809 # This makes the output suitable for online browsing using WORD or other
       
   810 # programs which support those fields.
       
   811 # Note: wordpad (write) and others do not support links.
       
   812 
       
   813 RTF_HYPERLINKS         = NO
       
   814 
       
   815 # Load stylesheet definitions from file. Syntax is similar to doxygen's
       
   816 # config file, i.e. a series of assignments. You only have to provide
       
   817 # replacements, missing definitions are set to their default value.
       
   818 
       
   819 RTF_STYLESHEET_FILE    =
       
   820 
       
   821 # Set optional variables used in the generation of an rtf document.
       
   822 # Syntax is similar to doxygen's config file.
       
   823 
       
   824 RTF_EXTENSIONS_FILE    =
       
   825 
       
   826 #---------------------------------------------------------------------------
       
   827 # configuration options related to the man page output
       
   828 #---------------------------------------------------------------------------
       
   829 
       
   830 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
       
   831 # generate man pages
       
   832 
       
   833 GENERATE_MAN           = NO
       
   834 
       
   835 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
       
   836 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
       
   837 # put in front of it. If left blank `man' will be used as the default path.
       
   838 
       
   839 MAN_OUTPUT             = man
       
   840 
       
   841 # The MAN_EXTENSION tag determines the extension that is added to
       
   842 # the generated man pages (default is the subroutine's section .3)
       
   843 
       
   844 MAN_EXTENSION          = .3
       
   845 
       
   846 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
       
   847 # then it will generate one additional man file for each entity
       
   848 # documented in the real man page(s). These additional files
       
   849 # only source the real man page, but without them the man command
       
   850 # would be unable to find the correct page. The default is NO.
       
   851 
       
   852 MAN_LINKS              = NO
       
   853 
       
   854 #---------------------------------------------------------------------------
       
   855 # configuration options related to the XML output
       
   856 #---------------------------------------------------------------------------
       
   857 
       
   858 # If the GENERATE_XML tag is set to YES Doxygen will
       
   859 # generate an XML file that captures the structure of
       
   860 # the code including all documentation.
       
   861 
       
   862 GENERATE_XML           = NO
       
   863 
       
   864 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
       
   865 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
       
   866 # put in front of it. If left blank `xml' will be used as the default path.
       
   867 
       
   868 XML_OUTPUT             = xml
       
   869 
       
   870 # The XML_SCHEMA tag can be used to specify an XML schema,
       
   871 # which can be used by a validating XML parser to check the
       
   872 # syntax of the XML files.
       
   873 
       
   874 XML_SCHEMA             =
       
   875 
       
   876 # The XML_DTD tag can be used to specify an XML DTD,
       
   877 # which can be used by a validating XML parser to check the
       
   878 # syntax of the XML files.
       
   879 
       
   880 XML_DTD                =
       
   881 
       
   882 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
       
   883 # dump the program listings (including syntax highlighting
       
   884 # and cross-referencing information) to the XML output. Note that
       
   885 # enabling this will significantly increase the size of the XML output.
       
   886 
       
   887 XML_PROGRAMLISTING     = YES
       
   888 
       
   889 #---------------------------------------------------------------------------
       
   890 # configuration options for the AutoGen Definitions output
       
   891 #---------------------------------------------------------------------------
       
   892 
       
   893 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
       
   894 # generate an AutoGen Definitions (see autogen.sf.net) file
       
   895 # that captures the structure of the code including all
       
   896 # documentation. Note that this feature is still experimental
       
   897 # and incomplete at the moment.
       
   898 
       
   899 GENERATE_AUTOGEN_DEF   = NO
       
   900 
       
   901 #---------------------------------------------------------------------------
       
   902 # configuration options related to the Perl module output
       
   903 #---------------------------------------------------------------------------
       
   904 
       
   905 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
       
   906 # generate a Perl module file that captures the structure of
       
   907 # the code including all documentation. Note that this
       
   908 # feature is still experimental and incomplete at the
       
   909 # moment.
       
   910 
       
   911 GENERATE_PERLMOD       = NO
       
   912 
       
   913 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
       
   914 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
       
   915 # to generate PDF and DVI output from the Perl module output.
       
   916 
       
   917 PERLMOD_LATEX          = NO
       
   918 
       
   919 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
       
   920 # nicely formatted so it can be parsed by a human reader.  This is useful
       
   921 # if you want to understand what is going on.  On the other hand, if this
       
   922 # tag is set to NO the size of the Perl module output will be much smaller
       
   923 # and Perl will parse it just the same.
       
   924 
       
   925 PERLMOD_PRETTY         = YES
       
   926 
       
   927 # The names of the make variables in the generated doxyrules.make file
       
   928 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
       
   929 # This is useful so different doxyrules.make files included by the same
       
   930 # Makefile don't overwrite each other's variables.
       
   931 
       
   932 PERLMOD_MAKEVAR_PREFIX =
       
   933 
       
   934 #---------------------------------------------------------------------------
       
   935 # Configuration options related to the preprocessor
       
   936 #---------------------------------------------------------------------------
       
   937 
       
   938 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
       
   939 # evaluate all C-preprocessor directives found in the sources and include
       
   940 # files.
       
   941 
       
   942 ENABLE_PREPROCESSING   = YES
       
   943 
       
   944 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
       
   945 # names in the source code. If set to NO (the default) only conditional
       
   946 # compilation will be performed. Macro expansion can be done in a controlled
       
   947 # way by setting EXPAND_ONLY_PREDEF to YES.
       
   948 
       
   949 MACRO_EXPANSION        = NO
       
   950 
       
   951 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
       
   952 # then the macro expansion is limited to the macros specified with the
       
   953 # PREDEFINED and EXPAND_AS_PREDEFINED tags.
       
   954 
       
   955 EXPAND_ONLY_PREDEF     = NO
       
   956 
       
   957 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
       
   958 # in the INCLUDE_PATH (see below) will be search if a #include is found.
       
   959 
       
   960 SEARCH_INCLUDES        = YES
       
   961 
       
   962 # The INCLUDE_PATH tag can be used to specify one or more directories that
       
   963 # contain include files that are not input files but should be processed by
       
   964 # the preprocessor.
       
   965 
       
   966 INCLUDE_PATH           =
       
   967 
       
   968 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
       
   969 # patterns (like *.h and *.hpp) to filter out the header-files in the
       
   970 # directories. If left blank, the patterns specified with FILE_PATTERNS will
       
   971 # be used.
       
   972 
       
   973 INCLUDE_FILE_PATTERNS  =
       
   974 
       
   975 # The PREDEFINED tag can be used to specify one or more macro names that
       
   976 # are defined before the preprocessor is started (similar to the -D option of
       
   977 # gcc). The argument of the tag is a list of macros of the form: name
       
   978 # or name=definition (no spaces). If the definition and the = are
       
   979 # omitted =1 is assumed. To prevent a macro definition from being
       
   980 # undefined via #undef or recursively expanded use the := operator
       
   981 # instead of the = operator.
       
   982 
       
   983 PREDEFINED             =
       
   984 
       
   985 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
       
   986 # this tag can be used to specify a list of macro names that should be expanded.
       
   987 # The macro definition that is found in the sources will be used.
       
   988 # Use the PREDEFINED tag if you want to use a different macro definition.
       
   989 
       
   990 EXPAND_AS_DEFINED      =
       
   991 
       
   992 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
       
   993 # doxygen's preprocessor will remove all function-like macros that are alone
       
   994 # on a line, have an all uppercase name, and do not end with a semicolon. Such
       
   995 # function macros are typically used for boiler-plate code, and will confuse
       
   996 # the parser if not removed.
       
   997 
       
   998 SKIP_FUNCTION_MACROS   = YES
       
   999 
       
  1000 #---------------------------------------------------------------------------
       
  1001 # Configuration::additions related to external references
       
  1002 #---------------------------------------------------------------------------
       
  1003 
       
  1004 # The TAGFILES option can be used to specify one or more tagfiles.
       
  1005 # Optionally an initial location of the external documentation
       
  1006 # can be added for each tagfile. The format of a tag file without
       
  1007 # this location is as follows:
       
  1008 #   TAGFILES = file1 file2 ...
       
  1009 # Adding location for the tag files is done as follows:
       
  1010 #   TAGFILES = file1=loc1 "file2 = loc2" ...
       
  1011 # where "loc1" and "loc2" can be relative or absolute paths or
       
  1012 # URLs. If a location is present for each tag, the installdox tool
       
  1013 # does not have to be run to correct the links.
       
  1014 # Note that each tag file must have a unique name
       
  1015 # (where the name does NOT include the path)
       
  1016 # If a tag file is not located in the directory in which doxygen
       
  1017 # is run, you must also specify the path to the tagfile here.
       
  1018 
       
  1019 TAGFILES               =
       
  1020 
       
  1021 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
       
  1022 # a tag file that is based on the input files it reads.
       
  1023 
       
  1024 GENERATE_TAGFILE       =
       
  1025 
       
  1026 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
       
  1027 # in the class index. If set to NO only the inherited external classes
       
  1028 # will be listed.
       
  1029 
       
  1030 ALLEXTERNALS           = NO
       
  1031 
       
  1032 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
       
  1033 # in the modules index. If set to NO, only the current project's groups will
       
  1034 # be listed.
       
  1035 
       
  1036 EXTERNAL_GROUPS        = YES
       
  1037 
       
  1038 # The PERL_PATH should be the absolute path and name of the perl script
       
  1039 # interpreter (i.e. the result of `which perl').
       
  1040 
       
  1041 PERL_PATH              = /usr/bin/perl
       
  1042 
       
  1043 #---------------------------------------------------------------------------
       
  1044 # Configuration options related to the dot tool
       
  1045 #---------------------------------------------------------------------------
       
  1046 
       
  1047 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
       
  1048 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
       
  1049 # or super classes. Setting the tag to NO turns the diagrams off. Note that
       
  1050 # this option is superseded by the HAVE_DOT option below. This is only a
       
  1051 # fallback. It is recommended to install and use dot, since it yields more
       
  1052 # powerful graphs.
       
  1053 
       
  1054 CLASS_DIAGRAMS         = YES
       
  1055 
       
  1056 # If set to YES, the inheritance and collaboration graphs will hide
       
  1057 # inheritance and usage relations if the target is undocumented
       
  1058 # or is not a class.
       
  1059 
       
  1060 HIDE_UNDOC_RELATIONS   = NO
       
  1061 
       
  1062 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
       
  1063 # available from the path. This tool is part of Graphviz, a graph visualization
       
  1064 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
       
  1065 # have no effect if this option is set to NO (the default)
       
  1066 
       
  1067 HAVE_DOT               = NO
       
  1068 
       
  1069 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
       
  1070 # will generate a graph for each documented class showing the direct and
       
  1071 # indirect inheritance relations. Setting this tag to YES will force the
       
  1072 # the CLASS_DIAGRAMS tag to NO.
       
  1073 
       
  1074 CLASS_GRAPH            = NO
       
  1075 
       
  1076 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
       
  1077 # will generate a graph for each documented class showing the direct and
       
  1078 # indirect implementation dependencies (inheritance, containment, and
       
  1079 # class references variables) of the class with other documented classes.
       
  1080 
       
  1081 COLLABORATION_GRAPH    = NO
       
  1082 
       
  1083 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
       
  1084 # will generate a graph for groups, showing the direct groups dependencies
       
  1085 
       
  1086 GROUP_GRAPHS           = YES
       
  1087 
       
  1088 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
       
  1089 # collaboration diagrams in a style similar to the OMG's Unified Modeling
       
  1090 # Language.
       
  1091 
       
  1092 UML_LOOK               = YES
       
  1093 
       
  1094 # If set to YES, the inheritance and collaboration graphs will show the
       
  1095 # relations between templates and their instances.
       
  1096 
       
  1097 TEMPLATE_RELATIONS     = YES
       
  1098 
       
  1099 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
       
  1100 # tags are set to YES then doxygen will generate a graph for each documented
       
  1101 # file showing the direct and indirect include dependencies of the file with
       
  1102 # other documented files.
       
  1103 
       
  1104 INCLUDE_GRAPH          = YES
       
  1105 
       
  1106 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
       
  1107 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
       
  1108 # documented header file showing the documented files that directly or
       
  1109 # indirectly include this file.
       
  1110 
       
  1111 INCLUDED_BY_GRAPH      = YES
       
  1112 
       
  1113 # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
       
  1114 # generate a call dependency graph for every global function or class method.
       
  1115 # Note that enabling this option will significantly increase the time of a run.
       
  1116 # So in most cases it will be better to enable call graphs for selected
       
  1117 # functions only using the \callgraph command.
       
  1118 
       
  1119 CALL_GRAPH             = NO
       
  1120 
       
  1121 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
       
  1122 # will graphical hierarchy of all classes instead of a textual one.
       
  1123 
       
  1124 GRAPHICAL_HIERARCHY    = YES
       
  1125 
       
  1126 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
       
  1127 # then doxygen will show the dependencies a directory has on other directories
       
  1128 # in a graphical way. The dependency relations are determined by the #include
       
  1129 # relations between the files in the directories.
       
  1130 
       
  1131 DIRECTORY_GRAPH        = YES
       
  1132 
       
  1133 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
       
  1134 # generated by dot. Possible values are png, jpg, or gif
       
  1135 # If left blank png will be used.
       
  1136 
       
  1137 DOT_IMAGE_FORMAT       = png
       
  1138 
       
  1139 # The tag DOT_PATH can be used to specify the path where the dot tool can be
       
  1140 # found. If left blank, it is assumed the dot tool can be found in the path.
       
  1141 
       
  1142 DOT_PATH               =
       
  1143 
       
  1144 # The DOTFILE_DIRS tag can be used to specify one or more directories that
       
  1145 # contain dot files that are included in the documentation (see the
       
  1146 # \dotfile command).
       
  1147 
       
  1148 DOTFILE_DIRS           =
       
  1149 
       
  1150 # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
       
  1151 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
       
  1152 # this value, doxygen will try to truncate the graph, so that it fits within
       
  1153 # the specified constraint. Beware that most browsers cannot cope with very
       
  1154 # large images.
       
  1155 
       
  1156 MAX_DOT_GRAPH_WIDTH    = 1024
       
  1157 
       
  1158 # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
       
  1159 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
       
  1160 # this value, doxygen will try to truncate the graph, so that it fits within
       
  1161 # the specified constraint. Beware that most browsers cannot cope with very
       
  1162 # large images.
       
  1163 
       
  1164 MAX_DOT_GRAPH_HEIGHT   = 1024
       
  1165 
       
  1166 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
       
  1167 # graphs generated by dot. A depth value of 3 means that only nodes reachable
       
  1168 # from the root by following a path via at most 3 edges will be shown. Nodes
       
  1169 # that lay further from the root node will be omitted. Note that setting this
       
  1170 # option to 1 or 2 may greatly reduce the computation time needed for large
       
  1171 # code bases. Also note that a graph may be further truncated if the graph's
       
  1172 # image dimensions are not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH
       
  1173 # and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the depth value (the default),
       
  1174 # the graph is not depth-constrained.
       
  1175 
       
  1176 MAX_DOT_GRAPH_DEPTH    = 0
       
  1177 
       
  1178 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
       
  1179 # background. This is disabled by default, which results in a white background.
       
  1180 # Warning: Depending on the platform used, enabling this option may lead to
       
  1181 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
       
  1182 # read).
       
  1183 
       
  1184 DOT_TRANSPARENT        = NO
       
  1185 
       
  1186 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
       
  1187 # files in one run (i.e. multiple -o and -T options on the command line). This
       
  1188 # makes dot run faster, but since only newer versions of dot (>1.8.10)
       
  1189 # support this, this feature is disabled by default.
       
  1190 
       
  1191 DOT_MULTI_TARGETS      = NO
       
  1192 
       
  1193 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
       
  1194 # generate a legend page explaining the meaning of the various boxes and
       
  1195 # arrows in the dot generated graphs.
       
  1196 
       
  1197 GENERATE_LEGEND        = NO
       
  1198 
       
  1199 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
       
  1200 # remove the intermediate dot files that are used to generate
       
  1201 # the various graphs.
       
  1202 
       
  1203 DOT_CLEANUP            = YES
       
  1204 
       
  1205 #---------------------------------------------------------------------------
       
  1206 # Configuration::additions related to the search engine
       
  1207 #---------------------------------------------------------------------------
       
  1208 
       
  1209 # The SEARCHENGINE tag specifies whether or not a search engine should be
       
  1210 # used. If set to NO the values of all tags below this one will be ignored.
       
  1211 
       
  1212 SEARCHENGINE           = NO