[22] | 1 | # Doxyfile 1.8.4
|
---|
| 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 | # This tag specifies the encoding used for all characters in the config file
|
---|
| 18 | # that follow. The default is UTF-8 which is also the encoding used for all
|
---|
| 19 | # text before the first occurrence of this tag. Doxygen uses libiconv (or the
|
---|
| 20 | # iconv built into libc) for the transcoding. See
|
---|
| 21 | # http://www.gnu.org/software/libiconv for the list of possible encodings.
|
---|
| 22 |
|
---|
| 23 | DOXYFILE_ENCODING = UTF-8
|
---|
| 24 |
|
---|
| 25 | # The PROJECT_NAME tag is a single word (or sequence of words) that should
|
---|
| 26 | # identify the project. Note that if you do not use Doxywizard you need
|
---|
| 27 | # to put quotes around the project name if it contains spaces.
|
---|
| 28 |
|
---|
| 29 | PROJECT_NAME = Flair
|
---|
| 30 |
|
---|
| 31 | # The PROJECT_NUMBER tag can be used to enter a project or revision number.
|
---|
| 32 | # This could be handy for archiving the generated documentation or
|
---|
| 33 | # if some version control system is used.
|
---|
| 34 |
|
---|
| 35 | PROJECT_NUMBER =
|
---|
| 36 |
|
---|
| 37 | # Using the PROJECT_BRIEF tag one can provide an optional one line description
|
---|
| 38 | # for a project that appears at the top of each page and should give viewer
|
---|
| 39 | # a quick idea about the purpose of the project. Keep the description short.
|
---|
| 40 |
|
---|
| 41 | PROJECT_BRIEF = "Framework Libre Air"
|
---|
| 42 |
|
---|
| 43 | # With the PROJECT_LOGO tag one can specify an logo or icon that is
|
---|
| 44 | # included in the documentation. The maximum height of the logo should not
|
---|
| 45 | # exceed 55 pixels and the maximum width should not exceed 200 pixels.
|
---|
| 46 | # Doxygen will copy the logo to the output directory.
|
---|
| 47 |
|
---|
| 48 | PROJECT_LOGO = $(FLAIR_ROOT)/flair-src/lib/logo_hds.png
|
---|
| 49 |
|
---|
| 50 | # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
|
---|
| 51 | # base path where the generated documentation will be put.
|
---|
| 52 | # If a relative path is entered, it will be relative to the location
|
---|
| 53 | # where doxygen was started. If left blank the current directory will be used.
|
---|
| 54 |
|
---|
| 55 | OUTPUT_DIRECTORY = $(FLAIR_ROOT)/flair-dev/doc
|
---|
| 56 |
|
---|
| 57 | # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
|
---|
| 58 | # 4096 sub-directories (in 2 levels) under the output directory of each output
|
---|
| 59 | # format and will distribute the generated files over these directories.
|
---|
| 60 | # Enabling this option can be useful when feeding doxygen a huge amount of
|
---|
| 61 | # source files, where putting all generated files in the same directory would
|
---|
| 62 | # otherwise cause performance problems for the file system.
|
---|
| 63 |
|
---|
| 64 | CREATE_SUBDIRS = NO
|
---|
| 65 |
|
---|
| 66 | # The OUTPUT_LANGUAGE tag is used to specify the language in which all
|
---|
| 67 | # documentation generated by doxygen is written. Doxygen will use this
|
---|
| 68 | # information to generate all constant output in the proper language.
|
---|
| 69 | # The default language is English, other supported languages are:
|
---|
| 70 | # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
|
---|
| 71 | # Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
|
---|
| 72 | # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
|
---|
| 73 | # messages), Korean, Korean-en, Latvian, Lithuanian, Norwegian, Macedonian,
|
---|
| 74 | # Persian, Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic,
|
---|
| 75 | # Slovak, Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
|
---|
| 76 |
|
---|
| 77 | OUTPUT_LANGUAGE = English
|
---|
| 78 |
|
---|
| 79 | # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
|
---|
| 80 | # include brief member descriptions after the members that are listed in
|
---|
| 81 | # the file and class documentation (similar to JavaDoc).
|
---|
| 82 | # Set to NO to disable this.
|
---|
| 83 |
|
---|
| 84 | BRIEF_MEMBER_DESC = YES
|
---|
| 85 |
|
---|
| 86 | # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
|
---|
| 87 | # the brief description of a member or function before the detailed description.
|
---|
| 88 | # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
|
---|
| 89 | # brief descriptions will be completely suppressed.
|
---|
| 90 |
|
---|
| 91 | REPEAT_BRIEF = YES
|
---|
| 92 |
|
---|
| 93 | # This tag implements a quasi-intelligent brief description abbreviator
|
---|
| 94 | # that is used to form the text in various listings. Each string
|
---|
| 95 | # in this list, if found as the leading text of the brief description, will be
|
---|
| 96 | # stripped from the text and the result after processing the whole list, is
|
---|
| 97 | # used as the annotated text. Otherwise, the brief description is used as-is.
|
---|
| 98 | # If left blank, the following values are used ("$name" is automatically
|
---|
| 99 | # replaced with the name of the entity): "The $name class" "The $name widget"
|
---|
| 100 | # "The $name file" "is" "provides" "specifies" "contains"
|
---|
| 101 | # "represents" "a" "an" "the"
|
---|
| 102 |
|
---|
| 103 | ABBREVIATE_BRIEF = "The $name class" \
|
---|
| 104 | "The $name widget" \
|
---|
| 105 | "The $name file" \
|
---|
| 106 | is \
|
---|
| 107 | provides \
|
---|
| 108 | specifies \
|
---|
| 109 | contains \
|
---|
| 110 | represents \
|
---|
| 111 | a \
|
---|
| 112 | an \
|
---|
| 113 | the
|
---|
| 114 |
|
---|
| 115 | # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
|
---|
| 116 | # Doxygen will generate a detailed section even if there is only a brief
|
---|
| 117 | # description.
|
---|
| 118 |
|
---|
| 119 | ALWAYS_DETAILED_SEC = YES
|
---|
| 120 |
|
---|
| 121 | # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
|
---|
| 122 | # inherited members of a class in the documentation of that class as if those
|
---|
| 123 | # members were ordinary class members. Constructors, destructors and assignment
|
---|
| 124 | # operators of the base classes will not be shown.
|
---|
| 125 |
|
---|
| 126 | INLINE_INHERITED_MEMB = NO
|
---|
| 127 |
|
---|
| 128 | # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
|
---|
| 129 | # path before files name in the file list and in the header files. If set
|
---|
| 130 | # to NO the shortest path that makes the file name unique will be used.
|
---|
| 131 |
|
---|
| 132 | FULL_PATH_NAMES = NO
|
---|
| 133 |
|
---|
| 134 | # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
|
---|
| 135 | # can be used to strip a user-defined part of the path. Stripping is
|
---|
| 136 | # only done if one of the specified strings matches the left-hand part of
|
---|
| 137 | # the path. The tag can be used to show relative paths in the file list.
|
---|
| 138 | # If left blank the directory from which doxygen is run is used as the
|
---|
| 139 | # path to strip. Note that you specify absolute paths here, but also
|
---|
| 140 | # relative paths, which will be relative from the directory where doxygen is
|
---|
| 141 | # started.
|
---|
| 142 |
|
---|
| 143 | STRIP_FROM_PATH =
|
---|
| 144 |
|
---|
| 145 | # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
|
---|
| 146 | # the path mentioned in the documentation of a class, which tells
|
---|
| 147 | # the reader which header file to include in order to use a class.
|
---|
| 148 | # If left blank only the name of the header file containing the class
|
---|
| 149 | # definition is used. Otherwise one should specify the include paths that
|
---|
| 150 | # are normally passed to the compiler using the -I flag.
|
---|
| 151 |
|
---|
| 152 | STRIP_FROM_INC_PATH =
|
---|
| 153 |
|
---|
| 154 | # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
|
---|
| 155 | # (but less readable) file names. This can be useful if your file system
|
---|
| 156 | # doesn't support long names like on DOS, Mac, or CD-ROM.
|
---|
| 157 |
|
---|
| 158 | SHORT_NAMES = NO
|
---|
| 159 |
|
---|
| 160 | # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
|
---|
| 161 | # will interpret the first line (until the first dot) of a JavaDoc-style
|
---|
| 162 | # comment as the brief description. If set to NO, the JavaDoc
|
---|
| 163 | # comments will behave just like regular Qt-style comments
|
---|
| 164 | # (thus requiring an explicit @brief command for a brief description.)
|
---|
| 165 |
|
---|
| 166 | JAVADOC_AUTOBRIEF = NO
|
---|
| 167 |
|
---|
| 168 | # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
|
---|
| 169 | # interpret the first line (until the first dot) of a Qt-style
|
---|
| 170 | # comment as the brief description. If set to NO, the comments
|
---|
| 171 | # will behave just like regular Qt-style comments (thus requiring
|
---|
| 172 | # an explicit \brief command for a brief description.)
|
---|
| 173 |
|
---|
| 174 | QT_AUTOBRIEF = NO
|
---|
| 175 |
|
---|
| 176 | # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
|
---|
| 177 | # treat a multi-line C++ special comment block (i.e. a block of //! or ///
|
---|
| 178 | # comments) as a brief description. This used to be the default behaviour.
|
---|
| 179 | # The new default is to treat a multi-line C++ comment block as a detailed
|
---|
| 180 | # description. Set this tag to YES if you prefer the old behaviour instead.
|
---|
| 181 |
|
---|
| 182 | MULTILINE_CPP_IS_BRIEF = NO
|
---|
| 183 |
|
---|
| 184 | # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
|
---|
| 185 | # member inherits the documentation from any documented member that it
|
---|
| 186 | # re-implements.
|
---|
| 187 |
|
---|
| 188 | INHERIT_DOCS = YES
|
---|
| 189 |
|
---|
| 190 | # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
|
---|
| 191 | # a new page for each member. If set to NO, the documentation of a member will
|
---|
| 192 | # be part of the file/class/namespace that contains it.
|
---|
| 193 |
|
---|
| 194 | SEPARATE_MEMBER_PAGES = NO
|
---|
| 195 |
|
---|
| 196 | # The TAB_SIZE tag can be used to set the number of spaces in a tab.
|
---|
| 197 | # Doxygen uses this value to replace tabs by spaces in code fragments.
|
---|
| 198 |
|
---|
| 199 | TAB_SIZE = 8
|
---|
| 200 |
|
---|
| 201 | # This tag can be used to specify a number of aliases that acts
|
---|
| 202 | # as commands in the documentation. An alias has the form "name=value".
|
---|
| 203 | # For example adding "sideeffect=\par Side Effects:\n" will allow you to
|
---|
| 204 | # put the command \sideeffect (or @sideeffect) in the documentation, which
|
---|
| 205 | # will result in a user-defined paragraph with heading "Side Effects:".
|
---|
| 206 | # You can put \n's in the value part of an alias to insert newlines.
|
---|
| 207 |
|
---|
| 208 | ALIASES =
|
---|
| 209 |
|
---|
| 210 | # This tag can be used to specify a number of word-keyword mappings (TCL only).
|
---|
| 211 | # A mapping has the form "name=value". For example adding
|
---|
| 212 | # "class=itcl::class" will allow you to use the command class in the
|
---|
| 213 | # itcl::class meaning.
|
---|
| 214 |
|
---|
| 215 | TCL_SUBST =
|
---|
| 216 |
|
---|
| 217 | # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
|
---|
| 218 | # sources only. Doxygen will then generate output that is more tailored for C.
|
---|
| 219 | # For instance, some of the names that are used will be different. The list
|
---|
| 220 | # of all members will be omitted, etc.
|
---|
| 221 |
|
---|
| 222 | OPTIMIZE_OUTPUT_FOR_C = NO
|
---|
| 223 |
|
---|
| 224 | # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
|
---|
| 225 | # sources only. Doxygen will then generate output that is more tailored for
|
---|
| 226 | # Java. For instance, namespaces will be presented as packages, qualified
|
---|
| 227 | # scopes will look different, etc.
|
---|
| 228 |
|
---|
| 229 | OPTIMIZE_OUTPUT_JAVA = NO
|
---|
| 230 |
|
---|
| 231 | # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
|
---|
| 232 | # sources only. Doxygen will then generate output that is more tailored for
|
---|
| 233 | # Fortran.
|
---|
| 234 |
|
---|
| 235 | OPTIMIZE_FOR_FORTRAN = NO
|
---|
| 236 |
|
---|
| 237 | # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
|
---|
| 238 | # sources. Doxygen will then generate output that is tailored for
|
---|
| 239 | # VHDL.
|
---|
| 240 |
|
---|
| 241 | OPTIMIZE_OUTPUT_VHDL = NO
|
---|
| 242 |
|
---|
| 243 | # Doxygen selects the parser to use depending on the extension of the files it
|
---|
| 244 | # parses. With this tag you can assign which parser to use for a given
|
---|
| 245 | # extension. Doxygen has a built-in mapping, but you can override or extend it
|
---|
| 246 | # using this tag. The format is ext=language, where ext is a file extension,
|
---|
| 247 | # and language is one of the parsers supported by doxygen: IDL, Java,
|
---|
| 248 | # Javascript, CSharp, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL, C,
|
---|
| 249 | # C++. For instance to make doxygen treat .inc files as Fortran files (default
|
---|
| 250 | # is PHP), and .f files as C (default is Fortran), use: inc=Fortran f=C. Note
|
---|
| 251 | # that for custom extensions you also need to set FILE_PATTERNS otherwise the
|
---|
| 252 | # files are not read by doxygen.
|
---|
| 253 |
|
---|
| 254 | EXTENSION_MAPPING =
|
---|
| 255 |
|
---|
| 256 | # If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all
|
---|
| 257 | # comments according to the Markdown format, which allows for more readable
|
---|
| 258 | # documentation. See http://daringfireball.net/projects/markdown/ for details.
|
---|
| 259 | # The output of markdown processing is further processed by doxygen, so you
|
---|
| 260 | # can mix doxygen, HTML, and XML commands with Markdown formatting.
|
---|
| 261 | # Disable only in case of backward compatibilities issues.
|
---|
| 262 |
|
---|
| 263 | MARKDOWN_SUPPORT = YES
|
---|
| 264 |
|
---|
| 265 | # When enabled doxygen tries to link words that correspond to documented
|
---|
| 266 | # classes, or namespaces to their corresponding documentation. Such a link can
|
---|
| 267 | # be prevented in individual cases by by putting a % sign in front of the word
|
---|
| 268 | # or globally by setting AUTOLINK_SUPPORT to NO.
|
---|
| 269 |
|
---|
| 270 | AUTOLINK_SUPPORT = YES
|
---|
| 271 |
|
---|
| 272 | # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
|
---|
| 273 | # to include (a tag file for) the STL sources as input, then you should
|
---|
| 274 | # set this tag to YES in order to let doxygen match functions declarations and
|
---|
| 275 | # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
|
---|
| 276 | # func(std::string) {}). This also makes the inheritance and collaboration
|
---|
| 277 | # diagrams that involve STL classes more complete and accurate.
|
---|
| 278 |
|
---|
| 279 | BUILTIN_STL_SUPPORT = YES
|
---|
| 280 |
|
---|
| 281 | # If you use Microsoft's C++/CLI language, you should set this option to YES to
|
---|
| 282 | # enable parsing support.
|
---|
| 283 |
|
---|
| 284 | CPP_CLI_SUPPORT = NO
|
---|
| 285 |
|
---|
| 286 | # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
|
---|
| 287 | # Doxygen will parse them like normal C++ but will assume all classes use public
|
---|
| 288 | # instead of private inheritance when no explicit protection keyword is present.
|
---|
| 289 |
|
---|
| 290 | SIP_SUPPORT = NO
|
---|
| 291 |
|
---|
| 292 | # For Microsoft's IDL there are propget and propput attributes to indicate
|
---|
| 293 | # getter and setter methods for a property. Setting this option to YES (the
|
---|
| 294 | # default) will make doxygen replace the get and set methods by a property in
|
---|
| 295 | # the documentation. This will only work if the methods are indeed getting or
|
---|
| 296 | # setting a simple type. If this is not the case, or you want to show the
|
---|
| 297 | # methods anyway, you should set this option to NO.
|
---|
| 298 |
|
---|
| 299 | IDL_PROPERTY_SUPPORT = YES
|
---|
| 300 |
|
---|
| 301 | # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
|
---|
| 302 | # tag is set to YES, then doxygen will reuse the documentation of the first
|
---|
| 303 | # member in the group (if any) for the other members of the group. By default
|
---|
| 304 | # all members of a group must be documented explicitly.
|
---|
| 305 |
|
---|
| 306 | DISTRIBUTE_GROUP_DOC = NO
|
---|
| 307 |
|
---|
| 308 | # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
|
---|
| 309 | # the same type (for instance a group of public functions) to be put as a
|
---|
| 310 | # subgroup of that type (e.g. under the Public Functions section). Set it to
|
---|
| 311 | # NO to prevent subgrouping. Alternatively, this can be done per class using
|
---|
| 312 | # the \nosubgrouping command.
|
---|
| 313 |
|
---|
| 314 | SUBGROUPING = YES
|
---|
| 315 |
|
---|
| 316 | # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and
|
---|
| 317 | # unions are shown inside the group in which they are included (e.g. using
|
---|
| 318 | # @ingroup) instead of on a separate page (for HTML and Man pages) or
|
---|
| 319 | # section (for LaTeX and RTF).
|
---|
| 320 |
|
---|
| 321 | INLINE_GROUPED_CLASSES = NO
|
---|
| 322 |
|
---|
| 323 | # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and
|
---|
| 324 | # unions with only public data fields or simple typedef fields will be shown
|
---|
| 325 | # inline in the documentation of the scope in which they are defined (i.e. file,
|
---|
| 326 | # namespace, or group documentation), provided this scope is documented. If set
|
---|
| 327 | # to NO (the default), structs, classes, and unions are shown on a separate
|
---|
| 328 | # page (for HTML and Man pages) or section (for LaTeX and RTF).
|
---|
| 329 |
|
---|
| 330 | INLINE_SIMPLE_STRUCTS = NO
|
---|
| 331 |
|
---|
| 332 | # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
|
---|
| 333 | # is documented as struct, union, or enum with the name of the typedef. So
|
---|
| 334 | # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
|
---|
| 335 | # with name TypeT. When disabled the typedef will appear as a member of a file,
|
---|
| 336 | # namespace, or class. And the struct will be named TypeS. This can typically
|
---|
| 337 | # be useful for C code in case the coding convention dictates that all compound
|
---|
| 338 | # types are typedef'ed and only the typedef is referenced, never the tag name.
|
---|
| 339 |
|
---|
| 340 | TYPEDEF_HIDES_STRUCT = NO
|
---|
| 341 |
|
---|
| 342 | # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
|
---|
| 343 | # cache is used to resolve symbols given their name and scope. Since this can
|
---|
| 344 | # be an expensive process and often the same symbol appear multiple times in
|
---|
| 345 | # the code, doxygen keeps a cache of pre-resolved symbols. If the cache is too
|
---|
| 346 | # small doxygen will become slower. If the cache is too large, memory is wasted.
|
---|
| 347 | # The cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid
|
---|
| 348 | # range is 0..9, the default is 0, corresponding to a cache size of 2^16 = 65536
|
---|
| 349 | # symbols.
|
---|
| 350 |
|
---|
| 351 | LOOKUP_CACHE_SIZE = 0
|
---|
| 352 |
|
---|
| 353 | #---------------------------------------------------------------------------
|
---|
| 354 | # Build related configuration options
|
---|
| 355 | #---------------------------------------------------------------------------
|
---|
| 356 |
|
---|
| 357 | # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
|
---|
| 358 | # documentation are documented, even if no documentation was available.
|
---|
| 359 | # Private class members and static file members will be hidden unless
|
---|
| 360 | # the EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES
|
---|
| 361 |
|
---|
| 362 | EXTRACT_ALL = NO
|
---|
| 363 |
|
---|
| 364 | # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
|
---|
| 365 | # will be included in the documentation.
|
---|
| 366 |
|
---|
| 367 | EXTRACT_PRIVATE = NO
|
---|
| 368 |
|
---|
| 369 | # If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
|
---|
| 370 | # scope will be included in the documentation.
|
---|
| 371 |
|
---|
| 372 | EXTRACT_PACKAGE = NO
|
---|
| 373 |
|
---|
| 374 | # If the EXTRACT_STATIC tag is set to YES all static members of a file
|
---|
| 375 | # will be included in the documentation.
|
---|
| 376 |
|
---|
| 377 | EXTRACT_STATIC = YES
|
---|
| 378 |
|
---|
| 379 | # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
|
---|
| 380 | # defined locally in source files will be included in the documentation.
|
---|
| 381 | # If set to NO only classes defined in header files are included.
|
---|
| 382 |
|
---|
| 383 | EXTRACT_LOCAL_CLASSES = NO
|
---|
| 384 |
|
---|
| 385 | # This flag is only useful for Objective-C code. When set to YES local
|
---|
| 386 | # methods, which are defined in the implementation section but not in
|
---|
| 387 | # the interface are included in the documentation.
|
---|
| 388 | # If set to NO (the default) only methods in the interface are included.
|
---|
| 389 |
|
---|
| 390 | EXTRACT_LOCAL_METHODS = NO
|
---|
| 391 |
|
---|
| 392 | # If this flag is set to YES, the members of anonymous namespaces will be
|
---|
| 393 | # extracted and appear in the documentation as a namespace called
|
---|
| 394 | # 'anonymous_namespace{file}', where file will be replaced with the base
|
---|
| 395 | # name of the file that contains the anonymous namespace. By default
|
---|
| 396 | # anonymous namespaces are hidden.
|
---|
| 397 |
|
---|
| 398 | EXTRACT_ANON_NSPACES = NO
|
---|
| 399 |
|
---|
| 400 | # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
|
---|
| 401 | # undocumented members of documented classes, files or namespaces.
|
---|
| 402 | # If set to NO (the default) these members will be included in the
|
---|
| 403 | # various overviews, but no documentation section is generated.
|
---|
| 404 | # This option has no effect if EXTRACT_ALL is enabled.
|
---|
| 405 |
|
---|
| 406 | HIDE_UNDOC_MEMBERS = NO
|
---|
| 407 |
|
---|
| 408 | # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
|
---|
| 409 | # undocumented classes that are normally visible in the class hierarchy.
|
---|
| 410 | # If set to NO (the default) these classes will be included in the various
|
---|
| 411 | # overviews. This option has no effect if EXTRACT_ALL is enabled.
|
---|
| 412 |
|
---|
| 413 | HIDE_UNDOC_CLASSES = NO
|
---|
| 414 |
|
---|
| 415 | # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
|
---|
| 416 | # friend (class|struct|union) declarations.
|
---|
| 417 | # If set to NO (the default) these declarations will be included in the
|
---|
| 418 | # documentation.
|
---|
| 419 |
|
---|
| 420 | HIDE_FRIEND_COMPOUNDS = YES
|
---|
| 421 |
|
---|
| 422 | # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
|
---|
| 423 | # documentation blocks found inside the body of a function.
|
---|
| 424 | # If set to NO (the default) these blocks will be appended to the
|
---|
| 425 | # function's detailed documentation block.
|
---|
| 426 |
|
---|
| 427 | HIDE_IN_BODY_DOCS = NO
|
---|
| 428 |
|
---|
| 429 | # The INTERNAL_DOCS tag determines if documentation
|
---|
| 430 | # that is typed after a \internal command is included. If the tag is set
|
---|
| 431 | # to NO (the default) then the documentation will be excluded.
|
---|
| 432 | # Set it to YES to include the internal documentation.
|
---|
| 433 |
|
---|
| 434 | INTERNAL_DOCS = NO
|
---|
| 435 |
|
---|
| 436 | # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
|
---|
| 437 | # file names in lower-case letters. If set to YES upper-case letters are also
|
---|
| 438 | # allowed. This is useful if you have classes or files whose names only differ
|
---|
| 439 | # in case and if your file system supports case sensitive file names. Windows
|
---|
| 440 | # and Mac users are advised to set this option to NO.
|
---|
| 441 |
|
---|
| 442 | CASE_SENSE_NAMES = NO
|
---|
| 443 |
|
---|
| 444 | # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
|
---|
| 445 | # will show members with their full class and namespace scopes in the
|
---|
| 446 | # documentation. If set to YES the scope will be hidden.
|
---|
| 447 |
|
---|
| 448 | HIDE_SCOPE_NAMES = NO
|
---|
| 449 |
|
---|
| 450 | # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
|
---|
| 451 | # will put a list of the files that are included by a file in the documentation
|
---|
| 452 | # of that file.
|
---|
| 453 |
|
---|
| 454 | SHOW_INCLUDE_FILES = YES
|
---|
| 455 |
|
---|
| 456 | # If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
|
---|
| 457 | # will list include files with double quotes in the documentation
|
---|
| 458 | # rather than with sharp brackets.
|
---|
| 459 |
|
---|
| 460 | FORCE_LOCAL_INCLUDES = NO
|
---|
| 461 |
|
---|
| 462 | # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
|
---|
| 463 | # is inserted in the documentation for inline members.
|
---|
| 464 |
|
---|
| 465 | INLINE_INFO = YES
|
---|
| 466 |
|
---|
| 467 | # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
|
---|
| 468 | # will sort the (detailed) documentation of file and class members
|
---|
| 469 | # alphabetically by member name. If set to NO the members will appear in
|
---|
| 470 | # declaration order.
|
---|
| 471 |
|
---|
| 472 | SORT_MEMBER_DOCS = NO
|
---|
| 473 |
|
---|
| 474 | # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
|
---|
| 475 | # brief documentation of file, namespace and class members alphabetically
|
---|
| 476 | # by member name. If set to NO (the default) the members will appear in
|
---|
| 477 | # declaration order.
|
---|
| 478 |
|
---|
| 479 | SORT_BRIEF_DOCS = NO
|
---|
| 480 |
|
---|
| 481 | # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
|
---|
| 482 | # will sort the (brief and detailed) documentation of class members so that
|
---|
| 483 | # constructors and destructors are listed first. If set to NO (the default)
|
---|
| 484 | # the constructors will appear in the respective orders defined by
|
---|
| 485 | # SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
|
---|
| 486 | # This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
|
---|
| 487 | # and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
|
---|
| 488 |
|
---|
| 489 | SORT_MEMBERS_CTORS_1ST = NO
|
---|
| 490 |
|
---|
| 491 | # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
|
---|
| 492 | # hierarchy of group names into alphabetical order. If set to NO (the default)
|
---|
| 493 | # the group names will appear in their defined order.
|
---|
| 494 |
|
---|
| 495 | SORT_GROUP_NAMES = NO
|
---|
| 496 |
|
---|
| 497 | # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
|
---|
| 498 | # sorted by fully-qualified names, including namespaces. If set to
|
---|
| 499 | # NO (the default), the class list will be sorted only by class name,
|
---|
| 500 | # not including the namespace part.
|
---|
| 501 | # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
|
---|
| 502 | # Note: This option applies only to the class list, not to the
|
---|
| 503 | # alphabetical list.
|
---|
| 504 |
|
---|
| 505 | SORT_BY_SCOPE_NAME = NO
|
---|
| 506 |
|
---|
| 507 | # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to
|
---|
| 508 | # do proper type resolution of all parameters of a function it will reject a
|
---|
| 509 | # match between the prototype and the implementation of a member function even
|
---|
| 510 | # if there is only one candidate or it is obvious which candidate to choose
|
---|
| 511 | # by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen
|
---|
| 512 | # will still accept a match between prototype and implementation in such cases.
|
---|
| 513 |
|
---|
| 514 | STRICT_PROTO_MATCHING = NO
|
---|
| 515 |
|
---|
| 516 | # The GENERATE_TODOLIST tag can be used to enable (YES) or
|
---|
| 517 | # disable (NO) the todo list. This list is created by putting \todo
|
---|
| 518 | # commands in the documentation.
|
---|
| 519 |
|
---|
| 520 | GENERATE_TODOLIST = YES
|
---|
| 521 |
|
---|
| 522 | # The GENERATE_TESTLIST tag can be used to enable (YES) or
|
---|
| 523 | # disable (NO) the test list. This list is created by putting \test
|
---|
| 524 | # commands in the documentation.
|
---|
| 525 |
|
---|
| 526 | GENERATE_TESTLIST = YES
|
---|
| 527 |
|
---|
| 528 | # The GENERATE_BUGLIST tag can be used to enable (YES) or
|
---|
| 529 | # disable (NO) the bug list. This list is created by putting \bug
|
---|
| 530 | # commands in the documentation.
|
---|
| 531 |
|
---|
| 532 | GENERATE_BUGLIST = YES
|
---|
| 533 |
|
---|
| 534 | # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
|
---|
| 535 | # disable (NO) the deprecated list. This list is created by putting
|
---|
| 536 | # \deprecated commands in the documentation.
|
---|
| 537 |
|
---|
| 538 | GENERATE_DEPRECATEDLIST= YES
|
---|
| 539 |
|
---|
| 540 | # The ENABLED_SECTIONS tag can be used to enable conditional
|
---|
| 541 | # documentation sections, marked by \if section-label ... \endif
|
---|
| 542 | # and \cond section-label ... \endcond blocks.
|
---|
| 543 |
|
---|
| 544 | ENABLED_SECTIONS =
|
---|
| 545 |
|
---|
| 546 | # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
|
---|
| 547 | # the initial value of a variable or macro consists of for it to appear in
|
---|
| 548 | # the documentation. If the initializer consists of more lines than specified
|
---|
| 549 | # here it will be hidden. Use a value of 0 to hide initializers completely.
|
---|
| 550 | # The appearance of the initializer of individual variables and macros in the
|
---|
| 551 | # documentation can be controlled using \showinitializer or \hideinitializer
|
---|
| 552 | # command in the documentation regardless of this setting.
|
---|
| 553 |
|
---|
| 554 | MAX_INITIALIZER_LINES = 30
|
---|
| 555 |
|
---|
| 556 | # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
|
---|
| 557 | # at the bottom of the documentation of classes and structs. If set to YES the
|
---|
| 558 | # list will mention the files that were used to generate the documentation.
|
---|
| 559 |
|
---|
| 560 | SHOW_USED_FILES = NO
|
---|
| 561 |
|
---|
| 562 | # Set the SHOW_FILES tag to NO to disable the generation of the Files page.
|
---|
| 563 | # This will remove the Files entry from the Quick Index and from the
|
---|
| 564 | # Folder Tree View (if specified). The default is YES.
|
---|
| 565 |
|
---|
| 566 | SHOW_FILES = YES
|
---|
| 567 |
|
---|
| 568 | # Set the SHOW_NAMESPACES tag to NO to disable the generation of the
|
---|
| 569 | # Namespaces page. This will remove the Namespaces entry from the Quick Index
|
---|
| 570 | # and from the Folder Tree View (if specified). The default is YES.
|
---|
| 571 |
|
---|
| 572 | SHOW_NAMESPACES = YES
|
---|
| 573 |
|
---|
| 574 | # The FILE_VERSION_FILTER tag can be used to specify a program or script that
|
---|
| 575 | # doxygen should invoke to get the current version for each file (typically from
|
---|
| 576 | # the version control system). Doxygen will invoke the program by executing (via
|
---|
| 577 | # popen()) the command <command> <input-file>, where <command> is the value of
|
---|
| 578 | # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
|
---|
| 579 | # provided by doxygen. Whatever the program writes to standard output
|
---|
| 580 | # is used as the file version. See the manual for examples.
|
---|
| 581 |
|
---|
| 582 | FILE_VERSION_FILTER =
|
---|
| 583 |
|
---|
| 584 | # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
|
---|
| 585 | # by doxygen. The layout file controls the global structure of the generated
|
---|
| 586 | # output files in an output format independent way. To create the layout file
|
---|
| 587 | # that represents doxygen's defaults, run doxygen with the -l option.
|
---|
| 588 | # You can optionally specify a file name after the option, if omitted
|
---|
| 589 | # DoxygenLayout.xml will be used as the name of the layout file.
|
---|
| 590 |
|
---|
| 591 | LAYOUT_FILE =
|
---|
| 592 |
|
---|
| 593 | # The CITE_BIB_FILES tag can be used to specify one or more bib files
|
---|
| 594 | # containing the references data. This must be a list of .bib files. The
|
---|
| 595 | # .bib extension is automatically appended if omitted. Using this command
|
---|
| 596 | # requires the bibtex tool to be installed. See also
|
---|
| 597 | # http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style
|
---|
| 598 | # of the bibliography can be controlled using LATEX_BIB_STYLE. To use this
|
---|
| 599 | # feature you need bibtex and perl available in the search path. Do not use
|
---|
| 600 | # file names with spaces, bibtex cannot handle them.
|
---|
| 601 |
|
---|
| 602 | CITE_BIB_FILES =
|
---|
| 603 |
|
---|
| 604 | #---------------------------------------------------------------------------
|
---|
| 605 | # configuration options related to warning and progress messages
|
---|
| 606 | #---------------------------------------------------------------------------
|
---|
| 607 |
|
---|
| 608 | # The QUIET tag can be used to turn on/off the messages that are generated
|
---|
| 609 | # by doxygen. Possible values are YES and NO. If left blank NO is used.
|
---|
| 610 |
|
---|
| 611 | QUIET = NO
|
---|
| 612 |
|
---|
| 613 | # The WARNINGS tag can be used to turn on/off the warning messages that are
|
---|
| 614 | # generated by doxygen. Possible values are YES and NO. If left blank
|
---|
| 615 | # NO is used.
|
---|
| 616 |
|
---|
| 617 | WARNINGS = YES
|
---|
| 618 |
|
---|
| 619 | # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
|
---|
| 620 | # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
|
---|
| 621 | # automatically be disabled.
|
---|
| 622 |
|
---|
| 623 | WARN_IF_UNDOCUMENTED = YES
|
---|
| 624 |
|
---|
| 625 | # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
|
---|
| 626 | # potential errors in the documentation, such as not documenting some
|
---|
| 627 | # parameters in a documented function, or documenting parameters that
|
---|
| 628 | # don't exist or using markup commands wrongly.
|
---|
| 629 |
|
---|
| 630 | WARN_IF_DOC_ERROR = YES
|
---|
| 631 |
|
---|
| 632 | # The WARN_NO_PARAMDOC option can be enabled to get warnings for
|
---|
| 633 | # functions that are documented, but have no documentation for their parameters
|
---|
| 634 | # or return value. If set to NO (the default) doxygen will only warn about
|
---|
| 635 | # wrong or incomplete parameter documentation, but not about the absence of
|
---|
| 636 | # documentation.
|
---|
| 637 |
|
---|
| 638 | WARN_NO_PARAMDOC = NO
|
---|
| 639 |
|
---|
| 640 | # The WARN_FORMAT tag determines the format of the warning messages that
|
---|
| 641 | # doxygen can produce. The string should contain the $file, $line, and $text
|
---|
| 642 | # tags, which will be replaced by the file and line number from which the
|
---|
| 643 | # warning originated and the warning text. Optionally the format may contain
|
---|
| 644 | # $version, which will be replaced by the version of the file (if it could
|
---|
| 645 | # be obtained via FILE_VERSION_FILTER)
|
---|
| 646 |
|
---|
| 647 | WARN_FORMAT = "$file:$line: $text"
|
---|
| 648 |
|
---|
| 649 | # The WARN_LOGFILE tag can be used to specify a file to which warning
|
---|
| 650 | # and error messages should be written. If left blank the output is written
|
---|
| 651 | # to stderr.
|
---|
| 652 |
|
---|
| 653 | WARN_LOGFILE =
|
---|
| 654 |
|
---|
| 655 | #---------------------------------------------------------------------------
|
---|
| 656 | # configuration options related to the input files
|
---|
| 657 | #---------------------------------------------------------------------------
|
---|
| 658 |
|
---|
| 659 | # The INPUT tag can be used to specify the files and/or directories that contain
|
---|
| 660 | # documented source files. You may enter file names like "myfile.cpp" or
|
---|
| 661 | # directories like "/usr/src/myproject". Separate the files or directories
|
---|
| 662 | # with spaces.
|
---|
| 663 |
|
---|
| 664 | INPUT = $(FLAIR_ROOT)/flair-src/lib/FlairFilter/src \
|
---|
| 665 | $(FLAIR_ROOT)/flair-src/lib/FlairSensorActuator/src \
|
---|
| 666 | $(FLAIR_ROOT)/flair-src/lib/FlairCore/src \
|
---|
| 667 | $(FLAIR_ROOT)/flair-src/lib/FlairSimulator/src \
|
---|
| 668 | $(FLAIR_ROOT)/flair-src/lib/FlairMeta/src
|
---|
| 669 |
|
---|
| 670 | # This tag can be used to specify the character encoding of the source files
|
---|
| 671 | # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
|
---|
| 672 | # also the default input encoding. Doxygen uses libiconv (or the iconv built
|
---|
| 673 | # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
|
---|
| 674 | # the list of possible encodings.
|
---|
| 675 |
|
---|
| 676 | INPUT_ENCODING = UTF-8
|
---|
| 677 |
|
---|
| 678 | # If the value of the INPUT tag contains directories, you can use the
|
---|
| 679 | # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
|
---|
| 680 | # and *.h) to filter out the source-files in the directories. If left
|
---|
| 681 | # blank the following patterns are tested:
|
---|
| 682 | # *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh
|
---|
| 683 | # *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
|
---|
| 684 | # *.f90 *.f *.for *.vhd *.vhdl
|
---|
| 685 |
|
---|
| 686 | FILE_PATTERNS = *.h \
|
---|
| 687 | *.dox
|
---|
| 688 |
|
---|
| 689 | # The RECURSIVE tag can be used to turn specify whether or not subdirectories
|
---|
| 690 | # should be searched for input files as well. Possible values are YES and NO.
|
---|
| 691 | # If left blank NO is used.
|
---|
| 692 |
|
---|
| 693 | RECURSIVE = NO
|
---|
| 694 |
|
---|
| 695 | # The EXCLUDE tag can be used to specify files and/or directories that should be
|
---|
| 696 | # excluded from the INPUT source files. This way you can easily exclude a
|
---|
| 697 | # subdirectory from a directory tree whose root is specified with the INPUT tag.
|
---|
| 698 | # Note that relative paths are relative to the directory from which doxygen is
|
---|
| 699 | # run.
|
---|
| 700 |
|
---|
| 701 | EXCLUDE =
|
---|
| 702 |
|
---|
| 703 | # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
|
---|
| 704 | # directories that are symbolic links (a Unix file system feature) are excluded
|
---|
| 705 | # from the input.
|
---|
| 706 |
|
---|
| 707 | EXCLUDE_SYMLINKS = NO
|
---|
| 708 |
|
---|
| 709 | # If the value of the INPUT tag contains directories, you can use the
|
---|
| 710 | # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
|
---|
| 711 | # certain files from those directories. Note that the wildcards are matched
|
---|
| 712 | # against the file with absolute path, so to exclude all test directories
|
---|
| 713 | # for example use the pattern */test/*
|
---|
| 714 |
|
---|
| 715 | EXCLUDE_PATTERNS =
|
---|
| 716 |
|
---|
| 717 | # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
|
---|
| 718 | # (namespaces, classes, functions, etc.) that should be excluded from the
|
---|
| 719 | # output. The symbol name can be a fully qualified name, a word, or if the
|
---|
| 720 | # wildcard * is used, a substring. Examples: ANamespace, AClass,
|
---|
| 721 | # AClass::ANamespace, ANamespace::*Test
|
---|
| 722 |
|
---|
| 723 | EXCLUDE_SYMBOLS =
|
---|
| 724 |
|
---|
| 725 | # The EXAMPLE_PATH tag can be used to specify one or more files or
|
---|
| 726 | # directories that contain example code fragments that are included (see
|
---|
| 727 | # the \include command).
|
---|
| 728 |
|
---|
| 729 | EXAMPLE_PATH =
|
---|
| 730 |
|
---|
| 731 | # If the value of the EXAMPLE_PATH tag contains directories, you can use the
|
---|
| 732 | # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
|
---|
| 733 | # and *.h) to filter out the source-files in the directories. If left
|
---|
| 734 | # blank all files are included.
|
---|
| 735 |
|
---|
| 736 | EXAMPLE_PATTERNS = *
|
---|
| 737 |
|
---|
| 738 | # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
|
---|
| 739 | # searched for input files to be used with the \include or \dontinclude
|
---|
| 740 | # commands irrespective of the value of the RECURSIVE tag.
|
---|
| 741 | # Possible values are YES and NO. If left blank NO is used.
|
---|
| 742 |
|
---|
| 743 | EXAMPLE_RECURSIVE = NO
|
---|
| 744 |
|
---|
| 745 | # The IMAGE_PATH tag can be used to specify one or more files or
|
---|
| 746 | # directories that contain image that are included in the documentation (see
|
---|
| 747 | # the \image command).
|
---|
| 748 |
|
---|
| 749 | IMAGE_PATH =
|
---|
| 750 |
|
---|
| 751 | # The INPUT_FILTER tag can be used to specify a program that doxygen should
|
---|
| 752 | # invoke to filter for each input file. Doxygen will invoke the filter program
|
---|
| 753 | # by executing (via popen()) the command <filter> <input-file>, where <filter>
|
---|
| 754 | # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
|
---|
| 755 | # input file. Doxygen will then use the output that the filter program writes
|
---|
| 756 | # to standard output. If FILTER_PATTERNS is specified, this tag will be ignored.
|
---|
| 757 | # Note that the filter must not add or remove lines; it is applied before the
|
---|
| 758 | # code is scanned, but not when the output code is generated. If lines are added
|
---|
| 759 | # or removed, the anchors will not be placed correctly.
|
---|
| 760 |
|
---|
| 761 | INPUT_FILTER =
|
---|
| 762 |
|
---|
| 763 | # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
|
---|
| 764 | # basis. Doxygen will compare the file name with each pattern and apply the
|
---|
| 765 | # filter if there is a match. The filters are a list of the form:
|
---|
| 766 | # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
|
---|
| 767 | # info on how filters are used. If FILTER_PATTERNS is empty or if
|
---|
| 768 | # non of the patterns match the file name, INPUT_FILTER is applied.
|
---|
| 769 |
|
---|
| 770 | FILTER_PATTERNS =
|
---|
| 771 |
|
---|
| 772 | # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
|
---|
| 773 | # INPUT_FILTER) will be used to filter the input files when producing source
|
---|
| 774 | # files to browse (i.e. when SOURCE_BROWSER is set to YES).
|
---|
| 775 |
|
---|
| 776 | FILTER_SOURCE_FILES = NO
|
---|
| 777 |
|
---|
| 778 | # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
|
---|
| 779 | # pattern. A pattern will override the setting for FILTER_PATTERN (if any)
|
---|
| 780 | # and it is also possible to disable source filtering for a specific pattern
|
---|
| 781 | # using *.ext= (so without naming a filter). This option only has effect when
|
---|
| 782 | # FILTER_SOURCE_FILES is enabled.
|
---|
| 783 |
|
---|
| 784 | FILTER_SOURCE_PATTERNS =
|
---|
| 785 |
|
---|
| 786 | # If the USE_MD_FILE_AS_MAINPAGE tag refers to the name of a markdown file that
|
---|
| 787 | # is part of the input, its contents will be placed on the main page
|
---|
| 788 | # (index.html). This can be useful if you have a project on for instance GitHub
|
---|
| 789 | # and want reuse the introduction page also for the doxygen output.
|
---|
| 790 |
|
---|
| 791 | USE_MDFILE_AS_MAINPAGE =
|
---|
| 792 |
|
---|
| 793 | #---------------------------------------------------------------------------
|
---|
| 794 | # configuration options related to source browsing
|
---|
| 795 | #---------------------------------------------------------------------------
|
---|
| 796 |
|
---|
| 797 | # If the SOURCE_BROWSER tag is set to YES then a list of source files will
|
---|
| 798 | # be generated. Documented entities will be cross-referenced with these sources.
|
---|
| 799 | # Note: To get rid of all source code in the generated output, make sure also
|
---|
| 800 | # VERBATIM_HEADERS is set to NO.
|
---|
| 801 |
|
---|
| 802 | SOURCE_BROWSER = NO
|
---|
| 803 |
|
---|
| 804 | # Setting the INLINE_SOURCES tag to YES will include the body
|
---|
| 805 | # of functions and classes directly in the documentation.
|
---|
| 806 |
|
---|
| 807 | INLINE_SOURCES = NO
|
---|
| 808 |
|
---|
| 809 | # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
|
---|
| 810 | # doxygen to hide any special comment blocks from generated source code
|
---|
| 811 | # fragments. Normal C, C++ and Fortran comments will always remain visible.
|
---|
| 812 |
|
---|
| 813 | STRIP_CODE_COMMENTS = YES
|
---|
| 814 |
|
---|
| 815 | # If the REFERENCED_BY_RELATION tag is set to YES
|
---|
| 816 | # then for each documented function all documented
|
---|
| 817 | # functions referencing it will be listed.
|
---|
| 818 |
|
---|
| 819 | REFERENCED_BY_RELATION = NO
|
---|
| 820 |
|
---|
| 821 | # If the REFERENCES_RELATION tag is set to YES
|
---|
| 822 | # then for each documented function all documented entities
|
---|
| 823 | # called/used by that function will be listed.
|
---|
| 824 |
|
---|
| 825 | REFERENCES_RELATION = NO
|
---|
| 826 |
|
---|
| 827 | # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
|
---|
| 828 | # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
|
---|
| 829 | # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
|
---|
| 830 | # link to the source code. Otherwise they will link to the documentation.
|
---|
| 831 |
|
---|
| 832 | REFERENCES_LINK_SOURCE = YES
|
---|
| 833 |
|
---|
| 834 | # If the USE_HTAGS tag is set to YES then the references to source code
|
---|
| 835 | # will point to the HTML generated by the htags(1) tool instead of doxygen
|
---|
| 836 | # built-in source browser. The htags tool is part of GNU's global source
|
---|
| 837 | # tagging system (see http://www.gnu.org/software/global/global.html). You
|
---|
| 838 | # will need version 4.8.6 or higher.
|
---|
| 839 |
|
---|
| 840 | USE_HTAGS = NO
|
---|
| 841 |
|
---|
| 842 | # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
|
---|
| 843 | # will generate a verbatim copy of the header file for each class for
|
---|
| 844 | # which an include is specified. Set to NO to disable this.
|
---|
| 845 |
|
---|
| 846 | VERBATIM_HEADERS = YES
|
---|
| 847 |
|
---|
| 848 | #---------------------------------------------------------------------------
|
---|
| 849 | # configuration options related to the alphabetical class index
|
---|
| 850 | #---------------------------------------------------------------------------
|
---|
| 851 |
|
---|
| 852 | # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
|
---|
| 853 | # of all compounds will be generated. Enable this if the project
|
---|
| 854 | # contains a lot of classes, structs, unions or interfaces.
|
---|
| 855 |
|
---|
| 856 | ALPHABETICAL_INDEX = YES
|
---|
| 857 |
|
---|
| 858 | # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
|
---|
| 859 | # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
|
---|
| 860 | # in which this list will be split (can be a number in the range [1..20])
|
---|
| 861 |
|
---|
| 862 | COLS_IN_ALPHA_INDEX = 5
|
---|
| 863 |
|
---|
| 864 | # In case all classes in a project start with a common prefix, all
|
---|
| 865 | # classes will be put under the same header in the alphabetical index.
|
---|
| 866 | # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
|
---|
| 867 | # should be ignored while generating the index headers.
|
---|
| 868 |
|
---|
| 869 | IGNORE_PREFIX =
|
---|
| 870 |
|
---|
| 871 | #---------------------------------------------------------------------------
|
---|
| 872 | # configuration options related to the HTML output
|
---|
| 873 | #---------------------------------------------------------------------------
|
---|
| 874 |
|
---|
| 875 | # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
|
---|
| 876 | # generate HTML output.
|
---|
| 877 |
|
---|
| 878 | GENERATE_HTML = YES
|
---|
| 879 |
|
---|
| 880 | # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
|
---|
| 881 | # If a relative path is entered the value of OUTPUT_DIRECTORY will be
|
---|
| 882 | # put in front of it. If left blank `html' will be used as the default path.
|
---|
| 883 |
|
---|
| 884 | HTML_OUTPUT = Flair
|
---|
| 885 |
|
---|
| 886 | # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
|
---|
| 887 | # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
|
---|
| 888 | # doxygen will generate files with .html extension.
|
---|
| 889 |
|
---|
| 890 | HTML_FILE_EXTENSION = .html
|
---|
| 891 |
|
---|
| 892 | # The HTML_HEADER tag can be used to specify a personal HTML header for
|
---|
| 893 | # each generated HTML page. If it is left blank doxygen will generate a
|
---|
| 894 | # standard header. Note that when using a custom header you are responsible
|
---|
| 895 | # for the proper inclusion of any scripts and style sheets that doxygen
|
---|
| 896 | # needs, which is dependent on the configuration options used.
|
---|
| 897 | # It is advised to generate a default header using "doxygen -w html
|
---|
| 898 | # header.html footer.html stylesheet.css YourConfigFile" and then modify
|
---|
| 899 | # that header. Note that the header is subject to change so you typically
|
---|
| 900 | # have to redo this when upgrading to a newer version of doxygen or when
|
---|
| 901 | # changing the value of configuration settings such as GENERATE_TREEVIEW!
|
---|
| 902 |
|
---|
| 903 | HTML_HEADER =
|
---|
| 904 |
|
---|
| 905 | # The HTML_FOOTER tag can be used to specify a personal HTML footer for
|
---|
| 906 | # each generated HTML page. If it is left blank doxygen will generate a
|
---|
| 907 | # standard footer.
|
---|
| 908 |
|
---|
| 909 | HTML_FOOTER =
|
---|
| 910 |
|
---|
| 911 | # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
|
---|
| 912 | # style sheet that is used by each HTML page. It can be used to
|
---|
| 913 | # fine-tune the look of the HTML output. If left blank doxygen will
|
---|
| 914 | # generate a default style sheet. Note that it is recommended to use
|
---|
| 915 | # HTML_EXTRA_STYLESHEET instead of this one, as it is more robust and this
|
---|
| 916 | # tag will in the future become obsolete.
|
---|
| 917 |
|
---|
| 918 | HTML_STYLESHEET =
|
---|
| 919 |
|
---|
| 920 | # The HTML_EXTRA_STYLESHEET tag can be used to specify an additional
|
---|
| 921 | # user-defined cascading style sheet that is included after the standard
|
---|
| 922 | # style sheets created by doxygen. Using this option one can overrule
|
---|
| 923 | # certain style aspects. This is preferred over using HTML_STYLESHEET
|
---|
| 924 | # since it does not replace the standard style sheet and is therefor more
|
---|
| 925 | # robust against future updates. Doxygen will copy the style sheet file to
|
---|
| 926 | # the output directory.
|
---|
| 927 |
|
---|
| 928 | HTML_EXTRA_STYLESHEET =
|
---|
| 929 |
|
---|
| 930 | # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
|
---|
| 931 | # other source files which should be copied to the HTML output directory. Note
|
---|
| 932 | # that these files will be copied to the base HTML output directory. Use the
|
---|
| 933 | # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
|
---|
| 934 | # files. In the HTML_STYLESHEET file, use the file name only. Also note that
|
---|
| 935 | # the files will be copied as-is; there are no commands or markers available.
|
---|
| 936 |
|
---|
| 937 | HTML_EXTRA_FILES =
|
---|
| 938 |
|
---|
| 939 | # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
|
---|
| 940 | # Doxygen will adjust the colors in the style sheet and background images
|
---|
| 941 | # according to this color. Hue is specified as an angle on a colorwheel,
|
---|
| 942 | # see http://en.wikipedia.org/wiki/Hue for more information.
|
---|
| 943 | # For instance the value 0 represents red, 60 is yellow, 120 is green,
|
---|
| 944 | # 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
|
---|
| 945 | # The allowed range is 0 to 359.
|
---|
| 946 |
|
---|
| 947 | HTML_COLORSTYLE_HUE = 220
|
---|
| 948 |
|
---|
| 949 | # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
|
---|
| 950 | # the colors in the HTML output. For a value of 0 the output will use
|
---|
| 951 | # grayscales only. A value of 255 will produce the most vivid colors.
|
---|
| 952 |
|
---|
| 953 | HTML_COLORSTYLE_SAT = 100
|
---|
| 954 |
|
---|
| 955 | # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
|
---|
| 956 | # the luminance component of the colors in the HTML output. Values below
|
---|
| 957 | # 100 gradually make the output lighter, whereas values above 100 make
|
---|
| 958 | # the output darker. The value divided by 100 is the actual gamma applied,
|
---|
| 959 | # so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
|
---|
| 960 | # and 100 does not change the gamma.
|
---|
| 961 |
|
---|
| 962 | HTML_COLORSTYLE_GAMMA = 80
|
---|
| 963 |
|
---|
| 964 | # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
|
---|
| 965 | # page will contain the date and time when the page was generated. Setting
|
---|
| 966 | # this to NO can help when comparing the output of multiple runs.
|
---|
| 967 |
|
---|
| 968 | HTML_TIMESTAMP = YES
|
---|
| 969 |
|
---|
| 970 | # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
|
---|
| 971 | # documentation will contain sections that can be hidden and shown after the
|
---|
| 972 | # page has loaded.
|
---|
| 973 |
|
---|
| 974 | HTML_DYNAMIC_SECTIONS = YES
|
---|
| 975 |
|
---|
| 976 | # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of
|
---|
| 977 | # entries shown in the various tree structured indices initially; the user
|
---|
| 978 | # can expand and collapse entries dynamically later on. Doxygen will expand
|
---|
| 979 | # the tree to such a level that at most the specified number of entries are
|
---|
| 980 | # visible (unless a fully collapsed tree already exceeds this amount).
|
---|
| 981 | # So setting the number of entries 1 will produce a full collapsed tree by
|
---|
| 982 | # default. 0 is a special value representing an infinite number of entries
|
---|
| 983 | # and will result in a full expanded tree by default.
|
---|
| 984 |
|
---|
| 985 | HTML_INDEX_NUM_ENTRIES = 100
|
---|
| 986 |
|
---|
| 987 | # If the GENERATE_DOCSET tag is set to YES, additional index files
|
---|
| 988 | # will be generated that can be used as input for Apple's Xcode 3
|
---|
| 989 | # integrated development environment, introduced with OSX 10.5 (Leopard).
|
---|
| 990 | # To create a documentation set, doxygen will generate a Makefile in the
|
---|
| 991 | # HTML output directory. Running make will produce the docset in that
|
---|
| 992 | # directory and running "make install" will install the docset in
|
---|
| 993 | # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
|
---|
| 994 | # it at startup.
|
---|
| 995 | # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
|
---|
| 996 | # for more information.
|
---|
| 997 |
|
---|
| 998 | GENERATE_DOCSET = NO
|
---|
| 999 |
|
---|
| 1000 | # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
|
---|
| 1001 | # feed. A documentation feed provides an umbrella under which multiple
|
---|
| 1002 | # documentation sets from a single provider (such as a company or product suite)
|
---|
| 1003 | # can be grouped.
|
---|
| 1004 |
|
---|
| 1005 | DOCSET_FEEDNAME = "Doxygen generated docs"
|
---|
| 1006 |
|
---|
| 1007 | # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
|
---|
| 1008 | # should uniquely identify the documentation set bundle. This should be a
|
---|
| 1009 | # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
|
---|
| 1010 | # will append .docset to the name.
|
---|
| 1011 |
|
---|
| 1012 | DOCSET_BUNDLE_ID = org.doxygen.Project
|
---|
| 1013 |
|
---|
| 1014 | # When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely
|
---|
| 1015 | # identify the documentation publisher. This should be a reverse domain-name
|
---|
| 1016 | # style string, e.g. com.mycompany.MyDocSet.documentation.
|
---|
| 1017 |
|
---|
| 1018 | DOCSET_PUBLISHER_ID = org.doxygen.Publisher
|
---|
| 1019 |
|
---|
| 1020 | # The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
|
---|
| 1021 |
|
---|
| 1022 | DOCSET_PUBLISHER_NAME = Publisher
|
---|
| 1023 |
|
---|
| 1024 | # If the GENERATE_HTMLHELP tag is set to YES, additional index files
|
---|
| 1025 | # will be generated that can be used as input for tools like the
|
---|
| 1026 | # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
|
---|
| 1027 | # of the generated HTML documentation.
|
---|
| 1028 |
|
---|
| 1029 | GENERATE_HTMLHELP = NO
|
---|
| 1030 |
|
---|
| 1031 | # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
|
---|
| 1032 | # be used to specify the file name of the resulting .chm file. You
|
---|
| 1033 | # can add a path in front of the file if the result should not be
|
---|
| 1034 | # written to the html output directory.
|
---|
| 1035 |
|
---|
| 1036 | CHM_FILE =
|
---|
| 1037 |
|
---|
| 1038 | # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
|
---|
| 1039 | # be used to specify the location (absolute path including file name) of
|
---|
| 1040 | # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
|
---|
| 1041 | # the HTML help compiler on the generated index.hhp.
|
---|
| 1042 |
|
---|
| 1043 | HHC_LOCATION =
|
---|
| 1044 |
|
---|
| 1045 | # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
|
---|
| 1046 | # controls if a separate .chi index file is generated (YES) or that
|
---|
| 1047 | # it should be included in the master .chm file (NO).
|
---|
| 1048 |
|
---|
| 1049 | GENERATE_CHI = NO
|
---|
| 1050 |
|
---|
| 1051 | # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
|
---|
| 1052 | # is used to encode HtmlHelp index (hhk), content (hhc) and project file
|
---|
| 1053 | # content.
|
---|
| 1054 |
|
---|
| 1055 | CHM_INDEX_ENCODING =
|
---|
| 1056 |
|
---|
| 1057 | # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
|
---|
| 1058 | # controls whether a binary table of contents is generated (YES) or a
|
---|
| 1059 | # normal table of contents (NO) in the .chm file.
|
---|
| 1060 |
|
---|
| 1061 | BINARY_TOC = NO
|
---|
| 1062 |
|
---|
| 1063 | # The TOC_EXPAND flag can be set to YES to add extra items for group members
|
---|
| 1064 | # to the contents of the HTML help documentation and to the tree view.
|
---|
| 1065 |
|
---|
| 1066 | TOC_EXPAND = NO
|
---|
| 1067 |
|
---|
| 1068 | # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
|
---|
| 1069 | # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
|
---|
| 1070 | # that can be used as input for Qt's qhelpgenerator to generate a
|
---|
| 1071 | # Qt Compressed Help (.qch) of the generated HTML documentation.
|
---|
| 1072 |
|
---|
| 1073 | GENERATE_QHP = NO
|
---|
| 1074 |
|
---|
| 1075 | # If the QHG_LOCATION tag is specified, the QCH_FILE tag can
|
---|
| 1076 | # be used to specify the file name of the resulting .qch file.
|
---|
| 1077 | # The path specified is relative to the HTML output folder.
|
---|
| 1078 |
|
---|
| 1079 | QCH_FILE =
|
---|
| 1080 |
|
---|
| 1081 | # The QHP_NAMESPACE tag specifies the namespace to use when generating
|
---|
| 1082 | # Qt Help Project output. For more information please see
|
---|
| 1083 | # http://doc.trolltech.com/qthelpproject.html#namespace
|
---|
| 1084 |
|
---|
| 1085 | QHP_NAMESPACE = org.doxygen.Project
|
---|
| 1086 |
|
---|
| 1087 | # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
|
---|
| 1088 | # Qt Help Project output. For more information please see
|
---|
| 1089 | # http://doc.trolltech.com/qthelpproject.html#virtual-folders
|
---|
| 1090 |
|
---|
| 1091 | QHP_VIRTUAL_FOLDER = doc
|
---|
| 1092 |
|
---|
| 1093 | # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
|
---|
| 1094 | # add. For more information please see
|
---|
| 1095 | # http://doc.trolltech.com/qthelpproject.html#custom-filters
|
---|
| 1096 |
|
---|
| 1097 | QHP_CUST_FILTER_NAME =
|
---|
| 1098 |
|
---|
| 1099 | # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
|
---|
| 1100 | # custom filter to add. For more information please see
|
---|
| 1101 | # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
|
---|
| 1102 | # Qt Help Project / Custom Filters</a>.
|
---|
| 1103 |
|
---|
| 1104 | QHP_CUST_FILTER_ATTRS =
|
---|
| 1105 |
|
---|
| 1106 | # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
|
---|
| 1107 | # project's
|
---|
| 1108 | # filter section matches.
|
---|
| 1109 | # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
|
---|
| 1110 | # Qt Help Project / Filter Attributes</a>.
|
---|
| 1111 |
|
---|
| 1112 | QHP_SECT_FILTER_ATTRS =
|
---|
| 1113 |
|
---|
| 1114 | # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
|
---|
| 1115 | # be used to specify the location of Qt's qhelpgenerator.
|
---|
| 1116 | # If non-empty doxygen will try to run qhelpgenerator on the generated
|
---|
| 1117 | # .qhp file.
|
---|
| 1118 |
|
---|
| 1119 | QHG_LOCATION =
|
---|
| 1120 |
|
---|
| 1121 | # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
|
---|
| 1122 | # will be generated, which together with the HTML files, form an Eclipse help
|
---|
| 1123 | # plugin. To install this plugin and make it available under the help contents
|
---|
| 1124 | # menu in Eclipse, the contents of the directory containing the HTML and XML
|
---|
| 1125 | # files needs to be copied into the plugins directory of eclipse. The name of
|
---|
| 1126 | # the directory within the plugins directory should be the same as
|
---|
| 1127 | # the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
|
---|
| 1128 | # the help appears.
|
---|
| 1129 |
|
---|
| 1130 | GENERATE_ECLIPSEHELP = NO
|
---|
| 1131 |
|
---|
| 1132 | # A unique identifier for the eclipse help plugin. When installing the plugin
|
---|
| 1133 | # the directory name containing the HTML and XML files should also have
|
---|
| 1134 | # this name.
|
---|
| 1135 |
|
---|
| 1136 | ECLIPSE_DOC_ID = org.doxygen.Project
|
---|
| 1137 |
|
---|
| 1138 | # The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs)
|
---|
| 1139 | # at top of each HTML page. The value NO (the default) enables the index and
|
---|
| 1140 | # the value YES disables it. Since the tabs have the same information as the
|
---|
| 1141 | # navigation tree you can set this option to NO if you already set
|
---|
| 1142 | # GENERATE_TREEVIEW to YES.
|
---|
| 1143 |
|
---|
| 1144 | DISABLE_INDEX = NO
|
---|
| 1145 |
|
---|
| 1146 | # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
|
---|
| 1147 | # structure should be generated to display hierarchical information.
|
---|
| 1148 | # If the tag value is set to YES, a side panel will be generated
|
---|
| 1149 | # containing a tree-like index structure (just like the one that
|
---|
| 1150 | # is generated for HTML Help). For this to work a browser that supports
|
---|
| 1151 | # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
|
---|
| 1152 | # Windows users are probably better off using the HTML help feature.
|
---|
| 1153 | # Since the tree basically has the same information as the tab index you
|
---|
| 1154 | # could consider to set DISABLE_INDEX to NO when enabling this option.
|
---|
| 1155 |
|
---|
| 1156 | GENERATE_TREEVIEW = YES
|
---|
| 1157 |
|
---|
| 1158 | # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
|
---|
| 1159 | # (range [0,1..20]) that doxygen will group on one line in the generated HTML
|
---|
| 1160 | # documentation. Note that a value of 0 will completely suppress the enum
|
---|
| 1161 | # values from appearing in the overview section.
|
---|
| 1162 |
|
---|
| 1163 | ENUM_VALUES_PER_LINE = 4
|
---|
| 1164 |
|
---|
| 1165 | # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
|
---|
| 1166 | # used to set the initial width (in pixels) of the frame in which the tree
|
---|
| 1167 | # is shown.
|
---|
| 1168 |
|
---|
| 1169 | TREEVIEW_WIDTH = 250
|
---|
| 1170 |
|
---|
| 1171 | # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
|
---|
| 1172 | # links to external symbols imported via tag files in a separate window.
|
---|
| 1173 |
|
---|
| 1174 | EXT_LINKS_IN_WINDOW = YES
|
---|
| 1175 |
|
---|
| 1176 | # Use this tag to change the font size of Latex formulas included
|
---|
| 1177 | # as images in the HTML documentation. The default is 10. Note that
|
---|
| 1178 | # when you change the font size after a successful doxygen run you need
|
---|
| 1179 | # to manually remove any form_*.png images from the HTML output directory
|
---|
| 1180 | # to force them to be regenerated.
|
---|
| 1181 |
|
---|
| 1182 | FORMULA_FONTSIZE = 10
|
---|
| 1183 |
|
---|
| 1184 | # Use the FORMULA_TRANPARENT tag to determine whether or not the images
|
---|
| 1185 | # generated for formulas are transparent PNGs. Transparent PNGs are
|
---|
| 1186 | # not supported properly for IE 6.0, but are supported on all modern browsers.
|
---|
| 1187 | # Note that when changing this option you need to delete any form_*.png files
|
---|
| 1188 | # in the HTML output before the changes have effect.
|
---|
| 1189 |
|
---|
| 1190 | FORMULA_TRANSPARENT = YES
|
---|
| 1191 |
|
---|
| 1192 | # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax
|
---|
| 1193 | # (see http://www.mathjax.org) which uses client side Javascript for the
|
---|
| 1194 | # rendering instead of using prerendered bitmaps. Use this if you do not
|
---|
| 1195 | # have LaTeX installed or if you want to formulas look prettier in the HTML
|
---|
| 1196 | # output. When enabled you may also need to install MathJax separately and
|
---|
| 1197 | # configure the path to it using the MATHJAX_RELPATH option.
|
---|
| 1198 |
|
---|
| 1199 | USE_MATHJAX = NO
|
---|
| 1200 |
|
---|
| 1201 | # When MathJax is enabled you can set the default output format to be used for
|
---|
| 1202 | # the MathJax output. Supported types are HTML-CSS, NativeMML (i.e. MathML) and
|
---|
| 1203 | # SVG. The default value is HTML-CSS, which is slower, but has the best
|
---|
| 1204 | # compatibility.
|
---|
| 1205 |
|
---|
| 1206 | MATHJAX_FORMAT = HTML-CSS
|
---|
| 1207 |
|
---|
| 1208 | # When MathJax is enabled you need to specify the location relative to the
|
---|
| 1209 | # HTML output directory using the MATHJAX_RELPATH option. The destination
|
---|
| 1210 | # directory should contain the MathJax.js script. For instance, if the mathjax
|
---|
| 1211 | # directory is located at the same level as the HTML output directory, then
|
---|
| 1212 | # MATHJAX_RELPATH should be ../mathjax. The default value points to
|
---|
| 1213 | # the MathJax Content Delivery Network so you can quickly see the result without
|
---|
| 1214 | # installing MathJax. However, it is strongly recommended to install a local
|
---|
| 1215 | # copy of MathJax from http://www.mathjax.org before deployment.
|
---|
| 1216 |
|
---|
| 1217 | MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
|
---|
| 1218 |
|
---|
| 1219 | # The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension
|
---|
| 1220 | # names that should be enabled during MathJax rendering.
|
---|
| 1221 |
|
---|
| 1222 | MATHJAX_EXTENSIONS =
|
---|
| 1223 |
|
---|
| 1224 | # The MATHJAX_CODEFILE tag can be used to specify a file with javascript
|
---|
| 1225 | # pieces of code that will be used on startup of the MathJax code.
|
---|
| 1226 |
|
---|
| 1227 | MATHJAX_CODEFILE =
|
---|
| 1228 |
|
---|
| 1229 | # When the SEARCHENGINE tag is enabled doxygen will generate a search box
|
---|
| 1230 | # for the HTML output. The underlying search engine uses javascript
|
---|
| 1231 | # and DHTML and should work on any modern browser. Note that when using
|
---|
| 1232 | # HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
|
---|
| 1233 | # (GENERATE_DOCSET) there is already a search function so this one should
|
---|
| 1234 | # typically be disabled. For large projects the javascript based search engine
|
---|
| 1235 | # can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
|
---|
| 1236 |
|
---|
| 1237 | SEARCHENGINE = YES
|
---|
| 1238 |
|
---|
| 1239 | # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
|
---|
| 1240 | # implemented using a web server instead of a web client using Javascript.
|
---|
| 1241 | # There are two flavours of web server based search depending on the
|
---|
| 1242 | # EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for
|
---|
| 1243 | # searching and an index file used by the script. When EXTERNAL_SEARCH is
|
---|
| 1244 | # enabled the indexing and searching needs to be provided by external tools.
|
---|
| 1245 | # See the manual for details.
|
---|
| 1246 |
|
---|
| 1247 | SERVER_BASED_SEARCH = NO
|
---|
| 1248 |
|
---|
| 1249 | # When EXTERNAL_SEARCH is enabled doxygen will no longer generate the PHP
|
---|
| 1250 | # script for searching. Instead the search results are written to an XML file
|
---|
| 1251 | # which needs to be processed by an external indexer. Doxygen will invoke an
|
---|
| 1252 | # external search engine pointed to by the SEARCHENGINE_URL option to obtain
|
---|
| 1253 | # the search results. Doxygen ships with an example indexer (doxyindexer) and
|
---|
| 1254 | # search engine (doxysearch.cgi) which are based on the open source search
|
---|
| 1255 | # engine library Xapian. See the manual for configuration details.
|
---|
| 1256 |
|
---|
| 1257 | EXTERNAL_SEARCH = NO
|
---|
| 1258 |
|
---|
| 1259 | # The SEARCHENGINE_URL should point to a search engine hosted by a web server
|
---|
| 1260 | # which will returned the search results when EXTERNAL_SEARCH is enabled.
|
---|
| 1261 | # Doxygen ships with an example search engine (doxysearch) which is based on
|
---|
| 1262 | # the open source search engine library Xapian. See the manual for configuration
|
---|
| 1263 | # details.
|
---|
| 1264 |
|
---|
| 1265 | SEARCHENGINE_URL =
|
---|
| 1266 |
|
---|
| 1267 | # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
|
---|
| 1268 | # search data is written to a file for indexing by an external tool. With the
|
---|
| 1269 | # SEARCHDATA_FILE tag the name of this file can be specified.
|
---|
| 1270 |
|
---|
| 1271 | SEARCHDATA_FILE = searchdata.xml
|
---|
| 1272 |
|
---|
| 1273 | # When SERVER_BASED_SEARCH AND EXTERNAL_SEARCH are both enabled the
|
---|
| 1274 | # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
|
---|
| 1275 | # useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
|
---|
| 1276 | # projects and redirect the results back to the right project.
|
---|
| 1277 |
|
---|
| 1278 | EXTERNAL_SEARCH_ID =
|
---|
| 1279 |
|
---|
| 1280 | # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
|
---|
| 1281 | # projects other than the one defined by this configuration file, but that are
|
---|
| 1282 | # all added to the same external search index. Each project needs to have a
|
---|
| 1283 | # unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id
|
---|
| 1284 | # of to a relative location where the documentation can be found.
|
---|
| 1285 | # The format is: EXTRA_SEARCH_MAPPINGS = id1=loc1 id2=loc2 ...
|
---|
| 1286 |
|
---|
| 1287 | EXTRA_SEARCH_MAPPINGS =
|
---|
| 1288 |
|
---|
| 1289 | #---------------------------------------------------------------------------
|
---|
| 1290 | # configuration options related to the LaTeX output
|
---|
| 1291 | #---------------------------------------------------------------------------
|
---|
| 1292 |
|
---|
| 1293 | # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
|
---|
| 1294 | # generate Latex output.
|
---|
| 1295 |
|
---|
| 1296 | GENERATE_LATEX = NO
|
---|
| 1297 |
|
---|
| 1298 | # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
|
---|
| 1299 | # If a relative path is entered the value of OUTPUT_DIRECTORY will be
|
---|
| 1300 | # put in front of it. If left blank `latex' will be used as the default path.
|
---|
| 1301 |
|
---|
| 1302 | LATEX_OUTPUT = latex
|
---|
| 1303 |
|
---|
| 1304 | # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
|
---|
| 1305 | # invoked. If left blank `latex' will be used as the default command name.
|
---|
| 1306 | # Note that when enabling USE_PDFLATEX this option is only used for
|
---|
| 1307 | # generating bitmaps for formulas in the HTML output, but not in the
|
---|
| 1308 | # Makefile that is written to the output directory.
|
---|
| 1309 |
|
---|
| 1310 | LATEX_CMD_NAME = latex
|
---|
| 1311 |
|
---|
| 1312 | # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
|
---|
| 1313 | # generate index for LaTeX. If left blank `makeindex' will be used as the
|
---|
| 1314 | # default command name.
|
---|
| 1315 |
|
---|
| 1316 | MAKEINDEX_CMD_NAME = makeindex
|
---|
| 1317 |
|
---|
| 1318 | # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
|
---|
| 1319 | # LaTeX documents. This may be useful for small projects and may help to
|
---|
| 1320 | # save some trees in general.
|
---|
| 1321 |
|
---|
| 1322 | COMPACT_LATEX = NO
|
---|
| 1323 |
|
---|
| 1324 | # The PAPER_TYPE tag can be used to set the paper type that is used
|
---|
| 1325 | # by the printer. Possible values are: a4, letter, legal and
|
---|
| 1326 | # executive. If left blank a4 will be used.
|
---|
| 1327 |
|
---|
| 1328 | PAPER_TYPE = a4
|
---|
| 1329 |
|
---|
| 1330 | # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
|
---|
| 1331 | # packages that should be included in the LaTeX output.
|
---|
| 1332 |
|
---|
| 1333 | EXTRA_PACKAGES =
|
---|
| 1334 |
|
---|
| 1335 | # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
|
---|
| 1336 | # the generated latex document. The header should contain everything until
|
---|
| 1337 | # the first chapter. If it is left blank doxygen will generate a
|
---|
| 1338 | # standard header. Notice: only use this tag if you know what you are doing!
|
---|
| 1339 |
|
---|
| 1340 | LATEX_HEADER =
|
---|
| 1341 |
|
---|
| 1342 | # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for
|
---|
| 1343 | # the generated latex document. The footer should contain everything after
|
---|
| 1344 | # the last chapter. If it is left blank doxygen will generate a
|
---|
| 1345 | # standard footer. Notice: only use this tag if you know what you are doing!
|
---|
| 1346 |
|
---|
| 1347 | LATEX_FOOTER =
|
---|
| 1348 |
|
---|
| 1349 | # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images
|
---|
| 1350 | # or other source files which should be copied to the LaTeX output directory.
|
---|
| 1351 | # Note that the files will be copied as-is; there are no commands or markers
|
---|
| 1352 | # available.
|
---|
| 1353 |
|
---|
| 1354 | LATEX_EXTRA_FILES =
|
---|
| 1355 |
|
---|
| 1356 | # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
|
---|
| 1357 | # is prepared for conversion to pdf (using ps2pdf). The pdf file will
|
---|
| 1358 | # contain links (just like the HTML output) instead of page references
|
---|
| 1359 | # This makes the output suitable for online browsing using a pdf viewer.
|
---|
| 1360 |
|
---|
| 1361 | PDF_HYPERLINKS = YES
|
---|
| 1362 |
|
---|
| 1363 | # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
|
---|
| 1364 | # plain latex in the generated Makefile. Set this option to YES to get a
|
---|
| 1365 | # higher quality PDF documentation.
|
---|
| 1366 |
|
---|
| 1367 | USE_PDFLATEX = YES
|
---|
| 1368 |
|
---|
| 1369 | # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
|
---|
| 1370 | # command to the generated LaTeX files. This will instruct LaTeX to keep
|
---|
| 1371 | # running if errors occur, instead of asking the user for help.
|
---|
| 1372 | # This option is also used when generating formulas in HTML.
|
---|
| 1373 |
|
---|
| 1374 | LATEX_BATCHMODE = NO
|
---|
| 1375 |
|
---|
| 1376 | # If LATEX_HIDE_INDICES is set to YES then doxygen will not
|
---|
| 1377 | # include the index chapters (such as File Index, Compound Index, etc.)
|
---|
| 1378 | # in the output.
|
---|
| 1379 |
|
---|
| 1380 | LATEX_HIDE_INDICES = NO
|
---|
| 1381 |
|
---|
| 1382 | # If LATEX_SOURCE_CODE is set to YES then doxygen will include
|
---|
| 1383 | # source code with syntax highlighting in the LaTeX output.
|
---|
| 1384 | # Note that which sources are shown also depends on other settings
|
---|
| 1385 | # such as SOURCE_BROWSER.
|
---|
| 1386 |
|
---|
| 1387 | LATEX_SOURCE_CODE = NO
|
---|
| 1388 |
|
---|
| 1389 | # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
|
---|
| 1390 | # bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See
|
---|
| 1391 | # http://en.wikipedia.org/wiki/BibTeX for more info.
|
---|
| 1392 |
|
---|
| 1393 | LATEX_BIB_STYLE = plain
|
---|
| 1394 |
|
---|
| 1395 | #---------------------------------------------------------------------------
|
---|
| 1396 | # configuration options related to the RTF output
|
---|
| 1397 | #---------------------------------------------------------------------------
|
---|
| 1398 |
|
---|
| 1399 | # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
|
---|
| 1400 | # The RTF output is optimized for Word 97 and may not look very pretty with
|
---|
| 1401 | # other RTF readers or editors.
|
---|
| 1402 |
|
---|
| 1403 | GENERATE_RTF = NO
|
---|
| 1404 |
|
---|
| 1405 | # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
|
---|
| 1406 | # If a relative path is entered the value of OUTPUT_DIRECTORY will be
|
---|
| 1407 | # put in front of it. If left blank `rtf' will be used as the default path.
|
---|
| 1408 |
|
---|
| 1409 | RTF_OUTPUT = rtf
|
---|
| 1410 |
|
---|
| 1411 | # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
|
---|
| 1412 | # RTF documents. This may be useful for small projects and may help to
|
---|
| 1413 | # save some trees in general.
|
---|
| 1414 |
|
---|
| 1415 | COMPACT_RTF = NO
|
---|
| 1416 |
|
---|
| 1417 | # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
|
---|
| 1418 | # will contain hyperlink fields. The RTF file will
|
---|
| 1419 | # contain links (just like the HTML output) instead of page references.
|
---|
| 1420 | # This makes the output suitable for online browsing using WORD or other
|
---|
| 1421 | # programs which support those fields.
|
---|
| 1422 | # Note: wordpad (write) and others do not support links.
|
---|
| 1423 |
|
---|
| 1424 | RTF_HYPERLINKS = NO
|
---|
| 1425 |
|
---|
| 1426 | # Load style sheet definitions from file. Syntax is similar to doxygen's
|
---|
| 1427 | # config file, i.e. a series of assignments. You only have to provide
|
---|
| 1428 | # replacements, missing definitions are set to their default value.
|
---|
| 1429 |
|
---|
| 1430 | RTF_STYLESHEET_FILE =
|
---|
| 1431 |
|
---|
| 1432 | # Set optional variables used in the generation of an rtf document.
|
---|
| 1433 | # Syntax is similar to doxygen's config file.
|
---|
| 1434 |
|
---|
| 1435 | RTF_EXTENSIONS_FILE =
|
---|
| 1436 |
|
---|
| 1437 | #---------------------------------------------------------------------------
|
---|
| 1438 | # configuration options related to the man page output
|
---|
| 1439 | #---------------------------------------------------------------------------
|
---|
| 1440 |
|
---|
| 1441 | # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
|
---|
| 1442 | # generate man pages
|
---|
| 1443 |
|
---|
| 1444 | GENERATE_MAN = NO
|
---|
| 1445 |
|
---|
| 1446 | # The MAN_OUTPUT tag is used to specify where the man pages will be put.
|
---|
| 1447 | # If a relative path is entered the value of OUTPUT_DIRECTORY will be
|
---|
| 1448 | # put in front of it. If left blank `man' will be used as the default path.
|
---|
| 1449 |
|
---|
| 1450 | MAN_OUTPUT = man
|
---|
| 1451 |
|
---|
| 1452 | # The MAN_EXTENSION tag determines the extension that is added to
|
---|
| 1453 | # the generated man pages (default is the subroutine's section .3)
|
---|
| 1454 |
|
---|
| 1455 | MAN_EXTENSION = .3
|
---|
| 1456 |
|
---|
| 1457 | # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
|
---|
| 1458 | # then it will generate one additional man file for each entity
|
---|
| 1459 | # documented in the real man page(s). These additional files
|
---|
| 1460 | # only source the real man page, but without them the man command
|
---|
| 1461 | # would be unable to find the correct page. The default is NO.
|
---|
| 1462 |
|
---|
| 1463 | MAN_LINKS = NO
|
---|
| 1464 |
|
---|
| 1465 | #---------------------------------------------------------------------------
|
---|
| 1466 | # configuration options related to the XML output
|
---|
| 1467 | #---------------------------------------------------------------------------
|
---|
| 1468 |
|
---|
| 1469 | # If the GENERATE_XML tag is set to YES Doxygen will
|
---|
| 1470 | # generate an XML file that captures the structure of
|
---|
| 1471 | # the code including all documentation.
|
---|
| 1472 |
|
---|
| 1473 | GENERATE_XML = NO
|
---|
| 1474 |
|
---|
| 1475 | # The XML_OUTPUT tag is used to specify where the XML pages will be put.
|
---|
| 1476 | # If a relative path is entered the value of OUTPUT_DIRECTORY will be
|
---|
| 1477 | # put in front of it. If left blank `xml' will be used as the default path.
|
---|
| 1478 |
|
---|
| 1479 | XML_OUTPUT = xml
|
---|
| 1480 |
|
---|
| 1481 | # The XML_SCHEMA tag can be used to specify an XML schema,
|
---|
| 1482 | # which can be used by a validating XML parser to check the
|
---|
| 1483 | # syntax of the XML files.
|
---|
| 1484 |
|
---|
| 1485 | XML_SCHEMA =
|
---|
| 1486 |
|
---|
| 1487 | # The XML_DTD tag can be used to specify an XML DTD,
|
---|
| 1488 | # which can be used by a validating XML parser to check the
|
---|
| 1489 | # syntax of the XML files.
|
---|
| 1490 |
|
---|
| 1491 | XML_DTD =
|
---|
| 1492 |
|
---|
| 1493 | # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
|
---|
| 1494 | # dump the program listings (including syntax highlighting
|
---|
| 1495 | # and cross-referencing information) to the XML output. Note that
|
---|
| 1496 | # enabling this will significantly increase the size of the XML output.
|
---|
| 1497 |
|
---|
| 1498 | XML_PROGRAMLISTING = YES
|
---|
| 1499 |
|
---|
| 1500 | #---------------------------------------------------------------------------
|
---|
| 1501 | # configuration options related to the DOCBOOK output
|
---|
| 1502 | #---------------------------------------------------------------------------
|
---|
| 1503 |
|
---|
| 1504 | # If the GENERATE_DOCBOOK tag is set to YES Doxygen will generate DOCBOOK files
|
---|
| 1505 | # that can be used to generate PDF.
|
---|
| 1506 |
|
---|
| 1507 | GENERATE_DOCBOOK = NO
|
---|
| 1508 |
|
---|
| 1509 | # The DOCBOOK_OUTPUT tag is used to specify where the DOCBOOK pages will be put.
|
---|
| 1510 | # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
|
---|
| 1511 | # front of it. If left blank docbook will be used as the default path.
|
---|
| 1512 |
|
---|
| 1513 | DOCBOOK_OUTPUT = docbook
|
---|
| 1514 |
|
---|
| 1515 | #---------------------------------------------------------------------------
|
---|
| 1516 | # configuration options for the AutoGen Definitions output
|
---|
| 1517 | #---------------------------------------------------------------------------
|
---|
| 1518 |
|
---|
| 1519 | # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
|
---|
| 1520 | # generate an AutoGen Definitions (see autogen.sf.net) file
|
---|
| 1521 | # that captures the structure of the code including all
|
---|
| 1522 | # documentation. Note that this feature is still experimental
|
---|
| 1523 | # and incomplete at the moment.
|
---|
| 1524 |
|
---|
| 1525 | GENERATE_AUTOGEN_DEF = NO
|
---|
| 1526 |
|
---|
| 1527 | #---------------------------------------------------------------------------
|
---|
| 1528 | # configuration options related to the Perl module output
|
---|
| 1529 | #---------------------------------------------------------------------------
|
---|
| 1530 |
|
---|
| 1531 | # If the GENERATE_PERLMOD tag is set to YES Doxygen will
|
---|
| 1532 | # generate a Perl module file that captures the structure of
|
---|
| 1533 | # the code including all documentation. Note that this
|
---|
| 1534 | # feature is still experimental and incomplete at the
|
---|
| 1535 | # moment.
|
---|
| 1536 |
|
---|
| 1537 | GENERATE_PERLMOD = NO
|
---|
| 1538 |
|
---|
| 1539 | # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
|
---|
| 1540 | # the necessary Makefile rules, Perl scripts and LaTeX code to be able
|
---|
| 1541 | # to generate PDF and DVI output from the Perl module output.
|
---|
| 1542 |
|
---|
| 1543 | PERLMOD_LATEX = NO
|
---|
| 1544 |
|
---|
| 1545 | # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
|
---|
| 1546 | # nicely formatted so it can be parsed by a human reader. This is useful
|
---|
| 1547 | # if you want to understand what is going on. On the other hand, if this
|
---|
| 1548 | # tag is set to NO the size of the Perl module output will be much smaller
|
---|
| 1549 | # and Perl will parse it just the same.
|
---|
| 1550 |
|
---|
| 1551 | PERLMOD_PRETTY = YES
|
---|
| 1552 |
|
---|
| 1553 | # The names of the make variables in the generated doxyrules.make file
|
---|
| 1554 | # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
|
---|
| 1555 | # This is useful so different doxyrules.make files included by the same
|
---|
| 1556 | # Makefile don't overwrite each other's variables.
|
---|
| 1557 |
|
---|
| 1558 | PERLMOD_MAKEVAR_PREFIX =
|
---|
| 1559 |
|
---|
| 1560 | #---------------------------------------------------------------------------
|
---|
| 1561 | # Configuration options related to the preprocessor
|
---|
| 1562 | #---------------------------------------------------------------------------
|
---|
| 1563 |
|
---|
| 1564 | # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
|
---|
| 1565 | # evaluate all C-preprocessor directives found in the sources and include
|
---|
| 1566 | # files.
|
---|
| 1567 |
|
---|
| 1568 | ENABLE_PREPROCESSING = YES
|
---|
| 1569 |
|
---|
| 1570 | # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
|
---|
| 1571 | # names in the source code. If set to NO (the default) only conditional
|
---|
| 1572 | # compilation will be performed. Macro expansion can be done in a controlled
|
---|
| 1573 | # way by setting EXPAND_ONLY_PREDEF to YES.
|
---|
| 1574 |
|
---|
| 1575 | MACRO_EXPANSION = NO
|
---|
| 1576 |
|
---|
| 1577 | # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
|
---|
| 1578 | # then the macro expansion is limited to the macros specified with the
|
---|
| 1579 | # PREDEFINED and EXPAND_AS_DEFINED tags.
|
---|
| 1580 |
|
---|
| 1581 | EXPAND_ONLY_PREDEF = NO
|
---|
| 1582 |
|
---|
| 1583 | # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
|
---|
| 1584 | # pointed to by INCLUDE_PATH will be searched when a #include is found.
|
---|
| 1585 |
|
---|
| 1586 | SEARCH_INCLUDES = YES
|
---|
| 1587 |
|
---|
| 1588 | # The INCLUDE_PATH tag can be used to specify one or more directories that
|
---|
| 1589 | # contain include files that are not input files but should be processed by
|
---|
| 1590 | # the preprocessor.
|
---|
| 1591 |
|
---|
| 1592 | INCLUDE_PATH =
|
---|
| 1593 |
|
---|
| 1594 | # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
|
---|
| 1595 | # patterns (like *.h and *.hpp) to filter out the header-files in the
|
---|
| 1596 | # directories. If left blank, the patterns specified with FILE_PATTERNS will
|
---|
| 1597 | # be used.
|
---|
| 1598 |
|
---|
| 1599 | INCLUDE_FILE_PATTERNS =
|
---|
| 1600 |
|
---|
| 1601 | # The PREDEFINED tag can be used to specify one or more macro names that
|
---|
| 1602 | # are defined before the preprocessor is started (similar to the -D option of
|
---|
| 1603 | # gcc). The argument of the tag is a list of macros of the form: name
|
---|
| 1604 | # or name=definition (no spaces). If the definition and the = are
|
---|
| 1605 | # omitted =1 is assumed. To prevent a macro definition from being
|
---|
| 1606 | # undefined via #undef or recursively expanded use the := operator
|
---|
| 1607 | # instead of the = operator.
|
---|
| 1608 |
|
---|
| 1609 | PREDEFINED =
|
---|
| 1610 |
|
---|
| 1611 | # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
|
---|
| 1612 | # this tag can be used to specify a list of macro names that should be expanded.
|
---|
| 1613 | # The macro definition that is found in the sources will be used.
|
---|
| 1614 | # Use the PREDEFINED tag if you want to use a different macro definition that
|
---|
| 1615 | # overrules the definition found in the source code.
|
---|
| 1616 |
|
---|
| 1617 | EXPAND_AS_DEFINED =
|
---|
| 1618 |
|
---|
| 1619 | # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
|
---|
| 1620 | # doxygen's preprocessor will remove all references to function-like macros
|
---|
| 1621 | # that are alone on a line, have an all uppercase name, and do not end with a
|
---|
| 1622 | # semicolon, because these will confuse the parser if not removed.
|
---|
| 1623 |
|
---|
| 1624 | SKIP_FUNCTION_MACROS = YES
|
---|
| 1625 |
|
---|
| 1626 | #---------------------------------------------------------------------------
|
---|
| 1627 | # Configuration::additions related to external references
|
---|
| 1628 | #---------------------------------------------------------------------------
|
---|
| 1629 |
|
---|
| 1630 | # The TAGFILES option can be used to specify one or more tagfiles. For each
|
---|
| 1631 | # tag file the location of the external documentation should be added. The
|
---|
| 1632 | # format of a tag file without this location is as follows:
|
---|
| 1633 | # TAGFILES = file1 file2 ...
|
---|
| 1634 | # Adding location for the tag files is done as follows:
|
---|
| 1635 | # TAGFILES = file1=loc1 "file2 = loc2" ...
|
---|
| 1636 | # where "loc1" and "loc2" can be relative or absolute paths
|
---|
| 1637 | # or URLs. Note that each tag file must have a unique name (where the name does
|
---|
| 1638 | # NOT include the path). If a tag file is not located in the directory in which
|
---|
| 1639 | # doxygen is run, you must also specify the path to the tagfile here.
|
---|
| 1640 |
|
---|
| 1641 | TAGFILES = $(FLAIR_ROOT)/flair-dev/doc/qt.tag=http://qt-project.org/doc/qt-4.8
|
---|
| 1642 |
|
---|
| 1643 | # When a file name is specified after GENERATE_TAGFILE, doxygen will create
|
---|
| 1644 | # a tag file that is based on the input files it reads.
|
---|
| 1645 |
|
---|
| 1646 | GENERATE_TAGFILE =
|
---|
| 1647 |
|
---|
| 1648 | # If the ALLEXTERNALS tag is set to YES all external classes will be listed
|
---|
| 1649 | # in the class index. If set to NO only the inherited external classes
|
---|
| 1650 | # will be listed.
|
---|
| 1651 |
|
---|
| 1652 | ALLEXTERNALS = NO
|
---|
| 1653 |
|
---|
| 1654 | # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
|
---|
| 1655 | # in the modules index. If set to NO, only the current project's groups will
|
---|
| 1656 | # be listed.
|
---|
| 1657 |
|
---|
| 1658 | EXTERNAL_GROUPS = NO
|
---|
| 1659 |
|
---|
| 1660 | # If the EXTERNAL_PAGES tag is set to YES all external pages will be listed
|
---|
| 1661 | # in the related pages index. If set to NO, only the current project's
|
---|
| 1662 | # pages will be listed.
|
---|
| 1663 |
|
---|
| 1664 | EXTERNAL_PAGES = YES
|
---|
| 1665 |
|
---|
| 1666 | # The PERL_PATH should be the absolute path and name of the perl script
|
---|
| 1667 | # interpreter (i.e. the result of `which perl').
|
---|
| 1668 |
|
---|
| 1669 | PERL_PATH = /usr/bin/perl
|
---|
| 1670 |
|
---|
| 1671 | #---------------------------------------------------------------------------
|
---|
| 1672 | # Configuration options related to the dot tool
|
---|
| 1673 | #---------------------------------------------------------------------------
|
---|
| 1674 |
|
---|
| 1675 | # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
|
---|
| 1676 | # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
|
---|
| 1677 | # or super classes. Setting the tag to NO turns the diagrams off. Note that
|
---|
| 1678 | # this option also works with HAVE_DOT disabled, but it is recommended to
|
---|
| 1679 | # install and use dot, since it yields more powerful graphs.
|
---|
| 1680 |
|
---|
| 1681 | CLASS_DIAGRAMS = YES
|
---|
| 1682 |
|
---|
| 1683 | # You can define message sequence charts within doxygen comments using the \msc
|
---|
| 1684 | # command. Doxygen will then run the mscgen tool (see
|
---|
| 1685 | # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
|
---|
| 1686 | # documentation. The MSCGEN_PATH tag allows you to specify the directory where
|
---|
| 1687 | # the mscgen tool resides. If left empty the tool is assumed to be found in the
|
---|
| 1688 | # default search path.
|
---|
| 1689 |
|
---|
| 1690 | MSCGEN_PATH =
|
---|
| 1691 |
|
---|
| 1692 | # If set to YES, the inheritance and collaboration graphs will hide
|
---|
| 1693 | # inheritance and usage relations if the target is undocumented
|
---|
| 1694 | # or is not a class.
|
---|
| 1695 |
|
---|
| 1696 | HIDE_UNDOC_RELATIONS = YES
|
---|
| 1697 |
|
---|
| 1698 | # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
|
---|
| 1699 | # available from the path. This tool is part of Graphviz, a graph visualization
|
---|
| 1700 | # toolkit from AT&T and Lucent Bell Labs. The other options in this section
|
---|
| 1701 | # have no effect if this option is set to NO (the default)
|
---|
| 1702 |
|
---|
| 1703 | HAVE_DOT = NO
|
---|
| 1704 |
|
---|
| 1705 | # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
|
---|
| 1706 | # allowed to run in parallel. When set to 0 (the default) doxygen will
|
---|
| 1707 | # base this on the number of processors available in the system. You can set it
|
---|
| 1708 | # explicitly to a value larger than 0 to get control over the balance
|
---|
| 1709 | # between CPU load and processing speed.
|
---|
| 1710 |
|
---|
| 1711 | DOT_NUM_THREADS = 0
|
---|
| 1712 |
|
---|
| 1713 | # By default doxygen will use the Helvetica font for all dot files that
|
---|
| 1714 | # doxygen generates. When you want a differently looking font you can specify
|
---|
| 1715 | # the font name using DOT_FONTNAME. You need to make sure dot is able to find
|
---|
| 1716 | # the font, which can be done by putting it in a standard location or by setting
|
---|
| 1717 | # the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the
|
---|
| 1718 | # directory containing the font.
|
---|
| 1719 |
|
---|
| 1720 | DOT_FONTNAME = Helvetica
|
---|
| 1721 |
|
---|
| 1722 | # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
|
---|
| 1723 | # The default size is 10pt.
|
---|
| 1724 |
|
---|
| 1725 | DOT_FONTSIZE = 10
|
---|
| 1726 |
|
---|
| 1727 | # By default doxygen will tell dot to use the Helvetica font.
|
---|
| 1728 | # If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to
|
---|
| 1729 | # set the path where dot can find it.
|
---|
| 1730 |
|
---|
| 1731 | DOT_FONTPATH =
|
---|
| 1732 |
|
---|
| 1733 | # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
|
---|
| 1734 | # will generate a graph for each documented class showing the direct and
|
---|
| 1735 | # indirect inheritance relations. Setting this tag to YES will force the
|
---|
| 1736 | # CLASS_DIAGRAMS tag to NO.
|
---|
| 1737 |
|
---|
| 1738 | CLASS_GRAPH = YES
|
---|
| 1739 |
|
---|
| 1740 | # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
|
---|
| 1741 | # will generate a graph for each documented class showing the direct and
|
---|
| 1742 | # indirect implementation dependencies (inheritance, containment, and
|
---|
| 1743 | # class references variables) of the class with other documented classes.
|
---|
| 1744 |
|
---|
| 1745 | COLLABORATION_GRAPH = YES
|
---|
| 1746 |
|
---|
| 1747 | # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
|
---|
| 1748 | # will generate a graph for groups, showing the direct groups dependencies
|
---|
| 1749 |
|
---|
| 1750 | GROUP_GRAPHS = YES
|
---|
| 1751 |
|
---|
| 1752 | # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
|
---|
| 1753 | # collaboration diagrams in a style similar to the OMG's Unified Modeling
|
---|
| 1754 | # Language.
|
---|
| 1755 |
|
---|
| 1756 | UML_LOOK = NO
|
---|
| 1757 |
|
---|
| 1758 | # If the UML_LOOK tag is enabled, the fields and methods are shown inside
|
---|
| 1759 | # the class node. If there are many fields or methods and many nodes the
|
---|
| 1760 | # graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS
|
---|
| 1761 | # threshold limits the number of items for each type to make the size more
|
---|
| 1762 | # manageable. Set this to 0 for no limit. Note that the threshold may be
|
---|
| 1763 | # exceeded by 50% before the limit is enforced.
|
---|
| 1764 |
|
---|
| 1765 | UML_LIMIT_NUM_FIELDS = 10
|
---|
| 1766 |
|
---|
| 1767 | # If set to YES, the inheritance and collaboration graphs will show the
|
---|
| 1768 | # relations between templates and their instances.
|
---|
| 1769 |
|
---|
| 1770 | TEMPLATE_RELATIONS = NO
|
---|
| 1771 |
|
---|
| 1772 | # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
|
---|
| 1773 | # tags are set to YES then doxygen will generate a graph for each documented
|
---|
| 1774 | # file showing the direct and indirect include dependencies of the file with
|
---|
| 1775 | # other documented files.
|
---|
| 1776 |
|
---|
| 1777 | INCLUDE_GRAPH = YES
|
---|
| 1778 |
|
---|
| 1779 | # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
|
---|
| 1780 | # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
|
---|
| 1781 | # documented header file showing the documented files that directly or
|
---|
| 1782 | # indirectly include this file.
|
---|
| 1783 |
|
---|
| 1784 | INCLUDED_BY_GRAPH = YES
|
---|
| 1785 |
|
---|
| 1786 | # If the CALL_GRAPH and HAVE_DOT options are set to YES then
|
---|
| 1787 | # doxygen will generate a call dependency graph for every global function
|
---|
| 1788 | # or class method. Note that enabling this option will significantly increase
|
---|
| 1789 | # the time of a run. So in most cases it will be better to enable call graphs
|
---|
| 1790 | # for selected functions only using the \callgraph command.
|
---|
| 1791 |
|
---|
| 1792 | CALL_GRAPH = NO
|
---|
| 1793 |
|
---|
| 1794 | # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
|
---|
| 1795 | # doxygen will generate a caller dependency graph for every global function
|
---|
| 1796 | # or class method. Note that enabling this option will significantly increase
|
---|
| 1797 | # the time of a run. So in most cases it will be better to enable caller
|
---|
| 1798 | # graphs for selected functions only using the \callergraph command.
|
---|
| 1799 |
|
---|
| 1800 | CALLER_GRAPH = NO
|
---|
| 1801 |
|
---|
| 1802 | # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
|
---|
| 1803 | # will generate a graphical hierarchy of all classes instead of a textual one.
|
---|
| 1804 |
|
---|
| 1805 | GRAPHICAL_HIERARCHY = YES
|
---|
| 1806 |
|
---|
| 1807 | # If the DIRECTORY_GRAPH and HAVE_DOT tags are set to YES
|
---|
| 1808 | # then doxygen will show the dependencies a directory has on other directories
|
---|
| 1809 | # in a graphical way. The dependency relations are determined by the #include
|
---|
| 1810 | # relations between the files in the directories.
|
---|
| 1811 |
|
---|
| 1812 | DIRECTORY_GRAPH = YES
|
---|
| 1813 |
|
---|
| 1814 | # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
|
---|
| 1815 | # generated by dot. Possible values are svg, png, jpg, or gif.
|
---|
| 1816 | # If left blank png will be used. If you choose svg you need to set
|
---|
| 1817 | # HTML_FILE_EXTENSION to xhtml in order to make the SVG files
|
---|
| 1818 | # visible in IE 9+ (other browsers do not have this requirement).
|
---|
| 1819 |
|
---|
| 1820 | DOT_IMAGE_FORMAT = png
|
---|
| 1821 |
|
---|
| 1822 | # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
|
---|
| 1823 | # enable generation of interactive SVG images that allow zooming and panning.
|
---|
| 1824 | # Note that this requires a modern browser other than Internet Explorer.
|
---|
| 1825 | # Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you
|
---|
| 1826 | # need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files
|
---|
| 1827 | # visible. Older versions of IE do not have SVG support.
|
---|
| 1828 |
|
---|
| 1829 | INTERACTIVE_SVG = NO
|
---|
| 1830 |
|
---|
| 1831 | # The tag DOT_PATH can be used to specify the path where the dot tool can be
|
---|
| 1832 | # found. If left blank, it is assumed the dot tool can be found in the path.
|
---|
| 1833 |
|
---|
| 1834 | DOT_PATH =
|
---|
| 1835 |
|
---|
| 1836 | # The DOTFILE_DIRS tag can be used to specify one or more directories that
|
---|
| 1837 | # contain dot files that are included in the documentation (see the
|
---|
| 1838 | # \dotfile command).
|
---|
| 1839 |
|
---|
| 1840 | DOTFILE_DIRS =
|
---|
| 1841 |
|
---|
| 1842 | # The MSCFILE_DIRS tag can be used to specify one or more directories that
|
---|
| 1843 | # contain msc files that are included in the documentation (see the
|
---|
| 1844 | # \mscfile command).
|
---|
| 1845 |
|
---|
| 1846 | MSCFILE_DIRS =
|
---|
| 1847 |
|
---|
| 1848 | # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
|
---|
| 1849 | # nodes that will be shown in the graph. If the number of nodes in a graph
|
---|
| 1850 | # becomes larger than this value, doxygen will truncate the graph, which is
|
---|
| 1851 | # visualized by representing a node as a red box. Note that doxygen if the
|
---|
| 1852 | # number of direct children of the root node in a graph is already larger than
|
---|
| 1853 | # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
|
---|
| 1854 | # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
|
---|
| 1855 |
|
---|
| 1856 | DOT_GRAPH_MAX_NODES = 50
|
---|
| 1857 |
|
---|
| 1858 | # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
|
---|
| 1859 | # graphs generated by dot. A depth value of 3 means that only nodes reachable
|
---|
| 1860 | # from the root by following a path via at most 3 edges will be shown. Nodes
|
---|
| 1861 | # that lay further from the root node will be omitted. Note that setting this
|
---|
| 1862 | # option to 1 or 2 may greatly reduce the computation time needed for large
|
---|
| 1863 | # code bases. Also note that the size of a graph can be further restricted by
|
---|
| 1864 | # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
|
---|
| 1865 |
|
---|
| 1866 | MAX_DOT_GRAPH_DEPTH = 0
|
---|
| 1867 |
|
---|
| 1868 | # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
|
---|
| 1869 | # background. This is disabled by default, because dot on Windows does not
|
---|
| 1870 | # seem to support this out of the box. Warning: Depending on the platform used,
|
---|
| 1871 | # enabling this option may lead to badly anti-aliased labels on the edges of
|
---|
| 1872 | # a graph (i.e. they become hard to read).
|
---|
| 1873 |
|
---|
| 1874 | DOT_TRANSPARENT = NO
|
---|
| 1875 |
|
---|
| 1876 | # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
|
---|
| 1877 | # files in one run (i.e. multiple -o and -T options on the command line). This
|
---|
| 1878 | # makes dot run faster, but since only newer versions of dot (>1.8.10)
|
---|
| 1879 | # support this, this feature is disabled by default.
|
---|
| 1880 |
|
---|
| 1881 | DOT_MULTI_TARGETS = NO
|
---|
| 1882 |
|
---|
| 1883 | # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
|
---|
| 1884 | # generate a legend page explaining the meaning of the various boxes and
|
---|
| 1885 | # arrows in the dot generated graphs.
|
---|
| 1886 |
|
---|
| 1887 | GENERATE_LEGEND = YES
|
---|
| 1888 |
|
---|
| 1889 | # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
|
---|
| 1890 | # remove the intermediate dot files that are used to generate
|
---|
| 1891 | # the various graphs.
|
---|
| 1892 |
|
---|
| 1893 | DOT_CLEANUP = YES
|
---|