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