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