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