Patrick Barrett / libexositecoap

The (alpha of the) official Exosite library, CoAP version.

NOTE: This mirror repository may be out of date, check the main repo for changes. If there are any remind me to update this mirror.

This is an unstable alpha of the Official Exosite library, there are known issues with the port to this platform. You probably shouldn't use this library yet if you just want to get things done.

This version uses CoAP for the application protocol.

picocoap/Doxyfile@7:f9df43829cea, 2014-12-19 (annotated)

Committer:
Patrick Barrett
Date:
Fri Dec 19 15:43:03 2014 -0600
Revision:
7:f9df43829cea
make picocoap a subtree instead of submodule

Who changed what in which revision?

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