Matt Briggs
Fork to see if I can get working
Dependencies: BufferedSerial OneWire WinbondSPIFlash libxDot-dev-mbed5-deprecated
Fork of
xDotBridge_update_test20180823
by 
Matt Briggs
xDotBridge.doxyfile@44:ece6330e9b57, 2017-02-01 (annotated)
- Committer:
- Matt Briggs
- Date:
- Wed Feb 01 15:20:45 2017 -0700
- Revision:
- 44:ece6330e9b57
- Child:
- 45:f146a8ef5ea6
First cut at BaseboardIO class implementation.
Minior cleanup in main and CommProtocolPeerBrute
Who changed what in which revision?
| User | Revision | Line number | New contents of line |
|---|---|---|---|
| Matt Briggs | 44:ece6330e9b57 | 1 | # Doxyfile 1.8.13 |
| Matt Briggs | 44:ece6330e9b57 | 2 | |
| Matt Briggs | 44:ece6330e9b57 | 3 | # This file describes the settings to be used by the documentation system |
| Matt Briggs | 44:ece6330e9b57 | 4 | # doxygen (www.doxygen.org) for a project. |
| Matt Briggs | 44:ece6330e9b57 | 5 | # |
| Matt Briggs | 44:ece6330e9b57 | 6 | # All text after a double hash (##) is considered a comment and is placed in |
| Matt Briggs | 44:ece6330e9b57 | 7 | # front of the TAG it is preceding. |
| Matt Briggs | 44:ece6330e9b57 | 8 | # |
| Matt Briggs | 44:ece6330e9b57 | 9 | # All text after a single hash (#) is considered a comment and will be ignored. |
| Matt Briggs | 44:ece6330e9b57 | 10 | # The format is: |
| Matt Briggs | 44:ece6330e9b57 | 11 | # TAG = value [value, ...] |
| Matt Briggs | 44:ece6330e9b57 | 12 | # For lists, items can also be appended using: |
| Matt Briggs | 44:ece6330e9b57 | 13 | # TAG += value [value, ...] |
| Matt Briggs | 44:ece6330e9b57 | 14 | # Values that contain spaces should be placed between quotes (\" \"). |
| Matt Briggs | 44:ece6330e9b57 | 15 | |
| Matt Briggs | 44:ece6330e9b57 | 16 | #--------------------------------------------------------------------------- |
| Matt Briggs | 44:ece6330e9b57 | 17 | # Project related configuration options |
| Matt Briggs | 44:ece6330e9b57 | 18 | #--------------------------------------------------------------------------- |
| Matt Briggs | 44:ece6330e9b57 | 19 | |
| Matt Briggs | 44:ece6330e9b57 | 20 | # This tag specifies the encoding used for all characters in the config file |
| Matt Briggs | 44:ece6330e9b57 | 21 | # that follow. The default is UTF-8 which is also the encoding used for all text |
| Matt Briggs | 44:ece6330e9b57 | 22 | # before the first occurrence of this tag. Doxygen uses libiconv (or the iconv |
| Matt Briggs | 44:ece6330e9b57 | 23 | # built into libc) for the transcoding. See http://www.gnu.org/software/libiconv |
| Matt Briggs | 44:ece6330e9b57 | 24 | # for the list of possible encodings. |
| Matt Briggs | 44:ece6330e9b57 | 25 | # The default value is: UTF-8. |
| Matt Briggs | 44:ece6330e9b57 | 26 | |
| Matt Briggs | 44:ece6330e9b57 | 27 | DOXYFILE_ENCODING = UTF-8 |
| Matt Briggs | 44:ece6330e9b57 | 28 | |
| Matt Briggs | 44:ece6330e9b57 | 29 | # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by |
| Matt Briggs | 44:ece6330e9b57 | 30 | # double-quotes, unless you are using Doxywizard) that should identify the |
| Matt Briggs | 44:ece6330e9b57 | 31 | # project for which the documentation is generated. This name is used in the |
| Matt Briggs | 44:ece6330e9b57 | 32 | # title of most generated pages and in a few other places. |
| Matt Briggs | 44:ece6330e9b57 | 33 | # The default value is: My Project. |
| Matt Briggs | 44:ece6330e9b57 | 34 | |
| Matt Briggs | 44:ece6330e9b57 | 35 | PROJECT_NAME = "xDotBridge" |
| Matt Briggs | 44:ece6330e9b57 | 36 | |
| Matt Briggs | 44:ece6330e9b57 | 37 | # The PROJECT_NUMBER tag can be used to enter a project or revision number. This |
| Matt Briggs | 44:ece6330e9b57 | 38 | # could be handy for archiving the generated documentation or if some version |
| Matt Briggs | 44:ece6330e9b57 | 39 | # control system is used. |
| Matt Briggs | 44:ece6330e9b57 | 40 | |
| Matt Briggs | 44:ece6330e9b57 | 41 | PROJECT_NUMBER = 1.0 |
| Matt Briggs | 44:ece6330e9b57 | 42 | |
| Matt Briggs | 44:ece6330e9b57 | 43 | # Using the PROJECT_BRIEF tag one can provide an optional one line description |
| Matt Briggs | 44:ece6330e9b57 | 44 | # for a project that appears at the top of each page and should give viewer a |
| Matt Briggs | 44:ece6330e9b57 | 45 | # quick idea about the purpose of the project. Keep the description short. |
| Matt Briggs | 44:ece6330e9b57 | 46 | |
| Matt Briggs | 44:ece6330e9b57 | 47 | PROJECT_BRIEF = |
| Matt Briggs | 44:ece6330e9b57 | 48 | |
| Matt Briggs | 44:ece6330e9b57 | 49 | # With the PROJECT_LOGO tag one can specify a logo or an icon that is included |
| Matt Briggs | 44:ece6330e9b57 | 50 | # in the documentation. The maximum height of the logo should not exceed 55 |
| Matt Briggs | 44:ece6330e9b57 | 51 | # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy |
| Matt Briggs | 44:ece6330e9b57 | 52 | # the logo to the output directory. |
| Matt Briggs | 44:ece6330e9b57 | 53 | |
| Matt Briggs | 44:ece6330e9b57 | 54 | PROJECT_LOGO = |
| Matt Briggs | 44:ece6330e9b57 | 55 | |
| Matt Briggs | 44:ece6330e9b57 | 56 | # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path |
| Matt Briggs | 44:ece6330e9b57 | 57 | # into which the generated documentation will be written. If a relative path is |
| Matt Briggs | 44:ece6330e9b57 | 58 | # entered, it will be relative to the location where doxygen was started. If |
| Matt Briggs | 44:ece6330e9b57 | 59 | # left blank the current directory will be used. |
| Matt Briggs | 44:ece6330e9b57 | 60 | |
| Matt Briggs | 44:ece6330e9b57 | 61 | OUTPUT_DIRECTORY = DOC |
| Matt Briggs | 44:ece6330e9b57 | 62 | |
| Matt Briggs | 44:ece6330e9b57 | 63 | # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- |
| Matt Briggs | 44:ece6330e9b57 | 64 | # directories (in 2 levels) under the output directory of each output format and |
| Matt Briggs | 44:ece6330e9b57 | 65 | # will distribute the generated files over these directories. Enabling this |
| Matt Briggs | 44:ece6330e9b57 | 66 | # option can be useful when feeding doxygen a huge amount of source files, where |
| Matt Briggs | 44:ece6330e9b57 | 67 | # putting all generated files in the same directory would otherwise causes |
| Matt Briggs | 44:ece6330e9b57 | 68 | # performance problems for the file system. |
| Matt Briggs | 44:ece6330e9b57 | 69 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 70 | |
| Matt Briggs | 44:ece6330e9b57 | 71 | CREATE_SUBDIRS = NO |
| Matt Briggs | 44:ece6330e9b57 | 72 | |
| Matt Briggs | 44:ece6330e9b57 | 73 | # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII |
| Matt Briggs | 44:ece6330e9b57 | 74 | # characters to appear in the names of generated files. If set to NO, non-ASCII |
| Matt Briggs | 44:ece6330e9b57 | 75 | # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode |
| Matt Briggs | 44:ece6330e9b57 | 76 | # U+3044. |
| Matt Briggs | 44:ece6330e9b57 | 77 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 78 | |
| Matt Briggs | 44:ece6330e9b57 | 79 | ALLOW_UNICODE_NAMES = NO |
| Matt Briggs | 44:ece6330e9b57 | 80 | |
| Matt Briggs | 44:ece6330e9b57 | 81 | # The OUTPUT_LANGUAGE tag is used to specify the language in which all |
| Matt Briggs | 44:ece6330e9b57 | 82 | # documentation generated by doxygen is written. Doxygen will use this |
| Matt Briggs | 44:ece6330e9b57 | 83 | # information to generate all constant output in the proper language. |
| Matt Briggs | 44:ece6330e9b57 | 84 | # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, |
| Matt Briggs | 44:ece6330e9b57 | 85 | # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), |
| Matt Briggs | 44:ece6330e9b57 | 86 | # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, |
| Matt Briggs | 44:ece6330e9b57 | 87 | # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), |
| Matt Briggs | 44:ece6330e9b57 | 88 | # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, |
| Matt Briggs | 44:ece6330e9b57 | 89 | # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, |
| Matt Briggs | 44:ece6330e9b57 | 90 | # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, |
| Matt Briggs | 44:ece6330e9b57 | 91 | # Ukrainian and Vietnamese. |
| Matt Briggs | 44:ece6330e9b57 | 92 | # The default value is: English. |
| Matt Briggs | 44:ece6330e9b57 | 93 | |
| Matt Briggs | 44:ece6330e9b57 | 94 | OUTPUT_LANGUAGE = English |
| Matt Briggs | 44:ece6330e9b57 | 95 | |
| Matt Briggs | 44:ece6330e9b57 | 96 | # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member |
| Matt Briggs | 44:ece6330e9b57 | 97 | # descriptions after the members that are listed in the file and class |
| Matt Briggs | 44:ece6330e9b57 | 98 | # documentation (similar to Javadoc). Set to NO to disable this. |
| Matt Briggs | 44:ece6330e9b57 | 99 | # The default value is: YES. |
| Matt Briggs | 44:ece6330e9b57 | 100 | |
| Matt Briggs | 44:ece6330e9b57 | 101 | BRIEF_MEMBER_DESC = YES |
| Matt Briggs | 44:ece6330e9b57 | 102 | |
| Matt Briggs | 44:ece6330e9b57 | 103 | # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief |
| Matt Briggs | 44:ece6330e9b57 | 104 | # description of a member or function before the detailed description |
| Matt Briggs | 44:ece6330e9b57 | 105 | # |
| Matt Briggs | 44:ece6330e9b57 | 106 | # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the |
| Matt Briggs | 44:ece6330e9b57 | 107 | # brief descriptions will be completely suppressed. |
| Matt Briggs | 44:ece6330e9b57 | 108 | # The default value is: YES. |
| Matt Briggs | 44:ece6330e9b57 | 109 | |
| Matt Briggs | 44:ece6330e9b57 | 110 | REPEAT_BRIEF = YES |
| Matt Briggs | 44:ece6330e9b57 | 111 | |
| Matt Briggs | 44:ece6330e9b57 | 112 | # This tag implements a quasi-intelligent brief description abbreviator that is |
| Matt Briggs | 44:ece6330e9b57 | 113 | # used to form the text in various listings. Each string in this list, if found |
| Matt Briggs | 44:ece6330e9b57 | 114 | # as the leading text of the brief description, will be stripped from the text |
| Matt Briggs | 44:ece6330e9b57 | 115 | # and the result, after processing the whole list, is used as the annotated |
| Matt Briggs | 44:ece6330e9b57 | 116 | # text. Otherwise, the brief description is used as-is. If left blank, the |
| Matt Briggs | 44:ece6330e9b57 | 117 | # following values are used ($name is automatically replaced with the name of |
| Matt Briggs | 44:ece6330e9b57 | 118 | # the entity):The $name class, The $name widget, The $name file, is, provides, |
| Matt Briggs | 44:ece6330e9b57 | 119 | # specifies, contains, represents, a, an and the. |
| Matt Briggs | 44:ece6330e9b57 | 120 | |
| Matt Briggs | 44:ece6330e9b57 | 121 | ABBREVIATE_BRIEF = "The $name class" "The $name widget" "The $name file" is provides specifies contains represents a an the |
| Matt Briggs | 44:ece6330e9b57 | 122 | |
| Matt Briggs | 44:ece6330e9b57 | 123 | # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then |
| Matt Briggs | 44:ece6330e9b57 | 124 | # doxygen will generate a detailed section even if there is only a brief |
| Matt Briggs | 44:ece6330e9b57 | 125 | # description. |
| Matt Briggs | 44:ece6330e9b57 | 126 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 127 | |
| Matt Briggs | 44:ece6330e9b57 | 128 | ALWAYS_DETAILED_SEC = NO |
| Matt Briggs | 44:ece6330e9b57 | 129 | |
| Matt Briggs | 44:ece6330e9b57 | 130 | # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all |
| Matt Briggs | 44:ece6330e9b57 | 131 | # inherited members of a class in the documentation of that class as if those |
| Matt Briggs | 44:ece6330e9b57 | 132 | # members were ordinary class members. Constructors, destructors and assignment |
| Matt Briggs | 44:ece6330e9b57 | 133 | # operators of the base classes will not be shown. |
| Matt Briggs | 44:ece6330e9b57 | 134 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 135 | |
| Matt Briggs | 44:ece6330e9b57 | 136 | INLINE_INHERITED_MEMB = NO |
| Matt Briggs | 44:ece6330e9b57 | 137 | |
| Matt Briggs | 44:ece6330e9b57 | 138 | # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path |
| Matt Briggs | 44:ece6330e9b57 | 139 | # before files name in the file list and in the header files. If set to NO the |
| Matt Briggs | 44:ece6330e9b57 | 140 | # shortest path that makes the file name unique will be used |
| Matt Briggs | 44:ece6330e9b57 | 141 | # The default value is: YES. |
| Matt Briggs | 44:ece6330e9b57 | 142 | |
| Matt Briggs | 44:ece6330e9b57 | 143 | FULL_PATH_NAMES = YES |
| Matt Briggs | 44:ece6330e9b57 | 144 | |
| Matt Briggs | 44:ece6330e9b57 | 145 | # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. |
| Matt Briggs | 44:ece6330e9b57 | 146 | # Stripping is only done if one of the specified strings matches the left-hand |
| Matt Briggs | 44:ece6330e9b57 | 147 | # part of the path. The tag can be used to show relative paths in the file list. |
| Matt Briggs | 44:ece6330e9b57 | 148 | # If left blank the directory from which doxygen is run is used as the path to |
| Matt Briggs | 44:ece6330e9b57 | 149 | # strip. |
| Matt Briggs | 44:ece6330e9b57 | 150 | # |
| Matt Briggs | 44:ece6330e9b57 | 151 | # Note that you can specify absolute paths here, but also relative paths, which |
| Matt Briggs | 44:ece6330e9b57 | 152 | # will be relative from the directory where doxygen is started. |
| Matt Briggs | 44:ece6330e9b57 | 153 | # This tag requires that the tag FULL_PATH_NAMES is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 154 | |
| Matt Briggs | 44:ece6330e9b57 | 155 | STRIP_FROM_PATH = |
| Matt Briggs | 44:ece6330e9b57 | 156 | |
| Matt Briggs | 44:ece6330e9b57 | 157 | # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the |
| Matt Briggs | 44:ece6330e9b57 | 158 | # path mentioned in the documentation of a class, which tells the reader which |
| Matt Briggs | 44:ece6330e9b57 | 159 | # header file to include in order to use a class. If left blank only the name of |
| Matt Briggs | 44:ece6330e9b57 | 160 | # the header file containing the class definition is used. Otherwise one should |
| Matt Briggs | 44:ece6330e9b57 | 161 | # specify the list of include paths that are normally passed to the compiler |
| Matt Briggs | 44:ece6330e9b57 | 162 | # using the -I flag. |
| Matt Briggs | 44:ece6330e9b57 | 163 | |
| Matt Briggs | 44:ece6330e9b57 | 164 | STRIP_FROM_INC_PATH = |
| Matt Briggs | 44:ece6330e9b57 | 165 | |
| Matt Briggs | 44:ece6330e9b57 | 166 | # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but |
| Matt Briggs | 44:ece6330e9b57 | 167 | # less readable) file names. This can be useful is your file systems doesn't |
| Matt Briggs | 44:ece6330e9b57 | 168 | # support long names like on DOS, Mac, or CD-ROM. |
| Matt Briggs | 44:ece6330e9b57 | 169 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 170 | |
| Matt Briggs | 44:ece6330e9b57 | 171 | SHORT_NAMES = NO |
| Matt Briggs | 44:ece6330e9b57 | 172 | |
| Matt Briggs | 44:ece6330e9b57 | 173 | # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the |
| Matt Briggs | 44:ece6330e9b57 | 174 | # first line (until the first dot) of a Javadoc-style comment as the brief |
| Matt Briggs | 44:ece6330e9b57 | 175 | # description. If set to NO, the Javadoc-style will behave just like regular Qt- |
| Matt Briggs | 44:ece6330e9b57 | 176 | # style comments (thus requiring an explicit @brief command for a brief |
| Matt Briggs | 44:ece6330e9b57 | 177 | # description.) |
| Matt Briggs | 44:ece6330e9b57 | 178 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 179 | |
| Matt Briggs | 44:ece6330e9b57 | 180 | JAVADOC_AUTOBRIEF = NO |
| Matt Briggs | 44:ece6330e9b57 | 181 | |
| Matt Briggs | 44:ece6330e9b57 | 182 | # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first |
| Matt Briggs | 44:ece6330e9b57 | 183 | # line (until the first dot) of a Qt-style comment as the brief description. If |
| Matt Briggs | 44:ece6330e9b57 | 184 | # set to NO, the Qt-style will behave just like regular Qt-style comments (thus |
| Matt Briggs | 44:ece6330e9b57 | 185 | # requiring an explicit \brief command for a brief description.) |
| Matt Briggs | 44:ece6330e9b57 | 186 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 187 | |
| Matt Briggs | 44:ece6330e9b57 | 188 | QT_AUTOBRIEF = NO |
| Matt Briggs | 44:ece6330e9b57 | 189 | |
| Matt Briggs | 44:ece6330e9b57 | 190 | # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a |
| Matt Briggs | 44:ece6330e9b57 | 191 | # multi-line C++ special comment block (i.e. a block of //! or /// comments) as |
| Matt Briggs | 44:ece6330e9b57 | 192 | # a brief description. This used to be the default behavior. The new default is |
| Matt Briggs | 44:ece6330e9b57 | 193 | # to treat a multi-line C++ comment block as a detailed description. Set this |
| Matt Briggs | 44:ece6330e9b57 | 194 | # tag to YES if you prefer the old behavior instead. |
| Matt Briggs | 44:ece6330e9b57 | 195 | # |
| Matt Briggs | 44:ece6330e9b57 | 196 | # Note that setting this tag to YES also means that rational rose comments are |
| Matt Briggs | 44:ece6330e9b57 | 197 | # not recognized any more. |
| Matt Briggs | 44:ece6330e9b57 | 198 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 199 | |
| Matt Briggs | 44:ece6330e9b57 | 200 | MULTILINE_CPP_IS_BRIEF = NO |
| Matt Briggs | 44:ece6330e9b57 | 201 | |
| Matt Briggs | 44:ece6330e9b57 | 202 | # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the |
| Matt Briggs | 44:ece6330e9b57 | 203 | # documentation from any documented member that it re-implements. |
| Matt Briggs | 44:ece6330e9b57 | 204 | # The default value is: YES. |
| Matt Briggs | 44:ece6330e9b57 | 205 | |
| Matt Briggs | 44:ece6330e9b57 | 206 | INHERIT_DOCS = YES |
| Matt Briggs | 44:ece6330e9b57 | 207 | |
| Matt Briggs | 44:ece6330e9b57 | 208 | # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new |
| Matt Briggs | 44:ece6330e9b57 | 209 | # page for each member. If set to NO, the documentation of a member will be part |
| Matt Briggs | 44:ece6330e9b57 | 210 | # of the file/class/namespace that contains it. |
| Matt Briggs | 44:ece6330e9b57 | 211 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 212 | |
| Matt Briggs | 44:ece6330e9b57 | 213 | SEPARATE_MEMBER_PAGES = NO |
| Matt Briggs | 44:ece6330e9b57 | 214 | |
| Matt Briggs | 44:ece6330e9b57 | 215 | # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen |
| Matt Briggs | 44:ece6330e9b57 | 216 | # uses this value to replace tabs by spaces in code fragments. |
| Matt Briggs | 44:ece6330e9b57 | 217 | # Minimum value: 1, maximum value: 16, default value: 4. |
| Matt Briggs | 44:ece6330e9b57 | 218 | |
| Matt Briggs | 44:ece6330e9b57 | 219 | TAB_SIZE = 4 |
| Matt Briggs | 44:ece6330e9b57 | 220 | |
| Matt Briggs | 44:ece6330e9b57 | 221 | # This tag can be used to specify a number of aliases that act as commands in |
| Matt Briggs | 44:ece6330e9b57 | 222 | # the documentation. An alias has the form: |
| Matt Briggs | 44:ece6330e9b57 | 223 | # name=value |
| Matt Briggs | 44:ece6330e9b57 | 224 | # For example adding |
| Matt Briggs | 44:ece6330e9b57 | 225 | # "sideeffect=@par Side Effects:\n" |
| Matt Briggs | 44:ece6330e9b57 | 226 | # will allow you to put the command \sideeffect (or @sideeffect) in the |
| Matt Briggs | 44:ece6330e9b57 | 227 | # documentation, which will result in a user-defined paragraph with heading |
| Matt Briggs | 44:ece6330e9b57 | 228 | # "Side Effects:". You can put \n's in the value part of an alias to insert |
| Matt Briggs | 44:ece6330e9b57 | 229 | # newlines. |
| Matt Briggs | 44:ece6330e9b57 | 230 | |
| Matt Briggs | 44:ece6330e9b57 | 231 | ALIASES = |
| Matt Briggs | 44:ece6330e9b57 | 232 | |
| Matt Briggs | 44:ece6330e9b57 | 233 | # This tag can be used to specify a number of word-keyword mappings (TCL only). |
| Matt Briggs | 44:ece6330e9b57 | 234 | # A mapping has the form "name=value". For example adding "class=itcl::class" |
| Matt Briggs | 44:ece6330e9b57 | 235 | # will allow you to use the command class in the itcl::class meaning. |
| Matt Briggs | 44:ece6330e9b57 | 236 | |
| Matt Briggs | 44:ece6330e9b57 | 237 | TCL_SUBST = |
| Matt Briggs | 44:ece6330e9b57 | 238 | |
| Matt Briggs | 44:ece6330e9b57 | 239 | # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources |
| Matt Briggs | 44:ece6330e9b57 | 240 | # only. Doxygen will then generate output that is more tailored for C. For |
| Matt Briggs | 44:ece6330e9b57 | 241 | # instance, some of the names that are used will be different. The list of all |
| Matt Briggs | 44:ece6330e9b57 | 242 | # members will be omitted, etc. |
| Matt Briggs | 44:ece6330e9b57 | 243 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 244 | |
| Matt Briggs | 44:ece6330e9b57 | 245 | OPTIMIZE_OUTPUT_FOR_C = NO |
| Matt Briggs | 44:ece6330e9b57 | 246 | |
| Matt Briggs | 44:ece6330e9b57 | 247 | # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or |
| Matt Briggs | 44:ece6330e9b57 | 248 | # Python sources only. Doxygen will then generate output that is more tailored |
| Matt Briggs | 44:ece6330e9b57 | 249 | # for that language. For instance, namespaces will be presented as packages, |
| Matt Briggs | 44:ece6330e9b57 | 250 | # qualified scopes will look different, etc. |
| Matt Briggs | 44:ece6330e9b57 | 251 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 252 | |
| Matt Briggs | 44:ece6330e9b57 | 253 | OPTIMIZE_OUTPUT_JAVA = NO |
| Matt Briggs | 44:ece6330e9b57 | 254 | |
| Matt Briggs | 44:ece6330e9b57 | 255 | # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran |
| Matt Briggs | 44:ece6330e9b57 | 256 | # sources. Doxygen will then generate output that is tailored for Fortran. |
| Matt Briggs | 44:ece6330e9b57 | 257 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 258 | |
| Matt Briggs | 44:ece6330e9b57 | 259 | OPTIMIZE_FOR_FORTRAN = NO |
| Matt Briggs | 44:ece6330e9b57 | 260 | |
| Matt Briggs | 44:ece6330e9b57 | 261 | # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL |
| Matt Briggs | 44:ece6330e9b57 | 262 | # sources. Doxygen will then generate output that is tailored for VHDL. |
| Matt Briggs | 44:ece6330e9b57 | 263 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 264 | |
| Matt Briggs | 44:ece6330e9b57 | 265 | OPTIMIZE_OUTPUT_VHDL = NO |
| Matt Briggs | 44:ece6330e9b57 | 266 | |
| Matt Briggs | 44:ece6330e9b57 | 267 | # Doxygen selects the parser to use depending on the extension of the files it |
| Matt Briggs | 44:ece6330e9b57 | 268 | # parses. With this tag you can assign which parser to use for a given |
| Matt Briggs | 44:ece6330e9b57 | 269 | # extension. Doxygen has a built-in mapping, but you can override or extend it |
| Matt Briggs | 44:ece6330e9b57 | 270 | # using this tag. The format is ext=language, where ext is a file extension, and |
| Matt Briggs | 44:ece6330e9b57 | 271 | # language is one of the parsers supported by doxygen: IDL, Java, Javascript, |
| Matt Briggs | 44:ece6330e9b57 | 272 | # C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: |
| Matt Briggs | 44:ece6330e9b57 | 273 | # FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: |
| Matt Briggs | 44:ece6330e9b57 | 274 | # Fortran. In the later case the parser tries to guess whether the code is fixed |
| Matt Briggs | 44:ece6330e9b57 | 275 | # or free formatted code, this is the default for Fortran type files), VHDL. For |
| Matt Briggs | 44:ece6330e9b57 | 276 | # instance to make doxygen treat .inc files as Fortran files (default is PHP), |
| Matt Briggs | 44:ece6330e9b57 | 277 | # and .f files as C (default is Fortran), use: inc=Fortran f=C. |
| Matt Briggs | 44:ece6330e9b57 | 278 | # |
| Matt Briggs | 44:ece6330e9b57 | 279 | # Note: For files without extension you can use no_extension as a placeholder. |
| Matt Briggs | 44:ece6330e9b57 | 280 | # |
| Matt Briggs | 44:ece6330e9b57 | 281 | # Note that for custom extensions you also need to set FILE_PATTERNS otherwise |
| Matt Briggs | 44:ece6330e9b57 | 282 | # the files are not read by doxygen. |
| Matt Briggs | 44:ece6330e9b57 | 283 | |
| Matt Briggs | 44:ece6330e9b57 | 284 | EXTENSION_MAPPING = |
| Matt Briggs | 44:ece6330e9b57 | 285 | |
| Matt Briggs | 44:ece6330e9b57 | 286 | # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments |
| Matt Briggs | 44:ece6330e9b57 | 287 | # according to the Markdown format, which allows for more readable |
| Matt Briggs | 44:ece6330e9b57 | 288 | # documentation. See http://daringfireball.net/projects/markdown/ for details. |
| Matt Briggs | 44:ece6330e9b57 | 289 | # The output of markdown processing is further processed by doxygen, so you can |
| Matt Briggs | 44:ece6330e9b57 | 290 | # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in |
| Matt Briggs | 44:ece6330e9b57 | 291 | # case of backward compatibilities issues. |
| Matt Briggs | 44:ece6330e9b57 | 292 | # The default value is: YES. |
| Matt Briggs | 44:ece6330e9b57 | 293 | |
| Matt Briggs | 44:ece6330e9b57 | 294 | MARKDOWN_SUPPORT = YES |
| Matt Briggs | 44:ece6330e9b57 | 295 | |
| Matt Briggs | 44:ece6330e9b57 | 296 | # When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up |
| Matt Briggs | 44:ece6330e9b57 | 297 | # to that level are automatically included in the table of contents, even if |
| Matt Briggs | 44:ece6330e9b57 | 298 | # they do not have an id attribute. |
| Matt Briggs | 44:ece6330e9b57 | 299 | # Note: This feature currently applies only to Markdown headings. |
| Matt Briggs | 44:ece6330e9b57 | 300 | # Minimum value: 0, maximum value: 99, default value: 0. |
| Matt Briggs | 44:ece6330e9b57 | 301 | # This tag requires that the tag MARKDOWN_SUPPORT is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 302 | |
| Matt Briggs | 44:ece6330e9b57 | 303 | TOC_INCLUDE_HEADINGS = 0 |
| Matt Briggs | 44:ece6330e9b57 | 304 | |
| Matt Briggs | 44:ece6330e9b57 | 305 | # When enabled doxygen tries to link words that correspond to documented |
| Matt Briggs | 44:ece6330e9b57 | 306 | # classes, or namespaces to their corresponding documentation. Such a link can |
| Matt Briggs | 44:ece6330e9b57 | 307 | # be prevented in individual cases by putting a % sign in front of the word or |
| Matt Briggs | 44:ece6330e9b57 | 308 | # globally by setting AUTOLINK_SUPPORT to NO. |
| Matt Briggs | 44:ece6330e9b57 | 309 | # The default value is: YES. |
| Matt Briggs | 44:ece6330e9b57 | 310 | |
| Matt Briggs | 44:ece6330e9b57 | 311 | AUTOLINK_SUPPORT = YES |
| Matt Briggs | 44:ece6330e9b57 | 312 | |
| Matt Briggs | 44:ece6330e9b57 | 313 | # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want |
| Matt Briggs | 44:ece6330e9b57 | 314 | # to include (a tag file for) the STL sources as input, then you should set this |
| Matt Briggs | 44:ece6330e9b57 | 315 | # tag to YES in order to let doxygen match functions declarations and |
| Matt Briggs | 44:ece6330e9b57 | 316 | # definitions whose arguments contain STL classes (e.g. func(std::string); |
| Matt Briggs | 44:ece6330e9b57 | 317 | # versus func(std::string) {}). This also make the inheritance and collaboration |
| Matt Briggs | 44:ece6330e9b57 | 318 | # diagrams that involve STL classes more complete and accurate. |
| Matt Briggs | 44:ece6330e9b57 | 319 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 320 | |
| Matt Briggs | 44:ece6330e9b57 | 321 | BUILTIN_STL_SUPPORT = NO |
| Matt Briggs | 44:ece6330e9b57 | 322 | |
| Matt Briggs | 44:ece6330e9b57 | 323 | # If you use Microsoft's C++/CLI language, you should set this option to YES to |
| Matt Briggs | 44:ece6330e9b57 | 324 | # enable parsing support. |
| Matt Briggs | 44:ece6330e9b57 | 325 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 326 | |
| Matt Briggs | 44:ece6330e9b57 | 327 | CPP_CLI_SUPPORT = NO |
| Matt Briggs | 44:ece6330e9b57 | 328 | |
| Matt Briggs | 44:ece6330e9b57 | 329 | # Set the SIP_SUPPORT tag to YES if your project consists of sip (see: |
| Matt Briggs | 44:ece6330e9b57 | 330 | # http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen |
| Matt Briggs | 44:ece6330e9b57 | 331 | # will parse them like normal C++ but will assume all classes use public instead |
| Matt Briggs | 44:ece6330e9b57 | 332 | # of private inheritance when no explicit protection keyword is present. |
| Matt Briggs | 44:ece6330e9b57 | 333 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 334 | |
| Matt Briggs | 44:ece6330e9b57 | 335 | SIP_SUPPORT = NO |
| Matt Briggs | 44:ece6330e9b57 | 336 | |
| Matt Briggs | 44:ece6330e9b57 | 337 | # For Microsoft's IDL there are propget and propput attributes to indicate |
| Matt Briggs | 44:ece6330e9b57 | 338 | # getter and setter methods for a property. Setting this option to YES will make |
| Matt Briggs | 44:ece6330e9b57 | 339 | # doxygen to replace the get and set methods by a property in the documentation. |
| Matt Briggs | 44:ece6330e9b57 | 340 | # This will only work if the methods are indeed getting or setting a simple |
| Matt Briggs | 44:ece6330e9b57 | 341 | # type. If this is not the case, or you want to show the methods anyway, you |
| Matt Briggs | 44:ece6330e9b57 | 342 | # should set this option to NO. |
| Matt Briggs | 44:ece6330e9b57 | 343 | # The default value is: YES. |
| Matt Briggs | 44:ece6330e9b57 | 344 | |
| Matt Briggs | 44:ece6330e9b57 | 345 | IDL_PROPERTY_SUPPORT = YES |
| Matt Briggs | 44:ece6330e9b57 | 346 | |
| Matt Briggs | 44:ece6330e9b57 | 347 | # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC |
| Matt Briggs | 44:ece6330e9b57 | 348 | # tag is set to YES then doxygen will reuse the documentation of the first |
| Matt Briggs | 44:ece6330e9b57 | 349 | # member in the group (if any) for the other members of the group. By default |
| Matt Briggs | 44:ece6330e9b57 | 350 | # all members of a group must be documented explicitly. |
| Matt Briggs | 44:ece6330e9b57 | 351 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 352 | |
| Matt Briggs | 44:ece6330e9b57 | 353 | DISTRIBUTE_GROUP_DOC = NO |
| Matt Briggs | 44:ece6330e9b57 | 354 | |
| Matt Briggs | 44:ece6330e9b57 | 355 | # If one adds a struct or class to a group and this option is enabled, then also |
| Matt Briggs | 44:ece6330e9b57 | 356 | # any nested class or struct is added to the same group. By default this option |
| Matt Briggs | 44:ece6330e9b57 | 357 | # is disabled and one has to add nested compounds explicitly via \ingroup. |
| Matt Briggs | 44:ece6330e9b57 | 358 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 359 | |
| Matt Briggs | 44:ece6330e9b57 | 360 | GROUP_NESTED_COMPOUNDS = NO |
| Matt Briggs | 44:ece6330e9b57 | 361 | |
| Matt Briggs | 44:ece6330e9b57 | 362 | # Set the SUBGROUPING tag to YES to allow class member groups of the same type |
| Matt Briggs | 44:ece6330e9b57 | 363 | # (for instance a group of public functions) to be put as a subgroup of that |
| Matt Briggs | 44:ece6330e9b57 | 364 | # type (e.g. under the Public Functions section). Set it to NO to prevent |
| Matt Briggs | 44:ece6330e9b57 | 365 | # subgrouping. Alternatively, this can be done per class using the |
| Matt Briggs | 44:ece6330e9b57 | 366 | # \nosubgrouping command. |
| Matt Briggs | 44:ece6330e9b57 | 367 | # The default value is: YES. |
| Matt Briggs | 44:ece6330e9b57 | 368 | |
| Matt Briggs | 44:ece6330e9b57 | 369 | SUBGROUPING = YES |
| Matt Briggs | 44:ece6330e9b57 | 370 | |
| Matt Briggs | 44:ece6330e9b57 | 371 | # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions |
| Matt Briggs | 44:ece6330e9b57 | 372 | # are shown inside the group in which they are included (e.g. using \ingroup) |
| Matt Briggs | 44:ece6330e9b57 | 373 | # instead of on a separate page (for HTML and Man pages) or section (for LaTeX |
| Matt Briggs | 44:ece6330e9b57 | 374 | # and RTF). |
| Matt Briggs | 44:ece6330e9b57 | 375 | # |
| Matt Briggs | 44:ece6330e9b57 | 376 | # Note that this feature does not work in combination with |
| Matt Briggs | 44:ece6330e9b57 | 377 | # SEPARATE_MEMBER_PAGES. |
| Matt Briggs | 44:ece6330e9b57 | 378 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 379 | |
| Matt Briggs | 44:ece6330e9b57 | 380 | INLINE_GROUPED_CLASSES = NO |
| Matt Briggs | 44:ece6330e9b57 | 381 | |
| Matt Briggs | 44:ece6330e9b57 | 382 | # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions |
| Matt Briggs | 44:ece6330e9b57 | 383 | # with only public data fields or simple typedef fields will be shown inline in |
| Matt Briggs | 44:ece6330e9b57 | 384 | # the documentation of the scope in which they are defined (i.e. file, |
| Matt Briggs | 44:ece6330e9b57 | 385 | # namespace, or group documentation), provided this scope is documented. If set |
| Matt Briggs | 44:ece6330e9b57 | 386 | # to NO, structs, classes, and unions are shown on a separate page (for HTML and |
| Matt Briggs | 44:ece6330e9b57 | 387 | # Man pages) or section (for LaTeX and RTF). |
| Matt Briggs | 44:ece6330e9b57 | 388 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 389 | |
| Matt Briggs | 44:ece6330e9b57 | 390 | INLINE_SIMPLE_STRUCTS = NO |
| Matt Briggs | 44:ece6330e9b57 | 391 | |
| Matt Briggs | 44:ece6330e9b57 | 392 | # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or |
| Matt Briggs | 44:ece6330e9b57 | 393 | # enum is documented as struct, union, or enum with the name of the typedef. So |
| Matt Briggs | 44:ece6330e9b57 | 394 | # typedef struct TypeS {} TypeT, will appear in the documentation as a struct |
| Matt Briggs | 44:ece6330e9b57 | 395 | # with name TypeT. When disabled the typedef will appear as a member of a file, |
| Matt Briggs | 44:ece6330e9b57 | 396 | # namespace, or class. And the struct will be named TypeS. This can typically be |
| Matt Briggs | 44:ece6330e9b57 | 397 | # useful for C code in case the coding convention dictates that all compound |
| Matt Briggs | 44:ece6330e9b57 | 398 | # types are typedef'ed and only the typedef is referenced, never the tag name. |
| Matt Briggs | 44:ece6330e9b57 | 399 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 400 | |
| Matt Briggs | 44:ece6330e9b57 | 401 | TYPEDEF_HIDES_STRUCT = NO |
| Matt Briggs | 44:ece6330e9b57 | 402 | |
| Matt Briggs | 44:ece6330e9b57 | 403 | # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This |
| Matt Briggs | 44:ece6330e9b57 | 404 | # cache is used to resolve symbols given their name and scope. Since this can be |
| Matt Briggs | 44:ece6330e9b57 | 405 | # an expensive process and often the same symbol appears multiple times in the |
| Matt Briggs | 44:ece6330e9b57 | 406 | # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small |
| Matt Briggs | 44:ece6330e9b57 | 407 | # doxygen will become slower. If the cache is too large, memory is wasted. The |
| Matt Briggs | 44:ece6330e9b57 | 408 | # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range |
| Matt Briggs | 44:ece6330e9b57 | 409 | # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 |
| Matt Briggs | 44:ece6330e9b57 | 410 | # symbols. At the end of a run doxygen will report the cache usage and suggest |
| Matt Briggs | 44:ece6330e9b57 | 411 | # the optimal cache size from a speed point of view. |
| Matt Briggs | 44:ece6330e9b57 | 412 | # Minimum value: 0, maximum value: 9, default value: 0. |
| Matt Briggs | 44:ece6330e9b57 | 413 | |
| Matt Briggs | 44:ece6330e9b57 | 414 | LOOKUP_CACHE_SIZE = 0 |
| Matt Briggs | 44:ece6330e9b57 | 415 | |
| Matt Briggs | 44:ece6330e9b57 | 416 | #--------------------------------------------------------------------------- |
| Matt Briggs | 44:ece6330e9b57 | 417 | # Build related configuration options |
| Matt Briggs | 44:ece6330e9b57 | 418 | #--------------------------------------------------------------------------- |
| Matt Briggs | 44:ece6330e9b57 | 419 | |
| Matt Briggs | 44:ece6330e9b57 | 420 | # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in |
| Matt Briggs | 44:ece6330e9b57 | 421 | # documentation are documented, even if no documentation was available. Private |
| Matt Briggs | 44:ece6330e9b57 | 422 | # class members and static file members will be hidden unless the |
| Matt Briggs | 44:ece6330e9b57 | 423 | # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 424 | # Note: This will also disable the warnings about undocumented members that are |
| Matt Briggs | 44:ece6330e9b57 | 425 | # normally produced when WARNINGS is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 426 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 427 | |
| Matt Briggs | 44:ece6330e9b57 | 428 | EXTRACT_ALL = YES |
| Matt Briggs | 44:ece6330e9b57 | 429 | |
| Matt Briggs | 44:ece6330e9b57 | 430 | # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will |
| Matt Briggs | 44:ece6330e9b57 | 431 | # be included in the documentation. |
| Matt Briggs | 44:ece6330e9b57 | 432 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 433 | |
| Matt Briggs | 44:ece6330e9b57 | 434 | EXTRACT_PRIVATE = YES |
| Matt Briggs | 44:ece6330e9b57 | 435 | |
| Matt Briggs | 44:ece6330e9b57 | 436 | # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal |
| Matt Briggs | 44:ece6330e9b57 | 437 | # scope will be included in the documentation. |
| Matt Briggs | 44:ece6330e9b57 | 438 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 439 | |
| Matt Briggs | 44:ece6330e9b57 | 440 | EXTRACT_PACKAGE = NO |
| Matt Briggs | 44:ece6330e9b57 | 441 | |
| Matt Briggs | 44:ece6330e9b57 | 442 | # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be |
| Matt Briggs | 44:ece6330e9b57 | 443 | # included in the documentation. |
| Matt Briggs | 44:ece6330e9b57 | 444 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 445 | |
| Matt Briggs | 44:ece6330e9b57 | 446 | EXTRACT_STATIC = NO |
| Matt Briggs | 44:ece6330e9b57 | 447 | |
| Matt Briggs | 44:ece6330e9b57 | 448 | # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined |
| Matt Briggs | 44:ece6330e9b57 | 449 | # locally in source files will be included in the documentation. If set to NO, |
| Matt Briggs | 44:ece6330e9b57 | 450 | # only classes defined in header files are included. Does not have any effect |
| Matt Briggs | 44:ece6330e9b57 | 451 | # for Java sources. |
| Matt Briggs | 44:ece6330e9b57 | 452 | # The default value is: YES. |
| Matt Briggs | 44:ece6330e9b57 | 453 | |
| Matt Briggs | 44:ece6330e9b57 | 454 | EXTRACT_LOCAL_CLASSES = YES |
| Matt Briggs | 44:ece6330e9b57 | 455 | |
| Matt Briggs | 44:ece6330e9b57 | 456 | # This flag is only useful for Objective-C code. If set to YES, local methods, |
| Matt Briggs | 44:ece6330e9b57 | 457 | # which are defined in the implementation section but not in the interface are |
| Matt Briggs | 44:ece6330e9b57 | 458 | # included in the documentation. If set to NO, only methods in the interface are |
| Matt Briggs | 44:ece6330e9b57 | 459 | # included. |
| Matt Briggs | 44:ece6330e9b57 | 460 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 461 | |
| Matt Briggs | 44:ece6330e9b57 | 462 | EXTRACT_LOCAL_METHODS = NO |
| Matt Briggs | 44:ece6330e9b57 | 463 | |
| Matt Briggs | 44:ece6330e9b57 | 464 | # If this flag is set to YES, the members of anonymous namespaces will be |
| Matt Briggs | 44:ece6330e9b57 | 465 | # extracted and appear in the documentation as a namespace called |
| Matt Briggs | 44:ece6330e9b57 | 466 | # 'anonymous_namespace{file}', where file will be replaced with the base name of |
| Matt Briggs | 44:ece6330e9b57 | 467 | # the file that contains the anonymous namespace. By default anonymous namespace |
| Matt Briggs | 44:ece6330e9b57 | 468 | # are hidden. |
| Matt Briggs | 44:ece6330e9b57 | 469 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 470 | |
| Matt Briggs | 44:ece6330e9b57 | 471 | EXTRACT_ANON_NSPACES = NO |
| Matt Briggs | 44:ece6330e9b57 | 472 | |
| Matt Briggs | 44:ece6330e9b57 | 473 | # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all |
| Matt Briggs | 44:ece6330e9b57 | 474 | # undocumented members inside documented classes or files. If set to NO these |
| Matt Briggs | 44:ece6330e9b57 | 475 | # members will be included in the various overviews, but no documentation |
| Matt Briggs | 44:ece6330e9b57 | 476 | # section is generated. This option has no effect if EXTRACT_ALL is enabled. |
| Matt Briggs | 44:ece6330e9b57 | 477 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 478 | |
| Matt Briggs | 44:ece6330e9b57 | 479 | HIDE_UNDOC_MEMBERS = NO |
| Matt Briggs | 44:ece6330e9b57 | 480 | |
| Matt Briggs | 44:ece6330e9b57 | 481 | # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all |
| Matt Briggs | 44:ece6330e9b57 | 482 | # undocumented classes that are normally visible in the class hierarchy. If set |
| Matt Briggs | 44:ece6330e9b57 | 483 | # to NO, these classes will be included in the various overviews. This option |
| Matt Briggs | 44:ece6330e9b57 | 484 | # has no effect if EXTRACT_ALL is enabled. |
| Matt Briggs | 44:ece6330e9b57 | 485 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 486 | |
| Matt Briggs | 44:ece6330e9b57 | 487 | HIDE_UNDOC_CLASSES = NO |
| Matt Briggs | 44:ece6330e9b57 | 488 | |
| Matt Briggs | 44:ece6330e9b57 | 489 | # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend |
| Matt Briggs | 44:ece6330e9b57 | 490 | # (class|struct|union) declarations. If set to NO, these declarations will be |
| Matt Briggs | 44:ece6330e9b57 | 491 | # included in the documentation. |
| Matt Briggs | 44:ece6330e9b57 | 492 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 493 | |
| Matt Briggs | 44:ece6330e9b57 | 494 | HIDE_FRIEND_COMPOUNDS = NO |
| Matt Briggs | 44:ece6330e9b57 | 495 | |
| Matt Briggs | 44:ece6330e9b57 | 496 | # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any |
| Matt Briggs | 44:ece6330e9b57 | 497 | # documentation blocks found inside the body of a function. If set to NO, these |
| Matt Briggs | 44:ece6330e9b57 | 498 | # blocks will be appended to the function's detailed documentation block. |
| Matt Briggs | 44:ece6330e9b57 | 499 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 500 | |
| Matt Briggs | 44:ece6330e9b57 | 501 | HIDE_IN_BODY_DOCS = NO |
| Matt Briggs | 44:ece6330e9b57 | 502 | |
| Matt Briggs | 44:ece6330e9b57 | 503 | # The INTERNAL_DOCS tag determines if documentation that is typed after a |
| Matt Briggs | 44:ece6330e9b57 | 504 | # \internal command is included. If the tag is set to NO then the documentation |
| Matt Briggs | 44:ece6330e9b57 | 505 | # will be excluded. Set it to YES to include the internal documentation. |
| Matt Briggs | 44:ece6330e9b57 | 506 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 507 | |
| Matt Briggs | 44:ece6330e9b57 | 508 | INTERNAL_DOCS = NO |
| Matt Briggs | 44:ece6330e9b57 | 509 | |
| Matt Briggs | 44:ece6330e9b57 | 510 | # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file |
| Matt Briggs | 44:ece6330e9b57 | 511 | # names in lower-case letters. If set to YES, upper-case letters are also |
| Matt Briggs | 44:ece6330e9b57 | 512 | # allowed. This is useful if you have classes or files whose names only differ |
| Matt Briggs | 44:ece6330e9b57 | 513 | # in case and if your file system supports case sensitive file names. Windows |
| Matt Briggs | 44:ece6330e9b57 | 514 | # and Mac users are advised to set this option to NO. |
| Matt Briggs | 44:ece6330e9b57 | 515 | # The default value is: system dependent. |
| Matt Briggs | 44:ece6330e9b57 | 516 | |
| Matt Briggs | 44:ece6330e9b57 | 517 | CASE_SENSE_NAMES = NO |
| Matt Briggs | 44:ece6330e9b57 | 518 | |
| Matt Briggs | 44:ece6330e9b57 | 519 | # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with |
| Matt Briggs | 44:ece6330e9b57 | 520 | # their full class and namespace scopes in the documentation. If set to YES, the |
| Matt Briggs | 44:ece6330e9b57 | 521 | # scope will be hidden. |
| Matt Briggs | 44:ece6330e9b57 | 522 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 523 | |
| Matt Briggs | 44:ece6330e9b57 | 524 | HIDE_SCOPE_NAMES = NO |
| Matt Briggs | 44:ece6330e9b57 | 525 | |
| Matt Briggs | 44:ece6330e9b57 | 526 | # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will |
| Matt Briggs | 44:ece6330e9b57 | 527 | # append additional text to a page's title, such as Class Reference. If set to |
| Matt Briggs | 44:ece6330e9b57 | 528 | # YES the compound reference will be hidden. |
| Matt Briggs | 44:ece6330e9b57 | 529 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 530 | |
| Matt Briggs | 44:ece6330e9b57 | 531 | HIDE_COMPOUND_REFERENCE = NO |
| Matt Briggs | 44:ece6330e9b57 | 532 | |
| Matt Briggs | 44:ece6330e9b57 | 533 | # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of |
| Matt Briggs | 44:ece6330e9b57 | 534 | # the files that are included by a file in the documentation of that file. |
| Matt Briggs | 44:ece6330e9b57 | 535 | # The default value is: YES. |
| Matt Briggs | 44:ece6330e9b57 | 536 | |
| Matt Briggs | 44:ece6330e9b57 | 537 | SHOW_INCLUDE_FILES = YES |
| Matt Briggs | 44:ece6330e9b57 | 538 | |
| Matt Briggs | 44:ece6330e9b57 | 539 | # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each |
| Matt Briggs | 44:ece6330e9b57 | 540 | # grouped member an include statement to the documentation, telling the reader |
| Matt Briggs | 44:ece6330e9b57 | 541 | # which file to include in order to use the member. |
| Matt Briggs | 44:ece6330e9b57 | 542 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 543 | |
| Matt Briggs | 44:ece6330e9b57 | 544 | SHOW_GROUPED_MEMB_INC = NO |
| Matt Briggs | 44:ece6330e9b57 | 545 | |
| Matt Briggs | 44:ece6330e9b57 | 546 | # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include |
| Matt Briggs | 44:ece6330e9b57 | 547 | # files with double quotes in the documentation rather than with sharp brackets. |
| Matt Briggs | 44:ece6330e9b57 | 548 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 549 | |
| Matt Briggs | 44:ece6330e9b57 | 550 | FORCE_LOCAL_INCLUDES = NO |
| Matt Briggs | 44:ece6330e9b57 | 551 | |
| Matt Briggs | 44:ece6330e9b57 | 552 | # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the |
| Matt Briggs | 44:ece6330e9b57 | 553 | # documentation for inline members. |
| Matt Briggs | 44:ece6330e9b57 | 554 | # The default value is: YES. |
| Matt Briggs | 44:ece6330e9b57 | 555 | |
| Matt Briggs | 44:ece6330e9b57 | 556 | INLINE_INFO = YES |
| Matt Briggs | 44:ece6330e9b57 | 557 | |
| Matt Briggs | 44:ece6330e9b57 | 558 | # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the |
| Matt Briggs | 44:ece6330e9b57 | 559 | # (detailed) documentation of file and class members alphabetically by member |
| Matt Briggs | 44:ece6330e9b57 | 560 | # name. If set to NO, the members will appear in declaration order. |
| Matt Briggs | 44:ece6330e9b57 | 561 | # The default value is: YES. |
| Matt Briggs | 44:ece6330e9b57 | 562 | |
| Matt Briggs | 44:ece6330e9b57 | 563 | SORT_MEMBER_DOCS = YES |
| Matt Briggs | 44:ece6330e9b57 | 564 | |
| Matt Briggs | 44:ece6330e9b57 | 565 | # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief |
| Matt Briggs | 44:ece6330e9b57 | 566 | # descriptions of file, namespace and class members alphabetically by member |
| Matt Briggs | 44:ece6330e9b57 | 567 | # name. If set to NO, the members will appear in declaration order. Note that |
| Matt Briggs | 44:ece6330e9b57 | 568 | # this will also influence the order of the classes in the class list. |
| Matt Briggs | 44:ece6330e9b57 | 569 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 570 | |
| Matt Briggs | 44:ece6330e9b57 | 571 | SORT_BRIEF_DOCS = NO |
| Matt Briggs | 44:ece6330e9b57 | 572 | |
| Matt Briggs | 44:ece6330e9b57 | 573 | # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the |
| Matt Briggs | 44:ece6330e9b57 | 574 | # (brief and detailed) documentation of class members so that constructors and |
| Matt Briggs | 44:ece6330e9b57 | 575 | # destructors are listed first. If set to NO the constructors will appear in the |
| Matt Briggs | 44:ece6330e9b57 | 576 | # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. |
| Matt Briggs | 44:ece6330e9b57 | 577 | # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief |
| Matt Briggs | 44:ece6330e9b57 | 578 | # member documentation. |
| Matt Briggs | 44:ece6330e9b57 | 579 | # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting |
| Matt Briggs | 44:ece6330e9b57 | 580 | # detailed member documentation. |
| Matt Briggs | 44:ece6330e9b57 | 581 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 582 | |
| Matt Briggs | 44:ece6330e9b57 | 583 | SORT_MEMBERS_CTORS_1ST = NO |
| Matt Briggs | 44:ece6330e9b57 | 584 | |
| Matt Briggs | 44:ece6330e9b57 | 585 | # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy |
| Matt Briggs | 44:ece6330e9b57 | 586 | # of group names into alphabetical order. If set to NO the group names will |
| Matt Briggs | 44:ece6330e9b57 | 587 | # appear in their defined order. |
| Matt Briggs | 44:ece6330e9b57 | 588 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 589 | |
| Matt Briggs | 44:ece6330e9b57 | 590 | SORT_GROUP_NAMES = NO |
| Matt Briggs | 44:ece6330e9b57 | 591 | |
| Matt Briggs | 44:ece6330e9b57 | 592 | # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by |
| Matt Briggs | 44:ece6330e9b57 | 593 | # fully-qualified names, including namespaces. If set to NO, the class list will |
| Matt Briggs | 44:ece6330e9b57 | 594 | # be sorted only by class name, not including the namespace part. |
| Matt Briggs | 44:ece6330e9b57 | 595 | # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 596 | # Note: This option applies only to the class list, not to the alphabetical |
| Matt Briggs | 44:ece6330e9b57 | 597 | # list. |
| Matt Briggs | 44:ece6330e9b57 | 598 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 599 | |
| Matt Briggs | 44:ece6330e9b57 | 600 | SORT_BY_SCOPE_NAME = NO |
| Matt Briggs | 44:ece6330e9b57 | 601 | |
| Matt Briggs | 44:ece6330e9b57 | 602 | # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper |
| Matt Briggs | 44:ece6330e9b57 | 603 | # type resolution of all parameters of a function it will reject a match between |
| Matt Briggs | 44:ece6330e9b57 | 604 | # the prototype and the implementation of a member function even if there is |
| Matt Briggs | 44:ece6330e9b57 | 605 | # only one candidate or it is obvious which candidate to choose by doing a |
| Matt Briggs | 44:ece6330e9b57 | 606 | # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still |
| Matt Briggs | 44:ece6330e9b57 | 607 | # accept a match between prototype and implementation in such cases. |
| Matt Briggs | 44:ece6330e9b57 | 608 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 609 | |
| Matt Briggs | 44:ece6330e9b57 | 610 | STRICT_PROTO_MATCHING = NO |
| Matt Briggs | 44:ece6330e9b57 | 611 | |
| Matt Briggs | 44:ece6330e9b57 | 612 | # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo |
| Matt Briggs | 44:ece6330e9b57 | 613 | # list. This list is created by putting \todo commands in the documentation. |
| Matt Briggs | 44:ece6330e9b57 | 614 | # The default value is: YES. |
| Matt Briggs | 44:ece6330e9b57 | 615 | |
| Matt Briggs | 44:ece6330e9b57 | 616 | GENERATE_TODOLIST = YES |
| Matt Briggs | 44:ece6330e9b57 | 617 | |
| Matt Briggs | 44:ece6330e9b57 | 618 | # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test |
| Matt Briggs | 44:ece6330e9b57 | 619 | # list. This list is created by putting \test commands in the documentation. |
| Matt Briggs | 44:ece6330e9b57 | 620 | # The default value is: YES. |
| Matt Briggs | 44:ece6330e9b57 | 621 | |
| Matt Briggs | 44:ece6330e9b57 | 622 | GENERATE_TESTLIST = YES |
| Matt Briggs | 44:ece6330e9b57 | 623 | |
| Matt Briggs | 44:ece6330e9b57 | 624 | # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug |
| Matt Briggs | 44:ece6330e9b57 | 625 | # list. This list is created by putting \bug commands in the documentation. |
| Matt Briggs | 44:ece6330e9b57 | 626 | # The default value is: YES. |
| Matt Briggs | 44:ece6330e9b57 | 627 | |
| Matt Briggs | 44:ece6330e9b57 | 628 | GENERATE_BUGLIST = YES |
| Matt Briggs | 44:ece6330e9b57 | 629 | |
| Matt Briggs | 44:ece6330e9b57 | 630 | # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) |
| Matt Briggs | 44:ece6330e9b57 | 631 | # the deprecated list. This list is created by putting \deprecated commands in |
| Matt Briggs | 44:ece6330e9b57 | 632 | # the documentation. |
| Matt Briggs | 44:ece6330e9b57 | 633 | # The default value is: YES. |
| Matt Briggs | 44:ece6330e9b57 | 634 | |
| Matt Briggs | 44:ece6330e9b57 | 635 | GENERATE_DEPRECATEDLIST = YES |
| Matt Briggs | 44:ece6330e9b57 | 636 | |
| Matt Briggs | 44:ece6330e9b57 | 637 | # The ENABLED_SECTIONS tag can be used to enable conditional documentation |
| Matt Briggs | 44:ece6330e9b57 | 638 | # sections, marked by \if <section_label> ... \endif and \cond <section_label> |
| Matt Briggs | 44:ece6330e9b57 | 639 | # ... \endcond blocks. |
| Matt Briggs | 44:ece6330e9b57 | 640 | |
| Matt Briggs | 44:ece6330e9b57 | 641 | ENABLED_SECTIONS = |
| Matt Briggs | 44:ece6330e9b57 | 642 | |
| Matt Briggs | 44:ece6330e9b57 | 643 | # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the |
| Matt Briggs | 44:ece6330e9b57 | 644 | # initial value of a variable or macro / define can have for it to appear in the |
| Matt Briggs | 44:ece6330e9b57 | 645 | # documentation. If the initializer consists of more lines than specified here |
| Matt Briggs | 44:ece6330e9b57 | 646 | # it will be hidden. Use a value of 0 to hide initializers completely. The |
| Matt Briggs | 44:ece6330e9b57 | 647 | # appearance of the value of individual variables and macros / defines can be |
| Matt Briggs | 44:ece6330e9b57 | 648 | # controlled using \showinitializer or \hideinitializer command in the |
| Matt Briggs | 44:ece6330e9b57 | 649 | # documentation regardless of this setting. |
| Matt Briggs | 44:ece6330e9b57 | 650 | # Minimum value: 0, maximum value: 10000, default value: 30. |
| Matt Briggs | 44:ece6330e9b57 | 651 | |
| Matt Briggs | 44:ece6330e9b57 | 652 | MAX_INITIALIZER_LINES = 30 |
| Matt Briggs | 44:ece6330e9b57 | 653 | |
| Matt Briggs | 44:ece6330e9b57 | 654 | # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at |
| Matt Briggs | 44:ece6330e9b57 | 655 | # the bottom of the documentation of classes and structs. If set to YES, the |
| Matt Briggs | 44:ece6330e9b57 | 656 | # list will mention the files that were used to generate the documentation. |
| Matt Briggs | 44:ece6330e9b57 | 657 | # The default value is: YES. |
| Matt Briggs | 44:ece6330e9b57 | 658 | |
| Matt Briggs | 44:ece6330e9b57 | 659 | SHOW_USED_FILES = YES |
| Matt Briggs | 44:ece6330e9b57 | 660 | |
| Matt Briggs | 44:ece6330e9b57 | 661 | # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This |
| Matt Briggs | 44:ece6330e9b57 | 662 | # will remove the Files entry from the Quick Index and from the Folder Tree View |
| Matt Briggs | 44:ece6330e9b57 | 663 | # (if specified). |
| Matt Briggs | 44:ece6330e9b57 | 664 | # The default value is: YES. |
| Matt Briggs | 44:ece6330e9b57 | 665 | |
| Matt Briggs | 44:ece6330e9b57 | 666 | SHOW_FILES = YES |
| Matt Briggs | 44:ece6330e9b57 | 667 | |
| Matt Briggs | 44:ece6330e9b57 | 668 | # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces |
| Matt Briggs | 44:ece6330e9b57 | 669 | # page. This will remove the Namespaces entry from the Quick Index and from the |
| Matt Briggs | 44:ece6330e9b57 | 670 | # Folder Tree View (if specified). |
| Matt Briggs | 44:ece6330e9b57 | 671 | # The default value is: YES. |
| Matt Briggs | 44:ece6330e9b57 | 672 | |
| Matt Briggs | 44:ece6330e9b57 | 673 | SHOW_NAMESPACES = YES |
| Matt Briggs | 44:ece6330e9b57 | 674 | |
| Matt Briggs | 44:ece6330e9b57 | 675 | # The FILE_VERSION_FILTER tag can be used to specify a program or script that |
| Matt Briggs | 44:ece6330e9b57 | 676 | # doxygen should invoke to get the current version for each file (typically from |
| Matt Briggs | 44:ece6330e9b57 | 677 | # the version control system). Doxygen will invoke the program by executing (via |
| Matt Briggs | 44:ece6330e9b57 | 678 | # popen()) the command command input-file, where command is the value of the |
| Matt Briggs | 44:ece6330e9b57 | 679 | # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided |
| Matt Briggs | 44:ece6330e9b57 | 680 | # by doxygen. Whatever the program writes to standard output is used as the file |
| Matt Briggs | 44:ece6330e9b57 | 681 | # version. For an example see the documentation. |
| Matt Briggs | 44:ece6330e9b57 | 682 | |
| Matt Briggs | 44:ece6330e9b57 | 683 | FILE_VERSION_FILTER = |
| Matt Briggs | 44:ece6330e9b57 | 684 | |
| Matt Briggs | 44:ece6330e9b57 | 685 | # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed |
| Matt Briggs | 44:ece6330e9b57 | 686 | # by doxygen. The layout file controls the global structure of the generated |
| Matt Briggs | 44:ece6330e9b57 | 687 | # output files in an output format independent way. To create the layout file |
| Matt Briggs | 44:ece6330e9b57 | 688 | # that represents doxygen's defaults, run doxygen with the -l option. You can |
| Matt Briggs | 44:ece6330e9b57 | 689 | # optionally specify a file name after the option, if omitted DoxygenLayout.xml |
| Matt Briggs | 44:ece6330e9b57 | 690 | # will be used as the name of the layout file. |
| Matt Briggs | 44:ece6330e9b57 | 691 | # |
| Matt Briggs | 44:ece6330e9b57 | 692 | # Note that if you run doxygen from a directory containing a file called |
| Matt Briggs | 44:ece6330e9b57 | 693 | # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE |
| Matt Briggs | 44:ece6330e9b57 | 694 | # tag is left empty. |
| Matt Briggs | 44:ece6330e9b57 | 695 | |
| Matt Briggs | 44:ece6330e9b57 | 696 | LAYOUT_FILE = |
| Matt Briggs | 44:ece6330e9b57 | 697 | |
| Matt Briggs | 44:ece6330e9b57 | 698 | # The CITE_BIB_FILES tag can be used to specify one or more bib files containing |
| Matt Briggs | 44:ece6330e9b57 | 699 | # the reference definitions. This must be a list of .bib files. The .bib |
| Matt Briggs | 44:ece6330e9b57 | 700 | # extension is automatically appended if omitted. This requires the bibtex tool |
| Matt Briggs | 44:ece6330e9b57 | 701 | # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. |
| Matt Briggs | 44:ece6330e9b57 | 702 | # For LaTeX the style of the bibliography can be controlled using |
| Matt Briggs | 44:ece6330e9b57 | 703 | # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the |
| Matt Briggs | 44:ece6330e9b57 | 704 | # search path. See also \cite for info how to create references. |
| Matt Briggs | 44:ece6330e9b57 | 705 | |
| Matt Briggs | 44:ece6330e9b57 | 706 | CITE_BIB_FILES = |
| Matt Briggs | 44:ece6330e9b57 | 707 | |
| Matt Briggs | 44:ece6330e9b57 | 708 | #--------------------------------------------------------------------------- |
| Matt Briggs | 44:ece6330e9b57 | 709 | # Configuration options related to warning and progress messages |
| Matt Briggs | 44:ece6330e9b57 | 710 | #--------------------------------------------------------------------------- |
| Matt Briggs | 44:ece6330e9b57 | 711 | |
| Matt Briggs | 44:ece6330e9b57 | 712 | # The QUIET tag can be used to turn on/off the messages that are generated to |
| Matt Briggs | 44:ece6330e9b57 | 713 | # standard output by doxygen. If QUIET is set to YES this implies that the |
| Matt Briggs | 44:ece6330e9b57 | 714 | # messages are off. |
| Matt Briggs | 44:ece6330e9b57 | 715 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 716 | |
| Matt Briggs | 44:ece6330e9b57 | 717 | QUIET = NO |
| Matt Briggs | 44:ece6330e9b57 | 718 | |
| Matt Briggs | 44:ece6330e9b57 | 719 | # The WARNINGS tag can be used to turn on/off the warning messages that are |
| Matt Briggs | 44:ece6330e9b57 | 720 | # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES |
| Matt Briggs | 44:ece6330e9b57 | 721 | # this implies that the warnings are on. |
| Matt Briggs | 44:ece6330e9b57 | 722 | # |
| Matt Briggs | 44:ece6330e9b57 | 723 | # Tip: Turn warnings on while writing the documentation. |
| Matt Briggs | 44:ece6330e9b57 | 724 | # The default value is: YES. |
| Matt Briggs | 44:ece6330e9b57 | 725 | |
| Matt Briggs | 44:ece6330e9b57 | 726 | WARNINGS = YES |
| Matt Briggs | 44:ece6330e9b57 | 727 | |
| Matt Briggs | 44:ece6330e9b57 | 728 | # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate |
| Matt Briggs | 44:ece6330e9b57 | 729 | # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag |
| Matt Briggs | 44:ece6330e9b57 | 730 | # will automatically be disabled. |
| Matt Briggs | 44:ece6330e9b57 | 731 | # The default value is: YES. |
| Matt Briggs | 44:ece6330e9b57 | 732 | |
| Matt Briggs | 44:ece6330e9b57 | 733 | WARN_IF_UNDOCUMENTED = YES |
| Matt Briggs | 44:ece6330e9b57 | 734 | |
| Matt Briggs | 44:ece6330e9b57 | 735 | # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for |
| Matt Briggs | 44:ece6330e9b57 | 736 | # potential errors in the documentation, such as not documenting some parameters |
| Matt Briggs | 44:ece6330e9b57 | 737 | # in a documented function, or documenting parameters that don't exist or using |
| Matt Briggs | 44:ece6330e9b57 | 738 | # markup commands wrongly. |
| Matt Briggs | 44:ece6330e9b57 | 739 | # The default value is: YES. |
| Matt Briggs | 44:ece6330e9b57 | 740 | |
| Matt Briggs | 44:ece6330e9b57 | 741 | WARN_IF_DOC_ERROR = YES |
| Matt Briggs | 44:ece6330e9b57 | 742 | |
| Matt Briggs | 44:ece6330e9b57 | 743 | # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that |
| Matt Briggs | 44:ece6330e9b57 | 744 | # are documented, but have no documentation for their parameters or return |
| Matt Briggs | 44:ece6330e9b57 | 745 | # value. If set to NO, doxygen will only warn about wrong or incomplete |
| Matt Briggs | 44:ece6330e9b57 | 746 | # parameter documentation, but not about the absence of documentation. |
| Matt Briggs | 44:ece6330e9b57 | 747 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 748 | |
| Matt Briggs | 44:ece6330e9b57 | 749 | WARN_NO_PARAMDOC = NO |
| Matt Briggs | 44:ece6330e9b57 | 750 | |
| Matt Briggs | 44:ece6330e9b57 | 751 | # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when |
| Matt Briggs | 44:ece6330e9b57 | 752 | # a warning is encountered. |
| Matt Briggs | 44:ece6330e9b57 | 753 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 754 | |
| Matt Briggs | 44:ece6330e9b57 | 755 | WARN_AS_ERROR = NO |
| Matt Briggs | 44:ece6330e9b57 | 756 | |
| Matt Briggs | 44:ece6330e9b57 | 757 | # The WARN_FORMAT tag determines the format of the warning messages that doxygen |
| Matt Briggs | 44:ece6330e9b57 | 758 | # can produce. The string should contain the $file, $line, and $text tags, which |
| Matt Briggs | 44:ece6330e9b57 | 759 | # will be replaced by the file and line number from which the warning originated |
| Matt Briggs | 44:ece6330e9b57 | 760 | # and the warning text. Optionally the format may contain $version, which will |
| Matt Briggs | 44:ece6330e9b57 | 761 | # be replaced by the version of the file (if it could be obtained via |
| Matt Briggs | 44:ece6330e9b57 | 762 | # FILE_VERSION_FILTER) |
| Matt Briggs | 44:ece6330e9b57 | 763 | # The default value is: $file:$line: $text. |
| Matt Briggs | 44:ece6330e9b57 | 764 | |
| Matt Briggs | 44:ece6330e9b57 | 765 | WARN_FORMAT = "$file:$line: $text" |
| Matt Briggs | 44:ece6330e9b57 | 766 | |
| Matt Briggs | 44:ece6330e9b57 | 767 | # The WARN_LOGFILE tag can be used to specify a file to which warning and error |
| Matt Briggs | 44:ece6330e9b57 | 768 | # messages should be written. If left blank the output is written to standard |
| Matt Briggs | 44:ece6330e9b57 | 769 | # error (stderr). |
| Matt Briggs | 44:ece6330e9b57 | 770 | |
| Matt Briggs | 44:ece6330e9b57 | 771 | WARN_LOGFILE = |
| Matt Briggs | 44:ece6330e9b57 | 772 | |
| Matt Briggs | 44:ece6330e9b57 | 773 | #--------------------------------------------------------------------------- |
| Matt Briggs | 44:ece6330e9b57 | 774 | # Configuration options related to the input files |
| Matt Briggs | 44:ece6330e9b57 | 775 | #--------------------------------------------------------------------------- |
| Matt Briggs | 44:ece6330e9b57 | 776 | |
| Matt Briggs | 44:ece6330e9b57 | 777 | # The INPUT tag is used to specify the files and/or directories that contain |
| Matt Briggs | 44:ece6330e9b57 | 778 | # documented source files. You may enter file names like myfile.cpp or |
| Matt Briggs | 44:ece6330e9b57 | 779 | # directories like /usr/src/myproject. Separate the files or directories with |
| Matt Briggs | 44:ece6330e9b57 | 780 | # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING |
| Matt Briggs | 44:ece6330e9b57 | 781 | # Note: If this tag is empty the current directory is searched. |
| Matt Briggs | 44:ece6330e9b57 | 782 | |
| Matt Briggs | 44:ece6330e9b57 | 783 | INPUT = xDotBridge |
| Matt Briggs | 44:ece6330e9b57 | 784 | |
| Matt Briggs | 44:ece6330e9b57 | 785 | # This tag can be used to specify the character encoding of the source files |
| Matt Briggs | 44:ece6330e9b57 | 786 | # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses |
| Matt Briggs | 44:ece6330e9b57 | 787 | # libiconv (or the iconv built into libc) for the transcoding. See the libiconv |
| Matt Briggs | 44:ece6330e9b57 | 788 | # documentation (see: http://www.gnu.org/software/libiconv) for the list of |
| Matt Briggs | 44:ece6330e9b57 | 789 | # possible encodings. |
| Matt Briggs | 44:ece6330e9b57 | 790 | # The default value is: UTF-8. |
| Matt Briggs | 44:ece6330e9b57 | 791 | |
| Matt Briggs | 44:ece6330e9b57 | 792 | INPUT_ENCODING = UTF-8 |
| Matt Briggs | 44:ece6330e9b57 | 793 | |
| Matt Briggs | 44:ece6330e9b57 | 794 | # If the value of the INPUT tag contains directories, you can use the |
| Matt Briggs | 44:ece6330e9b57 | 795 | # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and |
| Matt Briggs | 44:ece6330e9b57 | 796 | # *.h) to filter out the source-files in the directories. |
| Matt Briggs | 44:ece6330e9b57 | 797 | # |
| Matt Briggs | 44:ece6330e9b57 | 798 | # Note that for custom extensions or not directly supported extensions you also |
| Matt Briggs | 44:ece6330e9b57 | 799 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not |
| Matt Briggs | 44:ece6330e9b57 | 800 | # read by doxygen. |
| Matt Briggs | 44:ece6330e9b57 | 801 | # |
| Matt Briggs | 44:ece6330e9b57 | 802 | # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, |
| Matt Briggs | 44:ece6330e9b57 | 803 | # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, |
| Matt Briggs | 44:ece6330e9b57 | 804 | # *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, |
| Matt Briggs | 44:ece6330e9b57 | 805 | # *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, |
| Matt Briggs | 44:ece6330e9b57 | 806 | # *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf. |
| Matt Briggs | 44:ece6330e9b57 | 807 | |
| Matt Briggs | 44:ece6330e9b57 | 808 | FILE_PATTERNS = *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.idl *.ddl *.odl *.h *.hh *.hxx *.hpp *.h++ *.cs *.d *.php *.php4 *.php5 *.phtml *.inc *.m *.markdown *.md *.mm *.dox *.py *.pyw *.f90 *.f95 *.f03 *.f08 *.f *.for *.tcl *.vhd *.vhdl *.ucf *.qsf |
| Matt Briggs | 44:ece6330e9b57 | 809 | |
| Matt Briggs | 44:ece6330e9b57 | 810 | # The RECURSIVE tag can be used to specify whether or not subdirectories should |
| Matt Briggs | 44:ece6330e9b57 | 811 | # be searched for input files as well. |
| Matt Briggs | 44:ece6330e9b57 | 812 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 813 | |
| Matt Briggs | 44:ece6330e9b57 | 814 | RECURSIVE = YES |
| Matt Briggs | 44:ece6330e9b57 | 815 | |
| Matt Briggs | 44:ece6330e9b57 | 816 | # The EXCLUDE tag can be used to specify files and/or directories that should be |
| Matt Briggs | 44:ece6330e9b57 | 817 | # excluded from the INPUT source files. This way you can easily exclude a |
| Matt Briggs | 44:ece6330e9b57 | 818 | # subdirectory from a directory tree whose root is specified with the INPUT tag. |
| Matt Briggs | 44:ece6330e9b57 | 819 | # |
| Matt Briggs | 44:ece6330e9b57 | 820 | # Note that relative paths are relative to the directory from which doxygen is |
| Matt Briggs | 44:ece6330e9b57 | 821 | # run. |
| Matt Briggs | 44:ece6330e9b57 | 822 | |
| Matt Briggs | 44:ece6330e9b57 | 823 | EXCLUDE = |
| Matt Briggs | 44:ece6330e9b57 | 824 | |
| Matt Briggs | 44:ece6330e9b57 | 825 | # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or |
| Matt Briggs | 44:ece6330e9b57 | 826 | # directories that are symbolic links (a Unix file system feature) are excluded |
| Matt Briggs | 44:ece6330e9b57 | 827 | # from the input. |
| Matt Briggs | 44:ece6330e9b57 | 828 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 829 | |
| Matt Briggs | 44:ece6330e9b57 | 830 | EXCLUDE_SYMLINKS = NO |
| Matt Briggs | 44:ece6330e9b57 | 831 | |
| Matt Briggs | 44:ece6330e9b57 | 832 | # If the value of the INPUT tag contains directories, you can use the |
| Matt Briggs | 44:ece6330e9b57 | 833 | # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude |
| Matt Briggs | 44:ece6330e9b57 | 834 | # certain files from those directories. |
| Matt Briggs | 44:ece6330e9b57 | 835 | # |
| Matt Briggs | 44:ece6330e9b57 | 836 | # Note that the wildcards are matched against the file with absolute path, so to |
| Matt Briggs | 44:ece6330e9b57 | 837 | # exclude all test directories for example use the pattern */test/* |
| Matt Briggs | 44:ece6330e9b57 | 838 | |
| Matt Briggs | 44:ece6330e9b57 | 839 | EXCLUDE_PATTERNS = |
| Matt Briggs | 44:ece6330e9b57 | 840 | |
| Matt Briggs | 44:ece6330e9b57 | 841 | # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names |
| Matt Briggs | 44:ece6330e9b57 | 842 | # (namespaces, classes, functions, etc.) that should be excluded from the |
| Matt Briggs | 44:ece6330e9b57 | 843 | # output. The symbol name can be a fully qualified name, a word, or if the |
| Matt Briggs | 44:ece6330e9b57 | 844 | # wildcard * is used, a substring. Examples: ANamespace, AClass, |
| Matt Briggs | 44:ece6330e9b57 | 845 | # AClass::ANamespace, ANamespace::*Test |
| Matt Briggs | 44:ece6330e9b57 | 846 | # |
| Matt Briggs | 44:ece6330e9b57 | 847 | # Note that the wildcards are matched against the file with absolute path, so to |
| Matt Briggs | 44:ece6330e9b57 | 848 | # exclude all test directories use the pattern */test/* |
| Matt Briggs | 44:ece6330e9b57 | 849 | |
| Matt Briggs | 44:ece6330e9b57 | 850 | EXCLUDE_SYMBOLS = |
| Matt Briggs | 44:ece6330e9b57 | 851 | |
| Matt Briggs | 44:ece6330e9b57 | 852 | # The EXAMPLE_PATH tag can be used to specify one or more files or directories |
| Matt Briggs | 44:ece6330e9b57 | 853 | # that contain example code fragments that are included (see the \include |
| Matt Briggs | 44:ece6330e9b57 | 854 | # command). |
| Matt Briggs | 44:ece6330e9b57 | 855 | |
| Matt Briggs | 44:ece6330e9b57 | 856 | EXAMPLE_PATH = |
| Matt Briggs | 44:ece6330e9b57 | 857 | |
| Matt Briggs | 44:ece6330e9b57 | 858 | # If the value of the EXAMPLE_PATH tag contains directories, you can use the |
| Matt Briggs | 44:ece6330e9b57 | 859 | # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and |
| Matt Briggs | 44:ece6330e9b57 | 860 | # *.h) to filter out the source-files in the directories. If left blank all |
| Matt Briggs | 44:ece6330e9b57 | 861 | # files are included. |
| Matt Briggs | 44:ece6330e9b57 | 862 | |
| Matt Briggs | 44:ece6330e9b57 | 863 | EXAMPLE_PATTERNS = * |
| Matt Briggs | 44:ece6330e9b57 | 864 | |
| Matt Briggs | 44:ece6330e9b57 | 865 | # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be |
| Matt Briggs | 44:ece6330e9b57 | 866 | # searched for input files to be used with the \include or \dontinclude commands |
| Matt Briggs | 44:ece6330e9b57 | 867 | # irrespective of the value of the RECURSIVE tag. |
| Matt Briggs | 44:ece6330e9b57 | 868 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 869 | |
| Matt Briggs | 44:ece6330e9b57 | 870 | EXAMPLE_RECURSIVE = NO |
| Matt Briggs | 44:ece6330e9b57 | 871 | |
| Matt Briggs | 44:ece6330e9b57 | 872 | # The IMAGE_PATH tag can be used to specify one or more files or directories |
| Matt Briggs | 44:ece6330e9b57 | 873 | # that contain images that are to be included in the documentation (see the |
| Matt Briggs | 44:ece6330e9b57 | 874 | # \image command). |
| Matt Briggs | 44:ece6330e9b57 | 875 | |
| Matt Briggs | 44:ece6330e9b57 | 876 | IMAGE_PATH = |
| Matt Briggs | 44:ece6330e9b57 | 877 | |
| Matt Briggs | 44:ece6330e9b57 | 878 | # The INPUT_FILTER tag can be used to specify a program that doxygen should |
| Matt Briggs | 44:ece6330e9b57 | 879 | # invoke to filter for each input file. Doxygen will invoke the filter program |
| Matt Briggs | 44:ece6330e9b57 | 880 | # by executing (via popen()) the command: |
| Matt Briggs | 44:ece6330e9b57 | 881 | # |
| Matt Briggs | 44:ece6330e9b57 | 882 | # <filter> <input-file> |
| Matt Briggs | 44:ece6330e9b57 | 883 | # |
| Matt Briggs | 44:ece6330e9b57 | 884 | # where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the |
| Matt Briggs | 44:ece6330e9b57 | 885 | # name of an input file. Doxygen will then use the output that the filter |
| Matt Briggs | 44:ece6330e9b57 | 886 | # program writes to standard output. If FILTER_PATTERNS is specified, this tag |
| Matt Briggs | 44:ece6330e9b57 | 887 | # will be ignored. |
| Matt Briggs | 44:ece6330e9b57 | 888 | # |
| Matt Briggs | 44:ece6330e9b57 | 889 | # Note that the filter must not add or remove lines; it is applied before the |
| Matt Briggs | 44:ece6330e9b57 | 890 | # code is scanned, but not when the output code is generated. If lines are added |
| Matt Briggs | 44:ece6330e9b57 | 891 | # or removed, the anchors will not be placed correctly. |
| Matt Briggs | 44:ece6330e9b57 | 892 | # |
| Matt Briggs | 44:ece6330e9b57 | 893 | # Note that for custom extensions or not directly supported extensions you also |
| Matt Briggs | 44:ece6330e9b57 | 894 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not |
| Matt Briggs | 44:ece6330e9b57 | 895 | # properly processed by doxygen. |
| Matt Briggs | 44:ece6330e9b57 | 896 | |
| Matt Briggs | 44:ece6330e9b57 | 897 | INPUT_FILTER = |
| Matt Briggs | 44:ece6330e9b57 | 898 | |
| Matt Briggs | 44:ece6330e9b57 | 899 | # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern |
| Matt Briggs | 44:ece6330e9b57 | 900 | # basis. Doxygen will compare the file name with each pattern and apply the |
| Matt Briggs | 44:ece6330e9b57 | 901 | # filter if there is a match. The filters are a list of the form: pattern=filter |
| Matt Briggs | 44:ece6330e9b57 | 902 | # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how |
| Matt Briggs | 44:ece6330e9b57 | 903 | # filters are used. If the FILTER_PATTERNS tag is empty or if none of the |
| Matt Briggs | 44:ece6330e9b57 | 904 | # patterns match the file name, INPUT_FILTER is applied. |
| Matt Briggs | 44:ece6330e9b57 | 905 | # |
| Matt Briggs | 44:ece6330e9b57 | 906 | # Note that for custom extensions or not directly supported extensions you also |
| Matt Briggs | 44:ece6330e9b57 | 907 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not |
| Matt Briggs | 44:ece6330e9b57 | 908 | # properly processed by doxygen. |
| Matt Briggs | 44:ece6330e9b57 | 909 | |
| Matt Briggs | 44:ece6330e9b57 | 910 | FILTER_PATTERNS = |
| Matt Briggs | 44:ece6330e9b57 | 911 | |
| Matt Briggs | 44:ece6330e9b57 | 912 | # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using |
| Matt Briggs | 44:ece6330e9b57 | 913 | # INPUT_FILTER) will also be used to filter the input files that are used for |
| Matt Briggs | 44:ece6330e9b57 | 914 | # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). |
| Matt Briggs | 44:ece6330e9b57 | 915 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 916 | |
| Matt Briggs | 44:ece6330e9b57 | 917 | FILTER_SOURCE_FILES = NO |
| Matt Briggs | 44:ece6330e9b57 | 918 | |
| Matt Briggs | 44:ece6330e9b57 | 919 | # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file |
| Matt Briggs | 44:ece6330e9b57 | 920 | # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and |
| Matt Briggs | 44:ece6330e9b57 | 921 | # it is also possible to disable source filtering for a specific pattern using |
| Matt Briggs | 44:ece6330e9b57 | 922 | # *.ext= (so without naming a filter). |
| Matt Briggs | 44:ece6330e9b57 | 923 | # This tag requires that the tag FILTER_SOURCE_FILES is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 924 | |
| Matt Briggs | 44:ece6330e9b57 | 925 | FILTER_SOURCE_PATTERNS = |
| Matt Briggs | 44:ece6330e9b57 | 926 | |
| Matt Briggs | 44:ece6330e9b57 | 927 | # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that |
| Matt Briggs | 44:ece6330e9b57 | 928 | # is part of the input, its contents will be placed on the main page |
| Matt Briggs | 44:ece6330e9b57 | 929 | # (index.html). This can be useful if you have a project on for instance GitHub |
| Matt Briggs | 44:ece6330e9b57 | 930 | # and want to reuse the introduction page also for the doxygen output. |
| Matt Briggs | 44:ece6330e9b57 | 931 | |
| Matt Briggs | 44:ece6330e9b57 | 932 | USE_MDFILE_AS_MAINPAGE = |
| Matt Briggs | 44:ece6330e9b57 | 933 | |
| Matt Briggs | 44:ece6330e9b57 | 934 | #--------------------------------------------------------------------------- |
| Matt Briggs | 44:ece6330e9b57 | 935 | # Configuration options related to source browsing |
| Matt Briggs | 44:ece6330e9b57 | 936 | #--------------------------------------------------------------------------- |
| Matt Briggs | 44:ece6330e9b57 | 937 | |
| Matt Briggs | 44:ece6330e9b57 | 938 | # If the SOURCE_BROWSER tag is set to YES then a list of source files will be |
| Matt Briggs | 44:ece6330e9b57 | 939 | # generated. Documented entities will be cross-referenced with these sources. |
| Matt Briggs | 44:ece6330e9b57 | 940 | # |
| Matt Briggs | 44:ece6330e9b57 | 941 | # Note: To get rid of all source code in the generated output, make sure that |
| Matt Briggs | 44:ece6330e9b57 | 942 | # also VERBATIM_HEADERS is set to NO. |
| Matt Briggs | 44:ece6330e9b57 | 943 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 944 | |
| Matt Briggs | 44:ece6330e9b57 | 945 | SOURCE_BROWSER = YES |
| Matt Briggs | 44:ece6330e9b57 | 946 | |
| Matt Briggs | 44:ece6330e9b57 | 947 | # Setting the INLINE_SOURCES tag to YES will include the body of functions, |
| Matt Briggs | 44:ece6330e9b57 | 948 | # classes and enums directly into the documentation. |
| Matt Briggs | 44:ece6330e9b57 | 949 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 950 | |
| Matt Briggs | 44:ece6330e9b57 | 951 | INLINE_SOURCES = NO |
| Matt Briggs | 44:ece6330e9b57 | 952 | |
| Matt Briggs | 44:ece6330e9b57 | 953 | # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any |
| Matt Briggs | 44:ece6330e9b57 | 954 | # special comment blocks from generated source code fragments. Normal C, C++ and |
| Matt Briggs | 44:ece6330e9b57 | 955 | # Fortran comments will always remain visible. |
| Matt Briggs | 44:ece6330e9b57 | 956 | # The default value is: YES. |
| Matt Briggs | 44:ece6330e9b57 | 957 | |
| Matt Briggs | 44:ece6330e9b57 | 958 | STRIP_CODE_COMMENTS = YES |
| Matt Briggs | 44:ece6330e9b57 | 959 | |
| Matt Briggs | 44:ece6330e9b57 | 960 | # If the REFERENCED_BY_RELATION tag is set to YES then for each documented |
| Matt Briggs | 44:ece6330e9b57 | 961 | # function all documented functions referencing it will be listed. |
| Matt Briggs | 44:ece6330e9b57 | 962 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 963 | |
| Matt Briggs | 44:ece6330e9b57 | 964 | REFERENCED_BY_RELATION = YES |
| Matt Briggs | 44:ece6330e9b57 | 965 | |
| Matt Briggs | 44:ece6330e9b57 | 966 | # If the REFERENCES_RELATION tag is set to YES then for each documented function |
| Matt Briggs | 44:ece6330e9b57 | 967 | # all documented entities called/used by that function will be listed. |
| Matt Briggs | 44:ece6330e9b57 | 968 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 969 | |
| Matt Briggs | 44:ece6330e9b57 | 970 | REFERENCES_RELATION = YES |
| Matt Briggs | 44:ece6330e9b57 | 971 | |
| Matt Briggs | 44:ece6330e9b57 | 972 | # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set |
| Matt Briggs | 44:ece6330e9b57 | 973 | # to YES then the hyperlinks from functions in REFERENCES_RELATION and |
| Matt Briggs | 44:ece6330e9b57 | 974 | # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will |
| Matt Briggs | 44:ece6330e9b57 | 975 | # link to the documentation. |
| Matt Briggs | 44:ece6330e9b57 | 976 | # The default value is: YES. |
| Matt Briggs | 44:ece6330e9b57 | 977 | |
| Matt Briggs | 44:ece6330e9b57 | 978 | REFERENCES_LINK_SOURCE = YES |
| Matt Briggs | 44:ece6330e9b57 | 979 | |
| Matt Briggs | 44:ece6330e9b57 | 980 | # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the |
| Matt Briggs | 44:ece6330e9b57 | 981 | # source code will show a tooltip with additional information such as prototype, |
| Matt Briggs | 44:ece6330e9b57 | 982 | # brief description and links to the definition and documentation. Since this |
| Matt Briggs | 44:ece6330e9b57 | 983 | # will make the HTML file larger and loading of large files a bit slower, you |
| Matt Briggs | 44:ece6330e9b57 | 984 | # can opt to disable this feature. |
| Matt Briggs | 44:ece6330e9b57 | 985 | # The default value is: YES. |
| Matt Briggs | 44:ece6330e9b57 | 986 | # This tag requires that the tag SOURCE_BROWSER is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 987 | |
| Matt Briggs | 44:ece6330e9b57 | 988 | SOURCE_TOOLTIPS = YES |
| Matt Briggs | 44:ece6330e9b57 | 989 | |
| Matt Briggs | 44:ece6330e9b57 | 990 | # If the USE_HTAGS tag is set to YES then the references to source code will |
| Matt Briggs | 44:ece6330e9b57 | 991 | # point to the HTML generated by the htags(1) tool instead of doxygen built-in |
| Matt Briggs | 44:ece6330e9b57 | 992 | # source browser. The htags tool is part of GNU's global source tagging system |
| Matt Briggs | 44:ece6330e9b57 | 993 | # (see http://www.gnu.org/software/global/global.html). You will need version |
| Matt Briggs | 44:ece6330e9b57 | 994 | # 4.8.6 or higher. |
| Matt Briggs | 44:ece6330e9b57 | 995 | # |
| Matt Briggs | 44:ece6330e9b57 | 996 | # To use it do the following: |
| Matt Briggs | 44:ece6330e9b57 | 997 | # - Install the latest version of global |
| Matt Briggs | 44:ece6330e9b57 | 998 | # - Enable SOURCE_BROWSER and USE_HTAGS in the config file |
| Matt Briggs | 44:ece6330e9b57 | 999 | # - Make sure the INPUT points to the root of the source tree |
| Matt Briggs | 44:ece6330e9b57 | 1000 | # - Run doxygen as normal |
| Matt Briggs | 44:ece6330e9b57 | 1001 | # |
| Matt Briggs | 44:ece6330e9b57 | 1002 | # Doxygen will invoke htags (and that will in turn invoke gtags), so these |
| Matt Briggs | 44:ece6330e9b57 | 1003 | # tools must be available from the command line (i.e. in the search path). |
| Matt Briggs | 44:ece6330e9b57 | 1004 | # |
| Matt Briggs | 44:ece6330e9b57 | 1005 | # The result: instead of the source browser generated by doxygen, the links to |
| Matt Briggs | 44:ece6330e9b57 | 1006 | # source code will now point to the output of htags. |
| Matt Briggs | 44:ece6330e9b57 | 1007 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 1008 | # This tag requires that the tag SOURCE_BROWSER is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1009 | |
| Matt Briggs | 44:ece6330e9b57 | 1010 | USE_HTAGS = NO |
| Matt Briggs | 44:ece6330e9b57 | 1011 | |
| Matt Briggs | 44:ece6330e9b57 | 1012 | # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a |
| Matt Briggs | 44:ece6330e9b57 | 1013 | # verbatim copy of the header file for each class for which an include is |
| Matt Briggs | 44:ece6330e9b57 | 1014 | # specified. Set to NO to disable this. |
| Matt Briggs | 44:ece6330e9b57 | 1015 | # See also: Section \class. |
| Matt Briggs | 44:ece6330e9b57 | 1016 | # The default value is: YES. |
| Matt Briggs | 44:ece6330e9b57 | 1017 | |
| Matt Briggs | 44:ece6330e9b57 | 1018 | VERBATIM_HEADERS = YES |
| Matt Briggs | 44:ece6330e9b57 | 1019 | |
| Matt Briggs | 44:ece6330e9b57 | 1020 | # If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the |
| Matt Briggs | 44:ece6330e9b57 | 1021 | # clang parser (see: http://clang.llvm.org/) for more accurate parsing at the |
| Matt Briggs | 44:ece6330e9b57 | 1022 | # cost of reduced performance. This can be particularly helpful with template |
| Matt Briggs | 44:ece6330e9b57 | 1023 | # rich C++ code for which doxygen's built-in parser lacks the necessary type |
| Matt Briggs | 44:ece6330e9b57 | 1024 | # information. |
| Matt Briggs | 44:ece6330e9b57 | 1025 | # Note: The availability of this option depends on whether or not doxygen was |
| Matt Briggs | 44:ece6330e9b57 | 1026 | # generated with the -Duse-libclang=ON option for CMake. |
| Matt Briggs | 44:ece6330e9b57 | 1027 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 1028 | |
| Matt Briggs | 44:ece6330e9b57 | 1029 | CLANG_ASSISTED_PARSING = NO |
| Matt Briggs | 44:ece6330e9b57 | 1030 | |
| Matt Briggs | 44:ece6330e9b57 | 1031 | # If clang assisted parsing is enabled you can provide the compiler with command |
| Matt Briggs | 44:ece6330e9b57 | 1032 | # line options that you would normally use when invoking the compiler. Note that |
| Matt Briggs | 44:ece6330e9b57 | 1033 | # the include paths will already be set by doxygen for the files and directories |
| Matt Briggs | 44:ece6330e9b57 | 1034 | # specified with INPUT and INCLUDE_PATH. |
| Matt Briggs | 44:ece6330e9b57 | 1035 | # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1036 | |
| Matt Briggs | 44:ece6330e9b57 | 1037 | CLANG_OPTIONS = |
| Matt Briggs | 44:ece6330e9b57 | 1038 | |
| Matt Briggs | 44:ece6330e9b57 | 1039 | #--------------------------------------------------------------------------- |
| Matt Briggs | 44:ece6330e9b57 | 1040 | # Configuration options related to the alphabetical class index |
| Matt Briggs | 44:ece6330e9b57 | 1041 | #--------------------------------------------------------------------------- |
| Matt Briggs | 44:ece6330e9b57 | 1042 | |
| Matt Briggs | 44:ece6330e9b57 | 1043 | # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all |
| Matt Briggs | 44:ece6330e9b57 | 1044 | # compounds will be generated. Enable this if the project contains a lot of |
| Matt Briggs | 44:ece6330e9b57 | 1045 | # classes, structs, unions or interfaces. |
| Matt Briggs | 44:ece6330e9b57 | 1046 | # The default value is: YES. |
| Matt Briggs | 44:ece6330e9b57 | 1047 | |
| Matt Briggs | 44:ece6330e9b57 | 1048 | ALPHABETICAL_INDEX = YES |
| Matt Briggs | 44:ece6330e9b57 | 1049 | |
| Matt Briggs | 44:ece6330e9b57 | 1050 | # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in |
| Matt Briggs | 44:ece6330e9b57 | 1051 | # which the alphabetical index list will be split. |
| Matt Briggs | 44:ece6330e9b57 | 1052 | # Minimum value: 1, maximum value: 20, default value: 5. |
| Matt Briggs | 44:ece6330e9b57 | 1053 | # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1054 | |
| Matt Briggs | 44:ece6330e9b57 | 1055 | COLS_IN_ALPHA_INDEX = 5 |
| Matt Briggs | 44:ece6330e9b57 | 1056 | |
| Matt Briggs | 44:ece6330e9b57 | 1057 | # In case all classes in a project start with a common prefix, all classes will |
| Matt Briggs | 44:ece6330e9b57 | 1058 | # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag |
| Matt Briggs | 44:ece6330e9b57 | 1059 | # can be used to specify a prefix (or a list of prefixes) that should be ignored |
| Matt Briggs | 44:ece6330e9b57 | 1060 | # while generating the index headers. |
| Matt Briggs | 44:ece6330e9b57 | 1061 | # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1062 | |
| Matt Briggs | 44:ece6330e9b57 | 1063 | IGNORE_PREFIX = |
| Matt Briggs | 44:ece6330e9b57 | 1064 | |
| Matt Briggs | 44:ece6330e9b57 | 1065 | #--------------------------------------------------------------------------- |
| Matt Briggs | 44:ece6330e9b57 | 1066 | # Configuration options related to the HTML output |
| Matt Briggs | 44:ece6330e9b57 | 1067 | #--------------------------------------------------------------------------- |
| Matt Briggs | 44:ece6330e9b57 | 1068 | |
| Matt Briggs | 44:ece6330e9b57 | 1069 | # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output |
| Matt Briggs | 44:ece6330e9b57 | 1070 | # The default value is: YES. |
| Matt Briggs | 44:ece6330e9b57 | 1071 | |
| Matt Briggs | 44:ece6330e9b57 | 1072 | GENERATE_HTML = YES |
| Matt Briggs | 44:ece6330e9b57 | 1073 | |
| Matt Briggs | 44:ece6330e9b57 | 1074 | # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a |
| Matt Briggs | 44:ece6330e9b57 | 1075 | # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of |
| Matt Briggs | 44:ece6330e9b57 | 1076 | # it. |
| Matt Briggs | 44:ece6330e9b57 | 1077 | # The default directory is: html. |
| Matt Briggs | 44:ece6330e9b57 | 1078 | # This tag requires that the tag GENERATE_HTML is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1079 | |
| Matt Briggs | 44:ece6330e9b57 | 1080 | HTML_OUTPUT = html |
| Matt Briggs | 44:ece6330e9b57 | 1081 | |
| Matt Briggs | 44:ece6330e9b57 | 1082 | # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each |
| Matt Briggs | 44:ece6330e9b57 | 1083 | # generated HTML page (for example: .htm, .php, .asp). |
| Matt Briggs | 44:ece6330e9b57 | 1084 | # The default value is: .html. |
| Matt Briggs | 44:ece6330e9b57 | 1085 | # This tag requires that the tag GENERATE_HTML is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1086 | |
| Matt Briggs | 44:ece6330e9b57 | 1087 | HTML_FILE_EXTENSION = .html |
| Matt Briggs | 44:ece6330e9b57 | 1088 | |
| Matt Briggs | 44:ece6330e9b57 | 1089 | # The HTML_HEADER tag can be used to specify a user-defined HTML header file for |
| Matt Briggs | 44:ece6330e9b57 | 1090 | # each generated HTML page. If the tag is left blank doxygen will generate a |
| Matt Briggs | 44:ece6330e9b57 | 1091 | # standard header. |
| Matt Briggs | 44:ece6330e9b57 | 1092 | # |
| Matt Briggs | 44:ece6330e9b57 | 1093 | # To get valid HTML the header file that includes any scripts and style sheets |
| Matt Briggs | 44:ece6330e9b57 | 1094 | # that doxygen needs, which is dependent on the configuration options used (e.g. |
| Matt Briggs | 44:ece6330e9b57 | 1095 | # the setting GENERATE_TREEVIEW). It is highly recommended to start with a |
| Matt Briggs | 44:ece6330e9b57 | 1096 | # default header using |
| Matt Briggs | 44:ece6330e9b57 | 1097 | # doxygen -w html new_header.html new_footer.html new_stylesheet.css |
| Matt Briggs | 44:ece6330e9b57 | 1098 | # YourConfigFile |
| Matt Briggs | 44:ece6330e9b57 | 1099 | # and then modify the file new_header.html. See also section "Doxygen usage" |
| Matt Briggs | 44:ece6330e9b57 | 1100 | # for information on how to generate the default header that doxygen normally |
| Matt Briggs | 44:ece6330e9b57 | 1101 | # uses. |
| Matt Briggs | 44:ece6330e9b57 | 1102 | # Note: The header is subject to change so you typically have to regenerate the |
| Matt Briggs | 44:ece6330e9b57 | 1103 | # default header when upgrading to a newer version of doxygen. For a description |
| Matt Briggs | 44:ece6330e9b57 | 1104 | # of the possible markers and block names see the documentation. |
| Matt Briggs | 44:ece6330e9b57 | 1105 | # This tag requires that the tag GENERATE_HTML is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1106 | |
| Matt Briggs | 44:ece6330e9b57 | 1107 | HTML_HEADER = |
| Matt Briggs | 44:ece6330e9b57 | 1108 | |
| Matt Briggs | 44:ece6330e9b57 | 1109 | # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each |
| Matt Briggs | 44:ece6330e9b57 | 1110 | # generated HTML page. If the tag is left blank doxygen will generate a standard |
| Matt Briggs | 44:ece6330e9b57 | 1111 | # footer. See HTML_HEADER for more information on how to generate a default |
| Matt Briggs | 44:ece6330e9b57 | 1112 | # footer and what special commands can be used inside the footer. See also |
| Matt Briggs | 44:ece6330e9b57 | 1113 | # section "Doxygen usage" for information on how to generate the default footer |
| Matt Briggs | 44:ece6330e9b57 | 1114 | # that doxygen normally uses. |
| Matt Briggs | 44:ece6330e9b57 | 1115 | # This tag requires that the tag GENERATE_HTML is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1116 | |
| Matt Briggs | 44:ece6330e9b57 | 1117 | HTML_FOOTER = |
| Matt Briggs | 44:ece6330e9b57 | 1118 | |
| Matt Briggs | 44:ece6330e9b57 | 1119 | # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style |
| Matt Briggs | 44:ece6330e9b57 | 1120 | # sheet that is used by each HTML page. It can be used to fine-tune the look of |
| Matt Briggs | 44:ece6330e9b57 | 1121 | # the HTML output. If left blank doxygen will generate a default style sheet. |
| Matt Briggs | 44:ece6330e9b57 | 1122 | # See also section "Doxygen usage" for information on how to generate the style |
| Matt Briggs | 44:ece6330e9b57 | 1123 | # sheet that doxygen normally uses. |
| Matt Briggs | 44:ece6330e9b57 | 1124 | # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as |
| Matt Briggs | 44:ece6330e9b57 | 1125 | # it is more robust and this tag (HTML_STYLESHEET) will in the future become |
| Matt Briggs | 44:ece6330e9b57 | 1126 | # obsolete. |
| Matt Briggs | 44:ece6330e9b57 | 1127 | # This tag requires that the tag GENERATE_HTML is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1128 | |
| Matt Briggs | 44:ece6330e9b57 | 1129 | HTML_STYLESHEET = |
| Matt Briggs | 44:ece6330e9b57 | 1130 | |
| Matt Briggs | 44:ece6330e9b57 | 1131 | # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined |
| Matt Briggs | 44:ece6330e9b57 | 1132 | # cascading style sheets that are included after the standard style sheets |
| Matt Briggs | 44:ece6330e9b57 | 1133 | # created by doxygen. Using this option one can overrule certain style aspects. |
| Matt Briggs | 44:ece6330e9b57 | 1134 | # This is preferred over using HTML_STYLESHEET since it does not replace the |
| Matt Briggs | 44:ece6330e9b57 | 1135 | # standard style sheet and is therefore more robust against future updates. |
| Matt Briggs | 44:ece6330e9b57 | 1136 | # Doxygen will copy the style sheet files to the output directory. |
| Matt Briggs | 44:ece6330e9b57 | 1137 | # Note: The order of the extra style sheet files is of importance (e.g. the last |
| Matt Briggs | 44:ece6330e9b57 | 1138 | # style sheet in the list overrules the setting of the previous ones in the |
| Matt Briggs | 44:ece6330e9b57 | 1139 | # list). For an example see the documentation. |
| Matt Briggs | 44:ece6330e9b57 | 1140 | # This tag requires that the tag GENERATE_HTML is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1141 | |
| Matt Briggs | 44:ece6330e9b57 | 1142 | HTML_EXTRA_STYLESHEET = |
| Matt Briggs | 44:ece6330e9b57 | 1143 | |
| Matt Briggs | 44:ece6330e9b57 | 1144 | # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or |
| Matt Briggs | 44:ece6330e9b57 | 1145 | # other source files which should be copied to the HTML output directory. Note |
| Matt Briggs | 44:ece6330e9b57 | 1146 | # that these files will be copied to the base HTML output directory. Use the |
| Matt Briggs | 44:ece6330e9b57 | 1147 | # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these |
| Matt Briggs | 44:ece6330e9b57 | 1148 | # files. In the HTML_STYLESHEET file, use the file name only. Also note that the |
| Matt Briggs | 44:ece6330e9b57 | 1149 | # files will be copied as-is; there are no commands or markers available. |
| Matt Briggs | 44:ece6330e9b57 | 1150 | # This tag requires that the tag GENERATE_HTML is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1151 | |
| Matt Briggs | 44:ece6330e9b57 | 1152 | HTML_EXTRA_FILES = |
| Matt Briggs | 44:ece6330e9b57 | 1153 | |
| Matt Briggs | 44:ece6330e9b57 | 1154 | # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen |
| Matt Briggs | 44:ece6330e9b57 | 1155 | # will adjust the colors in the style sheet and background images according to |
| Matt Briggs | 44:ece6330e9b57 | 1156 | # this color. Hue is specified as an angle on a colorwheel, see |
| Matt Briggs | 44:ece6330e9b57 | 1157 | # http://en.wikipedia.org/wiki/Hue for more information. For instance the value |
| Matt Briggs | 44:ece6330e9b57 | 1158 | # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 |
| Matt Briggs | 44:ece6330e9b57 | 1159 | # purple, and 360 is red again. |
| Matt Briggs | 44:ece6330e9b57 | 1160 | # Minimum value: 0, maximum value: 359, default value: 220. |
| Matt Briggs | 44:ece6330e9b57 | 1161 | # This tag requires that the tag GENERATE_HTML is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1162 | |
| Matt Briggs | 44:ece6330e9b57 | 1163 | HTML_COLORSTYLE_HUE = 220 |
| Matt Briggs | 44:ece6330e9b57 | 1164 | |
| Matt Briggs | 44:ece6330e9b57 | 1165 | # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors |
| Matt Briggs | 44:ece6330e9b57 | 1166 | # in the HTML output. For a value of 0 the output will use grayscales only. A |
| Matt Briggs | 44:ece6330e9b57 | 1167 | # value of 255 will produce the most vivid colors. |
| Matt Briggs | 44:ece6330e9b57 | 1168 | # Minimum value: 0, maximum value: 255, default value: 100. |
| Matt Briggs | 44:ece6330e9b57 | 1169 | # This tag requires that the tag GENERATE_HTML is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1170 | |
| Matt Briggs | 44:ece6330e9b57 | 1171 | HTML_COLORSTYLE_SAT = 100 |
| Matt Briggs | 44:ece6330e9b57 | 1172 | |
| Matt Briggs | 44:ece6330e9b57 | 1173 | # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the |
| Matt Briggs | 44:ece6330e9b57 | 1174 | # luminance component of the colors in the HTML output. Values below 100 |
| Matt Briggs | 44:ece6330e9b57 | 1175 | # gradually make the output lighter, whereas values above 100 make the output |
| Matt Briggs | 44:ece6330e9b57 | 1176 | # darker. The value divided by 100 is the actual gamma applied, so 80 represents |
| Matt Briggs | 44:ece6330e9b57 | 1177 | # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not |
| Matt Briggs | 44:ece6330e9b57 | 1178 | # change the gamma. |
| Matt Briggs | 44:ece6330e9b57 | 1179 | # Minimum value: 40, maximum value: 240, default value: 80. |
| Matt Briggs | 44:ece6330e9b57 | 1180 | # This tag requires that the tag GENERATE_HTML is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1181 | |
| Matt Briggs | 44:ece6330e9b57 | 1182 | HTML_COLORSTYLE_GAMMA = 80 |
| Matt Briggs | 44:ece6330e9b57 | 1183 | |
| Matt Briggs | 44:ece6330e9b57 | 1184 | # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML |
| Matt Briggs | 44:ece6330e9b57 | 1185 | # page will contain the date and time when the page was generated. Setting this |
| Matt Briggs | 44:ece6330e9b57 | 1186 | # to YES can help to show when doxygen was last run and thus if the |
| Matt Briggs | 44:ece6330e9b57 | 1187 | # documentation is up to date. |
| Matt Briggs | 44:ece6330e9b57 | 1188 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 1189 | # This tag requires that the tag GENERATE_HTML is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1190 | |
| Matt Briggs | 44:ece6330e9b57 | 1191 | HTML_TIMESTAMP = NO |
| Matt Briggs | 44:ece6330e9b57 | 1192 | |
| Matt Briggs | 44:ece6330e9b57 | 1193 | # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML |
| Matt Briggs | 44:ece6330e9b57 | 1194 | # documentation will contain sections that can be hidden and shown after the |
| Matt Briggs | 44:ece6330e9b57 | 1195 | # page has loaded. |
| Matt Briggs | 44:ece6330e9b57 | 1196 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 1197 | # This tag requires that the tag GENERATE_HTML is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1198 | |
| Matt Briggs | 44:ece6330e9b57 | 1199 | HTML_DYNAMIC_SECTIONS = NO |
| Matt Briggs | 44:ece6330e9b57 | 1200 | |
| Matt Briggs | 44:ece6330e9b57 | 1201 | # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries |
| Matt Briggs | 44:ece6330e9b57 | 1202 | # shown in the various tree structured indices initially; the user can expand |
| Matt Briggs | 44:ece6330e9b57 | 1203 | # and collapse entries dynamically later on. Doxygen will expand the tree to |
| Matt Briggs | 44:ece6330e9b57 | 1204 | # such a level that at most the specified number of entries are visible (unless |
| Matt Briggs | 44:ece6330e9b57 | 1205 | # a fully collapsed tree already exceeds this amount). So setting the number of |
| Matt Briggs | 44:ece6330e9b57 | 1206 | # entries 1 will produce a full collapsed tree by default. 0 is a special value |
| Matt Briggs | 44:ece6330e9b57 | 1207 | # representing an infinite number of entries and will result in a full expanded |
| Matt Briggs | 44:ece6330e9b57 | 1208 | # tree by default. |
| Matt Briggs | 44:ece6330e9b57 | 1209 | # Minimum value: 0, maximum value: 9999, default value: 100. |
| Matt Briggs | 44:ece6330e9b57 | 1210 | # This tag requires that the tag GENERATE_HTML is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1211 | |
| Matt Briggs | 44:ece6330e9b57 | 1212 | HTML_INDEX_NUM_ENTRIES = 100 |
| Matt Briggs | 44:ece6330e9b57 | 1213 | |
| Matt Briggs | 44:ece6330e9b57 | 1214 | # If the GENERATE_DOCSET tag is set to YES, additional index files will be |
| Matt Briggs | 44:ece6330e9b57 | 1215 | # generated that can be used as input for Apple's Xcode 3 integrated development |
| Matt Briggs | 44:ece6330e9b57 | 1216 | # environment (see: http://developer.apple.com/tools/xcode/), introduced with |
| Matt Briggs | 44:ece6330e9b57 | 1217 | # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a |
| Matt Briggs | 44:ece6330e9b57 | 1218 | # Makefile in the HTML output directory. Running make will produce the docset in |
| Matt Briggs | 44:ece6330e9b57 | 1219 | # that directory and running make install will install the docset in |
| Matt Briggs | 44:ece6330e9b57 | 1220 | # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at |
| Matt Briggs | 44:ece6330e9b57 | 1221 | # startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html |
| Matt Briggs | 44:ece6330e9b57 | 1222 | # for more information. |
| Matt Briggs | 44:ece6330e9b57 | 1223 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 1224 | # This tag requires that the tag GENERATE_HTML is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1225 | |
| Matt Briggs | 44:ece6330e9b57 | 1226 | GENERATE_DOCSET = NO |
| Matt Briggs | 44:ece6330e9b57 | 1227 | |
| Matt Briggs | 44:ece6330e9b57 | 1228 | # This tag determines the name of the docset feed. A documentation feed provides |
| Matt Briggs | 44:ece6330e9b57 | 1229 | # an umbrella under which multiple documentation sets from a single provider |
| Matt Briggs | 44:ece6330e9b57 | 1230 | # (such as a company or product suite) can be grouped. |
| Matt Briggs | 44:ece6330e9b57 | 1231 | # The default value is: Doxygen generated docs. |
| Matt Briggs | 44:ece6330e9b57 | 1232 | # This tag requires that the tag GENERATE_DOCSET is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1233 | |
| Matt Briggs | 44:ece6330e9b57 | 1234 | DOCSET_FEEDNAME = "Doxygen generated docs" |
| Matt Briggs | 44:ece6330e9b57 | 1235 | |
| Matt Briggs | 44:ece6330e9b57 | 1236 | # This tag specifies a string that should uniquely identify the documentation |
| Matt Briggs | 44:ece6330e9b57 | 1237 | # set bundle. This should be a reverse domain-name style string, e.g. |
| Matt Briggs | 44:ece6330e9b57 | 1238 | # com.mycompany.MyDocSet. Doxygen will append .docset to the name. |
| Matt Briggs | 44:ece6330e9b57 | 1239 | # The default value is: org.doxygen.Project. |
| Matt Briggs | 44:ece6330e9b57 | 1240 | # This tag requires that the tag GENERATE_DOCSET is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1241 | |
| Matt Briggs | 44:ece6330e9b57 | 1242 | DOCSET_BUNDLE_ID = org.doxygen.Project |
| Matt Briggs | 44:ece6330e9b57 | 1243 | |
| Matt Briggs | 44:ece6330e9b57 | 1244 | # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify |
| Matt Briggs | 44:ece6330e9b57 | 1245 | # the documentation publisher. This should be a reverse domain-name style |
| Matt Briggs | 44:ece6330e9b57 | 1246 | # string, e.g. com.mycompany.MyDocSet.documentation. |
| Matt Briggs | 44:ece6330e9b57 | 1247 | # The default value is: org.doxygen.Publisher. |
| Matt Briggs | 44:ece6330e9b57 | 1248 | # This tag requires that the tag GENERATE_DOCSET is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1249 | |
| Matt Briggs | 44:ece6330e9b57 | 1250 | DOCSET_PUBLISHER_ID = org.doxygen.Publisher |
| Matt Briggs | 44:ece6330e9b57 | 1251 | |
| Matt Briggs | 44:ece6330e9b57 | 1252 | # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. |
| Matt Briggs | 44:ece6330e9b57 | 1253 | # The default value is: Publisher. |
| Matt Briggs | 44:ece6330e9b57 | 1254 | # This tag requires that the tag GENERATE_DOCSET is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1255 | |
| Matt Briggs | 44:ece6330e9b57 | 1256 | DOCSET_PUBLISHER_NAME = Publisher |
| Matt Briggs | 44:ece6330e9b57 | 1257 | |
| Matt Briggs | 44:ece6330e9b57 | 1258 | # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three |
| Matt Briggs | 44:ece6330e9b57 | 1259 | # additional HTML index files: index.hhp, index.hhc, and index.hhk. The |
| Matt Briggs | 44:ece6330e9b57 | 1260 | # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop |
| Matt Briggs | 44:ece6330e9b57 | 1261 | # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on |
| Matt Briggs | 44:ece6330e9b57 | 1262 | # Windows. |
| Matt Briggs | 44:ece6330e9b57 | 1263 | # |
| Matt Briggs | 44:ece6330e9b57 | 1264 | # The HTML Help Workshop contains a compiler that can convert all HTML output |
| Matt Briggs | 44:ece6330e9b57 | 1265 | # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML |
| Matt Briggs | 44:ece6330e9b57 | 1266 | # files are now used as the Windows 98 help format, and will replace the old |
| Matt Briggs | 44:ece6330e9b57 | 1267 | # Windows help format (.hlp) on all Windows platforms in the future. Compressed |
| Matt Briggs | 44:ece6330e9b57 | 1268 | # HTML files also contain an index, a table of contents, and you can search for |
| Matt Briggs | 44:ece6330e9b57 | 1269 | # words in the documentation. The HTML workshop also contains a viewer for |
| Matt Briggs | 44:ece6330e9b57 | 1270 | # compressed HTML files. |
| Matt Briggs | 44:ece6330e9b57 | 1271 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 1272 | # This tag requires that the tag GENERATE_HTML is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1273 | |
| Matt Briggs | 44:ece6330e9b57 | 1274 | GENERATE_HTMLHELP = NO |
| Matt Briggs | 44:ece6330e9b57 | 1275 | |
| Matt Briggs | 44:ece6330e9b57 | 1276 | # The CHM_FILE tag can be used to specify the file name of the resulting .chm |
| Matt Briggs | 44:ece6330e9b57 | 1277 | # file. You can add a path in front of the file if the result should not be |
| Matt Briggs | 44:ece6330e9b57 | 1278 | # written to the html output directory. |
| Matt Briggs | 44:ece6330e9b57 | 1279 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1280 | |
| Matt Briggs | 44:ece6330e9b57 | 1281 | CHM_FILE = |
| Matt Briggs | 44:ece6330e9b57 | 1282 | |
| Matt Briggs | 44:ece6330e9b57 | 1283 | # The HHC_LOCATION tag can be used to specify the location (absolute path |
| Matt Briggs | 44:ece6330e9b57 | 1284 | # including file name) of the HTML help compiler (hhc.exe). If non-empty, |
| Matt Briggs | 44:ece6330e9b57 | 1285 | # doxygen will try to run the HTML help compiler on the generated index.hhp. |
| Matt Briggs | 44:ece6330e9b57 | 1286 | # The file has to be specified with full path. |
| Matt Briggs | 44:ece6330e9b57 | 1287 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1288 | |
| Matt Briggs | 44:ece6330e9b57 | 1289 | HHC_LOCATION = |
| Matt Briggs | 44:ece6330e9b57 | 1290 | |
| Matt Briggs | 44:ece6330e9b57 | 1291 | # The GENERATE_CHI flag controls if a separate .chi index file is generated |
| Matt Briggs | 44:ece6330e9b57 | 1292 | # (YES) or that it should be included in the master .chm file (NO). |
| Matt Briggs | 44:ece6330e9b57 | 1293 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 1294 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1295 | |
| Matt Briggs | 44:ece6330e9b57 | 1296 | GENERATE_CHI = NO |
| Matt Briggs | 44:ece6330e9b57 | 1297 | |
| Matt Briggs | 44:ece6330e9b57 | 1298 | # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) |
| Matt Briggs | 44:ece6330e9b57 | 1299 | # and project file content. |
| Matt Briggs | 44:ece6330e9b57 | 1300 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1301 | |
| Matt Briggs | 44:ece6330e9b57 | 1302 | CHM_INDEX_ENCODING = |
| Matt Briggs | 44:ece6330e9b57 | 1303 | |
| Matt Briggs | 44:ece6330e9b57 | 1304 | # The BINARY_TOC flag controls whether a binary table of contents is generated |
| Matt Briggs | 44:ece6330e9b57 | 1305 | # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it |
| Matt Briggs | 44:ece6330e9b57 | 1306 | # enables the Previous and Next buttons. |
| Matt Briggs | 44:ece6330e9b57 | 1307 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 1308 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1309 | |
| Matt Briggs | 44:ece6330e9b57 | 1310 | BINARY_TOC = NO |
| Matt Briggs | 44:ece6330e9b57 | 1311 | |
| Matt Briggs | 44:ece6330e9b57 | 1312 | # The TOC_EXPAND flag can be set to YES to add extra items for group members to |
| Matt Briggs | 44:ece6330e9b57 | 1313 | # the table of contents of the HTML help documentation and to the tree view. |
| Matt Briggs | 44:ece6330e9b57 | 1314 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 1315 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1316 | |
| Matt Briggs | 44:ece6330e9b57 | 1317 | TOC_EXPAND = NO |
| Matt Briggs | 44:ece6330e9b57 | 1318 | |
| Matt Briggs | 44:ece6330e9b57 | 1319 | # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and |
| Matt Briggs | 44:ece6330e9b57 | 1320 | # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that |
| Matt Briggs | 44:ece6330e9b57 | 1321 | # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help |
| Matt Briggs | 44:ece6330e9b57 | 1322 | # (.qch) of the generated HTML documentation. |
| Matt Briggs | 44:ece6330e9b57 | 1323 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 1324 | # This tag requires that the tag GENERATE_HTML is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1325 | |
| Matt Briggs | 44:ece6330e9b57 | 1326 | GENERATE_QHP = NO |
| Matt Briggs | 44:ece6330e9b57 | 1327 | |
| Matt Briggs | 44:ece6330e9b57 | 1328 | # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify |
| Matt Briggs | 44:ece6330e9b57 | 1329 | # the file name of the resulting .qch file. The path specified is relative to |
| Matt Briggs | 44:ece6330e9b57 | 1330 | # the HTML output folder. |
| Matt Briggs | 44:ece6330e9b57 | 1331 | # This tag requires that the tag GENERATE_QHP is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1332 | |
| Matt Briggs | 44:ece6330e9b57 | 1333 | QCH_FILE = |
| Matt Briggs | 44:ece6330e9b57 | 1334 | |
| Matt Briggs | 44:ece6330e9b57 | 1335 | # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help |
| Matt Briggs | 44:ece6330e9b57 | 1336 | # Project output. For more information please see Qt Help Project / Namespace |
| Matt Briggs | 44:ece6330e9b57 | 1337 | # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). |
| Matt Briggs | 44:ece6330e9b57 | 1338 | # The default value is: org.doxygen.Project. |
| Matt Briggs | 44:ece6330e9b57 | 1339 | # This tag requires that the tag GENERATE_QHP is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1340 | |
| Matt Briggs | 44:ece6330e9b57 | 1341 | QHP_NAMESPACE = org.doxygen.Project |
| Matt Briggs | 44:ece6330e9b57 | 1342 | |
| Matt Briggs | 44:ece6330e9b57 | 1343 | # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt |
| Matt Briggs | 44:ece6330e9b57 | 1344 | # Help Project output. For more information please see Qt Help Project / Virtual |
| Matt Briggs | 44:ece6330e9b57 | 1345 | # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- |
| Matt Briggs | 44:ece6330e9b57 | 1346 | # folders). |
| Matt Briggs | 44:ece6330e9b57 | 1347 | # The default value is: doc. |
| Matt Briggs | 44:ece6330e9b57 | 1348 | # This tag requires that the tag GENERATE_QHP is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1349 | |
| Matt Briggs | 44:ece6330e9b57 | 1350 | QHP_VIRTUAL_FOLDER = doc |
| Matt Briggs | 44:ece6330e9b57 | 1351 | |
| Matt Briggs | 44:ece6330e9b57 | 1352 | # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom |
| Matt Briggs | 44:ece6330e9b57 | 1353 | # filter to add. For more information please see Qt Help Project / Custom |
| Matt Briggs | 44:ece6330e9b57 | 1354 | # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- |
| Matt Briggs | 44:ece6330e9b57 | 1355 | # filters). |
| Matt Briggs | 44:ece6330e9b57 | 1356 | # This tag requires that the tag GENERATE_QHP is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1357 | |
| Matt Briggs | 44:ece6330e9b57 | 1358 | QHP_CUST_FILTER_NAME = |
| Matt Briggs | 44:ece6330e9b57 | 1359 | |
| Matt Briggs | 44:ece6330e9b57 | 1360 | # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the |
| Matt Briggs | 44:ece6330e9b57 | 1361 | # custom filter to add. For more information please see Qt Help Project / Custom |
| Matt Briggs | 44:ece6330e9b57 | 1362 | # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- |
| Matt Briggs | 44:ece6330e9b57 | 1363 | # filters). |
| Matt Briggs | 44:ece6330e9b57 | 1364 | # This tag requires that the tag GENERATE_QHP is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1365 | |
| Matt Briggs | 44:ece6330e9b57 | 1366 | QHP_CUST_FILTER_ATTRS = |
| Matt Briggs | 44:ece6330e9b57 | 1367 | |
| Matt Briggs | 44:ece6330e9b57 | 1368 | # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this |
| Matt Briggs | 44:ece6330e9b57 | 1369 | # project's filter section matches. Qt Help Project / Filter Attributes (see: |
| Matt Briggs | 44:ece6330e9b57 | 1370 | # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). |
| Matt Briggs | 44:ece6330e9b57 | 1371 | # This tag requires that the tag GENERATE_QHP is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1372 | |
| Matt Briggs | 44:ece6330e9b57 | 1373 | QHP_SECT_FILTER_ATTRS = |
| Matt Briggs | 44:ece6330e9b57 | 1374 | |
| Matt Briggs | 44:ece6330e9b57 | 1375 | # The QHG_LOCATION tag can be used to specify the location of Qt's |
| Matt Briggs | 44:ece6330e9b57 | 1376 | # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the |
| Matt Briggs | 44:ece6330e9b57 | 1377 | # generated .qhp file. |
| Matt Briggs | 44:ece6330e9b57 | 1378 | # This tag requires that the tag GENERATE_QHP is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1379 | |
| Matt Briggs | 44:ece6330e9b57 | 1380 | QHG_LOCATION = |
| Matt Briggs | 44:ece6330e9b57 | 1381 | |
| Matt Briggs | 44:ece6330e9b57 | 1382 | # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be |
| Matt Briggs | 44:ece6330e9b57 | 1383 | # generated, together with the HTML files, they form an Eclipse help plugin. To |
| Matt Briggs | 44:ece6330e9b57 | 1384 | # install this plugin and make it available under the help contents menu in |
| Matt Briggs | 44:ece6330e9b57 | 1385 | # Eclipse, the contents of the directory containing the HTML and XML files needs |
| Matt Briggs | 44:ece6330e9b57 | 1386 | # to be copied into the plugins directory of eclipse. The name of the directory |
| Matt Briggs | 44:ece6330e9b57 | 1387 | # within the plugins directory should be the same as the ECLIPSE_DOC_ID value. |
| Matt Briggs | 44:ece6330e9b57 | 1388 | # After copying Eclipse needs to be restarted before the help appears. |
| Matt Briggs | 44:ece6330e9b57 | 1389 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 1390 | # This tag requires that the tag GENERATE_HTML is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1391 | |
| Matt Briggs | 44:ece6330e9b57 | 1392 | GENERATE_ECLIPSEHELP = NO |
| Matt Briggs | 44:ece6330e9b57 | 1393 | |
| Matt Briggs | 44:ece6330e9b57 | 1394 | # A unique identifier for the Eclipse help plugin. When installing the plugin |
| Matt Briggs | 44:ece6330e9b57 | 1395 | # the directory name containing the HTML and XML files should also have this |
| Matt Briggs | 44:ece6330e9b57 | 1396 | # name. Each documentation set should have its own identifier. |
| Matt Briggs | 44:ece6330e9b57 | 1397 | # The default value is: org.doxygen.Project. |
| Matt Briggs | 44:ece6330e9b57 | 1398 | # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1399 | |
| Matt Briggs | 44:ece6330e9b57 | 1400 | ECLIPSE_DOC_ID = org.doxygen.Project |
| Matt Briggs | 44:ece6330e9b57 | 1401 | |
| Matt Briggs | 44:ece6330e9b57 | 1402 | # If you want full control over the layout of the generated HTML pages it might |
| Matt Briggs | 44:ece6330e9b57 | 1403 | # be necessary to disable the index and replace it with your own. The |
| Matt Briggs | 44:ece6330e9b57 | 1404 | # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top |
| Matt Briggs | 44:ece6330e9b57 | 1405 | # of each HTML page. A value of NO enables the index and the value YES disables |
| Matt Briggs | 44:ece6330e9b57 | 1406 | # it. Since the tabs in the index contain the same information as the navigation |
| Matt Briggs | 44:ece6330e9b57 | 1407 | # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1408 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 1409 | # This tag requires that the tag GENERATE_HTML is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1410 | |
| Matt Briggs | 44:ece6330e9b57 | 1411 | DISABLE_INDEX = NO |
| Matt Briggs | 44:ece6330e9b57 | 1412 | |
| Matt Briggs | 44:ece6330e9b57 | 1413 | # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index |
| Matt Briggs | 44:ece6330e9b57 | 1414 | # structure should be generated to display hierarchical information. If the tag |
| Matt Briggs | 44:ece6330e9b57 | 1415 | # value is set to YES, a side panel will be generated containing a tree-like |
| Matt Briggs | 44:ece6330e9b57 | 1416 | # index structure (just like the one that is generated for HTML Help). For this |
| Matt Briggs | 44:ece6330e9b57 | 1417 | # to work a browser that supports JavaScript, DHTML, CSS and frames is required |
| Matt Briggs | 44:ece6330e9b57 | 1418 | # (i.e. any modern browser). Windows users are probably better off using the |
| Matt Briggs | 44:ece6330e9b57 | 1419 | # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can |
| Matt Briggs | 44:ece6330e9b57 | 1420 | # further fine-tune the look of the index. As an example, the default style |
| Matt Briggs | 44:ece6330e9b57 | 1421 | # sheet generated by doxygen has an example that shows how to put an image at |
| Matt Briggs | 44:ece6330e9b57 | 1422 | # the root of the tree instead of the PROJECT_NAME. Since the tree basically has |
| Matt Briggs | 44:ece6330e9b57 | 1423 | # the same information as the tab index, you could consider setting |
| Matt Briggs | 44:ece6330e9b57 | 1424 | # DISABLE_INDEX to YES when enabling this option. |
| Matt Briggs | 44:ece6330e9b57 | 1425 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 1426 | # This tag requires that the tag GENERATE_HTML is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1427 | |
| Matt Briggs | 44:ece6330e9b57 | 1428 | GENERATE_TREEVIEW = NO |
| Matt Briggs | 44:ece6330e9b57 | 1429 | |
| Matt Briggs | 44:ece6330e9b57 | 1430 | # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that |
| Matt Briggs | 44:ece6330e9b57 | 1431 | # doxygen will group on one line in the generated HTML documentation. |
| Matt Briggs | 44:ece6330e9b57 | 1432 | # |
| Matt Briggs | 44:ece6330e9b57 | 1433 | # Note that a value of 0 will completely suppress the enum values from appearing |
| Matt Briggs | 44:ece6330e9b57 | 1434 | # in the overview section. |
| Matt Briggs | 44:ece6330e9b57 | 1435 | # Minimum value: 0, maximum value: 20, default value: 4. |
| Matt Briggs | 44:ece6330e9b57 | 1436 | # This tag requires that the tag GENERATE_HTML is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1437 | |
| Matt Briggs | 44:ece6330e9b57 | 1438 | ENUM_VALUES_PER_LINE = 4 |
| Matt Briggs | 44:ece6330e9b57 | 1439 | |
| Matt Briggs | 44:ece6330e9b57 | 1440 | # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used |
| Matt Briggs | 44:ece6330e9b57 | 1441 | # to set the initial width (in pixels) of the frame in which the tree is shown. |
| Matt Briggs | 44:ece6330e9b57 | 1442 | # Minimum value: 0, maximum value: 1500, default value: 250. |
| Matt Briggs | 44:ece6330e9b57 | 1443 | # This tag requires that the tag GENERATE_HTML is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1444 | |
| Matt Briggs | 44:ece6330e9b57 | 1445 | TREEVIEW_WIDTH = 250 |
| Matt Briggs | 44:ece6330e9b57 | 1446 | |
| Matt Briggs | 44:ece6330e9b57 | 1447 | # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to |
| Matt Briggs | 44:ece6330e9b57 | 1448 | # external symbols imported via tag files in a separate window. |
| Matt Briggs | 44:ece6330e9b57 | 1449 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 1450 | # This tag requires that the tag GENERATE_HTML is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1451 | |
| Matt Briggs | 44:ece6330e9b57 | 1452 | EXT_LINKS_IN_WINDOW = NO |
| Matt Briggs | 44:ece6330e9b57 | 1453 | |
| Matt Briggs | 44:ece6330e9b57 | 1454 | # Use this tag to change the font size of LaTeX formulas included as images in |
| Matt Briggs | 44:ece6330e9b57 | 1455 | # the HTML documentation. When you change the font size after a successful |
| Matt Briggs | 44:ece6330e9b57 | 1456 | # doxygen run you need to manually remove any form_*.png images from the HTML |
| Matt Briggs | 44:ece6330e9b57 | 1457 | # output directory to force them to be regenerated. |
| Matt Briggs | 44:ece6330e9b57 | 1458 | # Minimum value: 8, maximum value: 50, default value: 10. |
| Matt Briggs | 44:ece6330e9b57 | 1459 | # This tag requires that the tag GENERATE_HTML is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1460 | |
| Matt Briggs | 44:ece6330e9b57 | 1461 | FORMULA_FONTSIZE = 10 |
| Matt Briggs | 44:ece6330e9b57 | 1462 | |
| Matt Briggs | 44:ece6330e9b57 | 1463 | # Use the FORMULA_TRANPARENT tag to determine whether or not the images |
| Matt Briggs | 44:ece6330e9b57 | 1464 | # generated for formulas are transparent PNGs. Transparent PNGs are not |
| Matt Briggs | 44:ece6330e9b57 | 1465 | # supported properly for IE 6.0, but are supported on all modern browsers. |
| Matt Briggs | 44:ece6330e9b57 | 1466 | # |
| Matt Briggs | 44:ece6330e9b57 | 1467 | # Note that when changing this option you need to delete any form_*.png files in |
| Matt Briggs | 44:ece6330e9b57 | 1468 | # the HTML output directory before the changes have effect. |
| Matt Briggs | 44:ece6330e9b57 | 1469 | # The default value is: YES. |
| Matt Briggs | 44:ece6330e9b57 | 1470 | # This tag requires that the tag GENERATE_HTML is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1471 | |
| Matt Briggs | 44:ece6330e9b57 | 1472 | FORMULA_TRANSPARENT = YES |
| Matt Briggs | 44:ece6330e9b57 | 1473 | |
| Matt Briggs | 44:ece6330e9b57 | 1474 | # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see |
| Matt Briggs | 44:ece6330e9b57 | 1475 | # http://www.mathjax.org) which uses client side Javascript for the rendering |
| Matt Briggs | 44:ece6330e9b57 | 1476 | # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX |
| Matt Briggs | 44:ece6330e9b57 | 1477 | # installed or if you want to formulas look prettier in the HTML output. When |
| Matt Briggs | 44:ece6330e9b57 | 1478 | # enabled you may also need to install MathJax separately and configure the path |
| Matt Briggs | 44:ece6330e9b57 | 1479 | # to it using the MATHJAX_RELPATH option. |
| Matt Briggs | 44:ece6330e9b57 | 1480 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 1481 | # This tag requires that the tag GENERATE_HTML is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1482 | |
| Matt Briggs | 44:ece6330e9b57 | 1483 | USE_MATHJAX = NO |
| Matt Briggs | 44:ece6330e9b57 | 1484 | |
| Matt Briggs | 44:ece6330e9b57 | 1485 | # When MathJax is enabled you can set the default output format to be used for |
| Matt Briggs | 44:ece6330e9b57 | 1486 | # the MathJax output. See the MathJax site (see: |
| Matt Briggs | 44:ece6330e9b57 | 1487 | # http://docs.mathjax.org/en/latest/output.html) for more details. |
| Matt Briggs | 44:ece6330e9b57 | 1488 | # Possible values are: HTML-CSS (which is slower, but has the best |
| Matt Briggs | 44:ece6330e9b57 | 1489 | # compatibility), NativeMML (i.e. MathML) and SVG. |
| Matt Briggs | 44:ece6330e9b57 | 1490 | # The default value is: HTML-CSS. |
| Matt Briggs | 44:ece6330e9b57 | 1491 | # This tag requires that the tag USE_MATHJAX is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1492 | |
| Matt Briggs | 44:ece6330e9b57 | 1493 | MATHJAX_FORMAT = HTML-CSS |
| Matt Briggs | 44:ece6330e9b57 | 1494 | |
| Matt Briggs | 44:ece6330e9b57 | 1495 | # When MathJax is enabled you need to specify the location relative to the HTML |
| Matt Briggs | 44:ece6330e9b57 | 1496 | # output directory using the MATHJAX_RELPATH option. The destination directory |
| Matt Briggs | 44:ece6330e9b57 | 1497 | # should contain the MathJax.js script. For instance, if the mathjax directory |
| Matt Briggs | 44:ece6330e9b57 | 1498 | # is located at the same level as the HTML output directory, then |
| Matt Briggs | 44:ece6330e9b57 | 1499 | # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax |
| Matt Briggs | 44:ece6330e9b57 | 1500 | # Content Delivery Network so you can quickly see the result without installing |
| Matt Briggs | 44:ece6330e9b57 | 1501 | # MathJax. However, it is strongly recommended to install a local copy of |
| Matt Briggs | 44:ece6330e9b57 | 1502 | # MathJax from http://www.mathjax.org before deployment. |
| Matt Briggs | 44:ece6330e9b57 | 1503 | # The default value is: http://cdn.mathjax.org/mathjax/latest. |
| Matt Briggs | 44:ece6330e9b57 | 1504 | # This tag requires that the tag USE_MATHJAX is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1505 | |
| Matt Briggs | 44:ece6330e9b57 | 1506 | MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest |
| Matt Briggs | 44:ece6330e9b57 | 1507 | |
| Matt Briggs | 44:ece6330e9b57 | 1508 | # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax |
| Matt Briggs | 44:ece6330e9b57 | 1509 | # extension names that should be enabled during MathJax rendering. For example |
| Matt Briggs | 44:ece6330e9b57 | 1510 | # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols |
| Matt Briggs | 44:ece6330e9b57 | 1511 | # This tag requires that the tag USE_MATHJAX is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1512 | |
| Matt Briggs | 44:ece6330e9b57 | 1513 | MATHJAX_EXTENSIONS = |
| Matt Briggs | 44:ece6330e9b57 | 1514 | |
| Matt Briggs | 44:ece6330e9b57 | 1515 | # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces |
| Matt Briggs | 44:ece6330e9b57 | 1516 | # of code that will be used on startup of the MathJax code. See the MathJax site |
| Matt Briggs | 44:ece6330e9b57 | 1517 | # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an |
| Matt Briggs | 44:ece6330e9b57 | 1518 | # example see the documentation. |
| Matt Briggs | 44:ece6330e9b57 | 1519 | # This tag requires that the tag USE_MATHJAX is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1520 | |
| Matt Briggs | 44:ece6330e9b57 | 1521 | MATHJAX_CODEFILE = |
| Matt Briggs | 44:ece6330e9b57 | 1522 | |
| Matt Briggs | 44:ece6330e9b57 | 1523 | # When the SEARCHENGINE tag is enabled doxygen will generate a search box for |
| Matt Briggs | 44:ece6330e9b57 | 1524 | # the HTML output. The underlying search engine uses javascript and DHTML and |
| Matt Briggs | 44:ece6330e9b57 | 1525 | # should work on any modern browser. Note that when using HTML help |
| Matt Briggs | 44:ece6330e9b57 | 1526 | # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) |
| Matt Briggs | 44:ece6330e9b57 | 1527 | # there is already a search function so this one should typically be disabled. |
| Matt Briggs | 44:ece6330e9b57 | 1528 | # For large projects the javascript based search engine can be slow, then |
| Matt Briggs | 44:ece6330e9b57 | 1529 | # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to |
| Matt Briggs | 44:ece6330e9b57 | 1530 | # search using the keyboard; to jump to the search box use <access key> + S |
| Matt Briggs | 44:ece6330e9b57 | 1531 | # (what the <access key> is depends on the OS and browser, but it is typically |
| Matt Briggs | 44:ece6330e9b57 | 1532 | # <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down |
| Matt Briggs | 44:ece6330e9b57 | 1533 | # key> to jump into the search results window, the results can be navigated |
| Matt Briggs | 44:ece6330e9b57 | 1534 | # using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel |
| Matt Briggs | 44:ece6330e9b57 | 1535 | # the search. The filter options can be selected when the cursor is inside the |
| Matt Briggs | 44:ece6330e9b57 | 1536 | # search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys> |
| Matt Briggs | 44:ece6330e9b57 | 1537 | # to select a filter and <Enter> or <escape> to activate or cancel the filter |
| Matt Briggs | 44:ece6330e9b57 | 1538 | # option. |
| Matt Briggs | 44:ece6330e9b57 | 1539 | # The default value is: YES. |
| Matt Briggs | 44:ece6330e9b57 | 1540 | # This tag requires that the tag GENERATE_HTML is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1541 | |
| Matt Briggs | 44:ece6330e9b57 | 1542 | SEARCHENGINE = YES |
| Matt Briggs | 44:ece6330e9b57 | 1543 | |
| Matt Briggs | 44:ece6330e9b57 | 1544 | # When the SERVER_BASED_SEARCH tag is enabled the search engine will be |
| Matt Briggs | 44:ece6330e9b57 | 1545 | # implemented using a web server instead of a web client using Javascript. There |
| Matt Briggs | 44:ece6330e9b57 | 1546 | # are two flavors of web server based searching depending on the EXTERNAL_SEARCH |
| Matt Briggs | 44:ece6330e9b57 | 1547 | # setting. When disabled, doxygen will generate a PHP script for searching and |
| Matt Briggs | 44:ece6330e9b57 | 1548 | # an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing |
| Matt Briggs | 44:ece6330e9b57 | 1549 | # and searching needs to be provided by external tools. See the section |
| Matt Briggs | 44:ece6330e9b57 | 1550 | # "External Indexing and Searching" for details. |
| Matt Briggs | 44:ece6330e9b57 | 1551 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 1552 | # This tag requires that the tag SEARCHENGINE is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1553 | |
| Matt Briggs | 44:ece6330e9b57 | 1554 | SERVER_BASED_SEARCH = NO |
| Matt Briggs | 44:ece6330e9b57 | 1555 | |
| Matt Briggs | 44:ece6330e9b57 | 1556 | # When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP |
| Matt Briggs | 44:ece6330e9b57 | 1557 | # script for searching. Instead the search results are written to an XML file |
| Matt Briggs | 44:ece6330e9b57 | 1558 | # which needs to be processed by an external indexer. Doxygen will invoke an |
| Matt Briggs | 44:ece6330e9b57 | 1559 | # external search engine pointed to by the SEARCHENGINE_URL option to obtain the |
| Matt Briggs | 44:ece6330e9b57 | 1560 | # search results. |
| Matt Briggs | 44:ece6330e9b57 | 1561 | # |
| Matt Briggs | 44:ece6330e9b57 | 1562 | # Doxygen ships with an example indexer (doxyindexer) and search engine |
| Matt Briggs | 44:ece6330e9b57 | 1563 | # (doxysearch.cgi) which are based on the open source search engine library |
| Matt Briggs | 44:ece6330e9b57 | 1564 | # Xapian (see: http://xapian.org/). |
| Matt Briggs | 44:ece6330e9b57 | 1565 | # |
| Matt Briggs | 44:ece6330e9b57 | 1566 | # See the section "External Indexing and Searching" for details. |
| Matt Briggs | 44:ece6330e9b57 | 1567 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 1568 | # This tag requires that the tag SEARCHENGINE is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1569 | |
| Matt Briggs | 44:ece6330e9b57 | 1570 | EXTERNAL_SEARCH = NO |
| Matt Briggs | 44:ece6330e9b57 | 1571 | |
| Matt Briggs | 44:ece6330e9b57 | 1572 | # The SEARCHENGINE_URL should point to a search engine hosted by a web server |
| Matt Briggs | 44:ece6330e9b57 | 1573 | # which will return the search results when EXTERNAL_SEARCH is enabled. |
| Matt Briggs | 44:ece6330e9b57 | 1574 | # |
| Matt Briggs | 44:ece6330e9b57 | 1575 | # Doxygen ships with an example indexer (doxyindexer) and search engine |
| Matt Briggs | 44:ece6330e9b57 | 1576 | # (doxysearch.cgi) which are based on the open source search engine library |
| Matt Briggs | 44:ece6330e9b57 | 1577 | # Xapian (see: http://xapian.org/). See the section "External Indexing and |
| Matt Briggs | 44:ece6330e9b57 | 1578 | # Searching" for details. |
| Matt Briggs | 44:ece6330e9b57 | 1579 | # This tag requires that the tag SEARCHENGINE is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1580 | |
| Matt Briggs | 44:ece6330e9b57 | 1581 | SEARCHENGINE_URL = |
| Matt Briggs | 44:ece6330e9b57 | 1582 | |
| Matt Briggs | 44:ece6330e9b57 | 1583 | # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed |
| Matt Briggs | 44:ece6330e9b57 | 1584 | # search data is written to a file for indexing by an external tool. With the |
| Matt Briggs | 44:ece6330e9b57 | 1585 | # SEARCHDATA_FILE tag the name of this file can be specified. |
| Matt Briggs | 44:ece6330e9b57 | 1586 | # The default file is: searchdata.xml. |
| Matt Briggs | 44:ece6330e9b57 | 1587 | # This tag requires that the tag SEARCHENGINE is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1588 | |
| Matt Briggs | 44:ece6330e9b57 | 1589 | SEARCHDATA_FILE = searchdata.xml |
| Matt Briggs | 44:ece6330e9b57 | 1590 | |
| Matt Briggs | 44:ece6330e9b57 | 1591 | # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the |
| Matt Briggs | 44:ece6330e9b57 | 1592 | # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is |
| Matt Briggs | 44:ece6330e9b57 | 1593 | # useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple |
| Matt Briggs | 44:ece6330e9b57 | 1594 | # projects and redirect the results back to the right project. |
| Matt Briggs | 44:ece6330e9b57 | 1595 | # This tag requires that the tag SEARCHENGINE is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1596 | |
| Matt Briggs | 44:ece6330e9b57 | 1597 | EXTERNAL_SEARCH_ID = |
| Matt Briggs | 44:ece6330e9b57 | 1598 | |
| Matt Briggs | 44:ece6330e9b57 | 1599 | # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen |
| Matt Briggs | 44:ece6330e9b57 | 1600 | # projects other than the one defined by this configuration file, but that are |
| Matt Briggs | 44:ece6330e9b57 | 1601 | # all added to the same external search index. Each project needs to have a |
| Matt Briggs | 44:ece6330e9b57 | 1602 | # unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of |
| Matt Briggs | 44:ece6330e9b57 | 1603 | # to a relative location where the documentation can be found. The format is: |
| Matt Briggs | 44:ece6330e9b57 | 1604 | # EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ... |
| Matt Briggs | 44:ece6330e9b57 | 1605 | # This tag requires that the tag SEARCHENGINE is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1606 | |
| Matt Briggs | 44:ece6330e9b57 | 1607 | EXTRA_SEARCH_MAPPINGS = |
| Matt Briggs | 44:ece6330e9b57 | 1608 | |
| Matt Briggs | 44:ece6330e9b57 | 1609 | #--------------------------------------------------------------------------- |
| Matt Briggs | 44:ece6330e9b57 | 1610 | # Configuration options related to the LaTeX output |
| Matt Briggs | 44:ece6330e9b57 | 1611 | #--------------------------------------------------------------------------- |
| Matt Briggs | 44:ece6330e9b57 | 1612 | |
| Matt Briggs | 44:ece6330e9b57 | 1613 | # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output. |
| Matt Briggs | 44:ece6330e9b57 | 1614 | # The default value is: YES. |
| Matt Briggs | 44:ece6330e9b57 | 1615 | |
| Matt Briggs | 44:ece6330e9b57 | 1616 | GENERATE_LATEX = YES |
| Matt Briggs | 44:ece6330e9b57 | 1617 | |
| Matt Briggs | 44:ece6330e9b57 | 1618 | # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a |
| Matt Briggs | 44:ece6330e9b57 | 1619 | # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of |
| Matt Briggs | 44:ece6330e9b57 | 1620 | # it. |
| Matt Briggs | 44:ece6330e9b57 | 1621 | # The default directory is: latex. |
| Matt Briggs | 44:ece6330e9b57 | 1622 | # This tag requires that the tag GENERATE_LATEX is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1623 | |
| Matt Briggs | 44:ece6330e9b57 | 1624 | LATEX_OUTPUT = latex |
| Matt Briggs | 44:ece6330e9b57 | 1625 | |
| Matt Briggs | 44:ece6330e9b57 | 1626 | # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be |
| Matt Briggs | 44:ece6330e9b57 | 1627 | # invoked. |
| Matt Briggs | 44:ece6330e9b57 | 1628 | # |
| Matt Briggs | 44:ece6330e9b57 | 1629 | # Note that when enabling USE_PDFLATEX this option is only used for generating |
| Matt Briggs | 44:ece6330e9b57 | 1630 | # bitmaps for formulas in the HTML output, but not in the Makefile that is |
| Matt Briggs | 44:ece6330e9b57 | 1631 | # written to the output directory. |
| Matt Briggs | 44:ece6330e9b57 | 1632 | # The default file is: latex. |
| Matt Briggs | 44:ece6330e9b57 | 1633 | # This tag requires that the tag GENERATE_LATEX is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1634 | |
| Matt Briggs | 44:ece6330e9b57 | 1635 | LATEX_CMD_NAME = latex |
| Matt Briggs | 44:ece6330e9b57 | 1636 | |
| Matt Briggs | 44:ece6330e9b57 | 1637 | # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate |
| Matt Briggs | 44:ece6330e9b57 | 1638 | # index for LaTeX. |
| Matt Briggs | 44:ece6330e9b57 | 1639 | # The default file is: makeindex. |
| Matt Briggs | 44:ece6330e9b57 | 1640 | # This tag requires that the tag GENERATE_LATEX is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1641 | |
| Matt Briggs | 44:ece6330e9b57 | 1642 | MAKEINDEX_CMD_NAME = makeindex |
| Matt Briggs | 44:ece6330e9b57 | 1643 | |
| Matt Briggs | 44:ece6330e9b57 | 1644 | # If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX |
| Matt Briggs | 44:ece6330e9b57 | 1645 | # documents. This may be useful for small projects and may help to save some |
| Matt Briggs | 44:ece6330e9b57 | 1646 | # trees in general. |
| Matt Briggs | 44:ece6330e9b57 | 1647 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 1648 | # This tag requires that the tag GENERATE_LATEX is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1649 | |
| Matt Briggs | 44:ece6330e9b57 | 1650 | COMPACT_LATEX = NO |
| Matt Briggs | 44:ece6330e9b57 | 1651 | |
| Matt Briggs | 44:ece6330e9b57 | 1652 | # The PAPER_TYPE tag can be used to set the paper type that is used by the |
| Matt Briggs | 44:ece6330e9b57 | 1653 | # printer. |
| Matt Briggs | 44:ece6330e9b57 | 1654 | # Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x |
| Matt Briggs | 44:ece6330e9b57 | 1655 | # 14 inches) and executive (7.25 x 10.5 inches). |
| Matt Briggs | 44:ece6330e9b57 | 1656 | # The default value is: a4. |
| Matt Briggs | 44:ece6330e9b57 | 1657 | # This tag requires that the tag GENERATE_LATEX is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1658 | |
| Matt Briggs | 44:ece6330e9b57 | 1659 | PAPER_TYPE = a4 |
| Matt Briggs | 44:ece6330e9b57 | 1660 | |
| Matt Briggs | 44:ece6330e9b57 | 1661 | # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names |
| Matt Briggs | 44:ece6330e9b57 | 1662 | # that should be included in the LaTeX output. The package can be specified just |
| Matt Briggs | 44:ece6330e9b57 | 1663 | # by its name or with the correct syntax as to be used with the LaTeX |
| Matt Briggs | 44:ece6330e9b57 | 1664 | # \usepackage command. To get the times font for instance you can specify : |
| Matt Briggs | 44:ece6330e9b57 | 1665 | # EXTRA_PACKAGES=times or EXTRA_PACKAGES={times} |
| Matt Briggs | 44:ece6330e9b57 | 1666 | # To use the option intlimits with the amsmath package you can specify: |
| Matt Briggs | 44:ece6330e9b57 | 1667 | # EXTRA_PACKAGES=[intlimits]{amsmath} |
| Matt Briggs | 44:ece6330e9b57 | 1668 | # If left blank no extra packages will be included. |
| Matt Briggs | 44:ece6330e9b57 | 1669 | # This tag requires that the tag GENERATE_LATEX is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1670 | |
| Matt Briggs | 44:ece6330e9b57 | 1671 | EXTRA_PACKAGES = |
| Matt Briggs | 44:ece6330e9b57 | 1672 | |
| Matt Briggs | 44:ece6330e9b57 | 1673 | # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the |
| Matt Briggs | 44:ece6330e9b57 | 1674 | # generated LaTeX document. The header should contain everything until the first |
| Matt Briggs | 44:ece6330e9b57 | 1675 | # chapter. If it is left blank doxygen will generate a standard header. See |
| Matt Briggs | 44:ece6330e9b57 | 1676 | # section "Doxygen usage" for information on how to let doxygen write the |
| Matt Briggs | 44:ece6330e9b57 | 1677 | # default header to a separate file. |
| Matt Briggs | 44:ece6330e9b57 | 1678 | # |
| Matt Briggs | 44:ece6330e9b57 | 1679 | # Note: Only use a user-defined header if you know what you are doing! The |
| Matt Briggs | 44:ece6330e9b57 | 1680 | # following commands have a special meaning inside the header: $title, |
| Matt Briggs | 44:ece6330e9b57 | 1681 | # $datetime, $date, $doxygenversion, $projectname, $projectnumber, |
| Matt Briggs | 44:ece6330e9b57 | 1682 | # $projectbrief, $projectlogo. Doxygen will replace $title with the empty |
| Matt Briggs | 44:ece6330e9b57 | 1683 | # string, for the replacement values of the other commands the user is referred |
| Matt Briggs | 44:ece6330e9b57 | 1684 | # to HTML_HEADER. |
| Matt Briggs | 44:ece6330e9b57 | 1685 | # This tag requires that the tag GENERATE_LATEX is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1686 | |
| Matt Briggs | 44:ece6330e9b57 | 1687 | LATEX_HEADER = |
| Matt Briggs | 44:ece6330e9b57 | 1688 | |
| Matt Briggs | 44:ece6330e9b57 | 1689 | # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the |
| Matt Briggs | 44:ece6330e9b57 | 1690 | # generated LaTeX document. The footer should contain everything after the last |
| Matt Briggs | 44:ece6330e9b57 | 1691 | # chapter. If it is left blank doxygen will generate a standard footer. See |
| Matt Briggs | 44:ece6330e9b57 | 1692 | # LATEX_HEADER for more information on how to generate a default footer and what |
| Matt Briggs | 44:ece6330e9b57 | 1693 | # special commands can be used inside the footer. |
| Matt Briggs | 44:ece6330e9b57 | 1694 | # |
| Matt Briggs | 44:ece6330e9b57 | 1695 | # Note: Only use a user-defined footer if you know what you are doing! |
| Matt Briggs | 44:ece6330e9b57 | 1696 | # This tag requires that the tag GENERATE_LATEX is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1697 | |
| Matt Briggs | 44:ece6330e9b57 | 1698 | LATEX_FOOTER = |
| Matt Briggs | 44:ece6330e9b57 | 1699 | |
| Matt Briggs | 44:ece6330e9b57 | 1700 | # The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined |
| Matt Briggs | 44:ece6330e9b57 | 1701 | # LaTeX style sheets that are included after the standard style sheets created |
| Matt Briggs | 44:ece6330e9b57 | 1702 | # by doxygen. Using this option one can overrule certain style aspects. Doxygen |
| Matt Briggs | 44:ece6330e9b57 | 1703 | # will copy the style sheet files to the output directory. |
| Matt Briggs | 44:ece6330e9b57 | 1704 | # Note: The order of the extra style sheet files is of importance (e.g. the last |
| Matt Briggs | 44:ece6330e9b57 | 1705 | # style sheet in the list overrules the setting of the previous ones in the |
| Matt Briggs | 44:ece6330e9b57 | 1706 | # list). |
| Matt Briggs | 44:ece6330e9b57 | 1707 | # This tag requires that the tag GENERATE_LATEX is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1708 | |
| Matt Briggs | 44:ece6330e9b57 | 1709 | LATEX_EXTRA_STYLESHEET = |
| Matt Briggs | 44:ece6330e9b57 | 1710 | |
| Matt Briggs | 44:ece6330e9b57 | 1711 | # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or |
| Matt Briggs | 44:ece6330e9b57 | 1712 | # other source files which should be copied to the LATEX_OUTPUT output |
| Matt Briggs | 44:ece6330e9b57 | 1713 | # directory. Note that the files will be copied as-is; there are no commands or |
| Matt Briggs | 44:ece6330e9b57 | 1714 | # markers available. |
| Matt Briggs | 44:ece6330e9b57 | 1715 | # This tag requires that the tag GENERATE_LATEX is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1716 | |
| Matt Briggs | 44:ece6330e9b57 | 1717 | LATEX_EXTRA_FILES = |
| Matt Briggs | 44:ece6330e9b57 | 1718 | |
| Matt Briggs | 44:ece6330e9b57 | 1719 | # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is |
| Matt Briggs | 44:ece6330e9b57 | 1720 | # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will |
| Matt Briggs | 44:ece6330e9b57 | 1721 | # contain links (just like the HTML output) instead of page references. This |
| Matt Briggs | 44:ece6330e9b57 | 1722 | # makes the output suitable for online browsing using a PDF viewer. |
| Matt Briggs | 44:ece6330e9b57 | 1723 | # The default value is: YES. |
| Matt Briggs | 44:ece6330e9b57 | 1724 | # This tag requires that the tag GENERATE_LATEX is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1725 | |
| Matt Briggs | 44:ece6330e9b57 | 1726 | PDF_HYPERLINKS = YES |
| Matt Briggs | 44:ece6330e9b57 | 1727 | |
| Matt Briggs | 44:ece6330e9b57 | 1728 | # If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate |
| Matt Briggs | 44:ece6330e9b57 | 1729 | # the PDF file directly from the LaTeX files. Set this option to YES, to get a |
| Matt Briggs | 44:ece6330e9b57 | 1730 | # higher quality PDF documentation. |
| Matt Briggs | 44:ece6330e9b57 | 1731 | # The default value is: YES. |
| Matt Briggs | 44:ece6330e9b57 | 1732 | # This tag requires that the tag GENERATE_LATEX is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1733 | |
| Matt Briggs | 44:ece6330e9b57 | 1734 | USE_PDFLATEX = YES |
| Matt Briggs | 44:ece6330e9b57 | 1735 | |
| Matt Briggs | 44:ece6330e9b57 | 1736 | # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode |
| Matt Briggs | 44:ece6330e9b57 | 1737 | # command to the generated LaTeX files. This will instruct LaTeX to keep running |
| Matt Briggs | 44:ece6330e9b57 | 1738 | # if errors occur, instead of asking the user for help. This option is also used |
| Matt Briggs | 44:ece6330e9b57 | 1739 | # when generating formulas in HTML. |
| Matt Briggs | 44:ece6330e9b57 | 1740 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 1741 | # This tag requires that the tag GENERATE_LATEX is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1742 | |
| Matt Briggs | 44:ece6330e9b57 | 1743 | LATEX_BATCHMODE = NO |
| Matt Briggs | 44:ece6330e9b57 | 1744 | |
| Matt Briggs | 44:ece6330e9b57 | 1745 | # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the |
| Matt Briggs | 44:ece6330e9b57 | 1746 | # index chapters (such as File Index, Compound Index, etc.) in the output. |
| Matt Briggs | 44:ece6330e9b57 | 1747 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 1748 | # This tag requires that the tag GENERATE_LATEX is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1749 | |
| Matt Briggs | 44:ece6330e9b57 | 1750 | LATEX_HIDE_INDICES = NO |
| Matt Briggs | 44:ece6330e9b57 | 1751 | |
| Matt Briggs | 44:ece6330e9b57 | 1752 | # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source |
| Matt Briggs | 44:ece6330e9b57 | 1753 | # code with syntax highlighting in the LaTeX output. |
| Matt Briggs | 44:ece6330e9b57 | 1754 | # |
| Matt Briggs | 44:ece6330e9b57 | 1755 | # Note that which sources are shown also depends on other settings such as |
| Matt Briggs | 44:ece6330e9b57 | 1756 | # SOURCE_BROWSER. |
| Matt Briggs | 44:ece6330e9b57 | 1757 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 1758 | # This tag requires that the tag GENERATE_LATEX is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1759 | |
| Matt Briggs | 44:ece6330e9b57 | 1760 | LATEX_SOURCE_CODE = NO |
| Matt Briggs | 44:ece6330e9b57 | 1761 | |
| Matt Briggs | 44:ece6330e9b57 | 1762 | # The LATEX_BIB_STYLE tag can be used to specify the style to use for the |
| Matt Briggs | 44:ece6330e9b57 | 1763 | # bibliography, e.g. plainnat, or ieeetr. See |
| Matt Briggs | 44:ece6330e9b57 | 1764 | # http://en.wikipedia.org/wiki/BibTeX and \cite for more info. |
| Matt Briggs | 44:ece6330e9b57 | 1765 | # The default value is: plain. |
| Matt Briggs | 44:ece6330e9b57 | 1766 | # This tag requires that the tag GENERATE_LATEX is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1767 | |
| Matt Briggs | 44:ece6330e9b57 | 1768 | LATEX_BIB_STYLE = plain |
| Matt Briggs | 44:ece6330e9b57 | 1769 | |
| Matt Briggs | 44:ece6330e9b57 | 1770 | # If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated |
| Matt Briggs | 44:ece6330e9b57 | 1771 | # page will contain the date and time when the page was generated. Setting this |
| Matt Briggs | 44:ece6330e9b57 | 1772 | # to NO can help when comparing the output of multiple runs. |
| Matt Briggs | 44:ece6330e9b57 | 1773 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 1774 | # This tag requires that the tag GENERATE_LATEX is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1775 | |
| Matt Briggs | 44:ece6330e9b57 | 1776 | LATEX_TIMESTAMP = NO |
| Matt Briggs | 44:ece6330e9b57 | 1777 | |
| Matt Briggs | 44:ece6330e9b57 | 1778 | #--------------------------------------------------------------------------- |
| Matt Briggs | 44:ece6330e9b57 | 1779 | # Configuration options related to the RTF output |
| Matt Briggs | 44:ece6330e9b57 | 1780 | #--------------------------------------------------------------------------- |
| Matt Briggs | 44:ece6330e9b57 | 1781 | |
| Matt Briggs | 44:ece6330e9b57 | 1782 | # If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The |
| Matt Briggs | 44:ece6330e9b57 | 1783 | # RTF output is optimized for Word 97 and may not look too pretty with other RTF |
| Matt Briggs | 44:ece6330e9b57 | 1784 | # readers/editors. |
| Matt Briggs | 44:ece6330e9b57 | 1785 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 1786 | |
| Matt Briggs | 44:ece6330e9b57 | 1787 | GENERATE_RTF = NO |
| Matt Briggs | 44:ece6330e9b57 | 1788 | |
| Matt Briggs | 44:ece6330e9b57 | 1789 | # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a |
| Matt Briggs | 44:ece6330e9b57 | 1790 | # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of |
| Matt Briggs | 44:ece6330e9b57 | 1791 | # it. |
| Matt Briggs | 44:ece6330e9b57 | 1792 | # The default directory is: rtf. |
| Matt Briggs | 44:ece6330e9b57 | 1793 | # This tag requires that the tag GENERATE_RTF is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1794 | |
| Matt Briggs | 44:ece6330e9b57 | 1795 | RTF_OUTPUT = rtf |
| Matt Briggs | 44:ece6330e9b57 | 1796 | |
| Matt Briggs | 44:ece6330e9b57 | 1797 | # If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF |
| Matt Briggs | 44:ece6330e9b57 | 1798 | # documents. This may be useful for small projects and may help to save some |
| Matt Briggs | 44:ece6330e9b57 | 1799 | # trees in general. |
| Matt Briggs | 44:ece6330e9b57 | 1800 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 1801 | # This tag requires that the tag GENERATE_RTF is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1802 | |
| Matt Briggs | 44:ece6330e9b57 | 1803 | COMPACT_RTF = NO |
| Matt Briggs | 44:ece6330e9b57 | 1804 | |
| Matt Briggs | 44:ece6330e9b57 | 1805 | # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will |
| Matt Briggs | 44:ece6330e9b57 | 1806 | # contain hyperlink fields. The RTF file will contain links (just like the HTML |
| Matt Briggs | 44:ece6330e9b57 | 1807 | # output) instead of page references. This makes the output suitable for online |
| Matt Briggs | 44:ece6330e9b57 | 1808 | # browsing using Word or some other Word compatible readers that support those |
| Matt Briggs | 44:ece6330e9b57 | 1809 | # fields. |
| Matt Briggs | 44:ece6330e9b57 | 1810 | # |
| Matt Briggs | 44:ece6330e9b57 | 1811 | # Note: WordPad (write) and others do not support links. |
| Matt Briggs | 44:ece6330e9b57 | 1812 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 1813 | # This tag requires that the tag GENERATE_RTF is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1814 | |
| Matt Briggs | 44:ece6330e9b57 | 1815 | RTF_HYPERLINKS = NO |
| Matt Briggs | 44:ece6330e9b57 | 1816 | |
| Matt Briggs | 44:ece6330e9b57 | 1817 | # Load stylesheet definitions from file. Syntax is similar to doxygen's config |
| Matt Briggs | 44:ece6330e9b57 | 1818 | # file, i.e. a series of assignments. You only have to provide replacements, |
| Matt Briggs | 44:ece6330e9b57 | 1819 | # missing definitions are set to their default value. |
| Matt Briggs | 44:ece6330e9b57 | 1820 | # |
| Matt Briggs | 44:ece6330e9b57 | 1821 | # See also section "Doxygen usage" for information on how to generate the |
| Matt Briggs | 44:ece6330e9b57 | 1822 | # default style sheet that doxygen normally uses. |
| Matt Briggs | 44:ece6330e9b57 | 1823 | # This tag requires that the tag GENERATE_RTF is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1824 | |
| Matt Briggs | 44:ece6330e9b57 | 1825 | RTF_STYLESHEET_FILE = |
| Matt Briggs | 44:ece6330e9b57 | 1826 | |
| Matt Briggs | 44:ece6330e9b57 | 1827 | # Set optional variables used in the generation of an RTF document. Syntax is |
| Matt Briggs | 44:ece6330e9b57 | 1828 | # similar to doxygen's config file. A template extensions file can be generated |
| Matt Briggs | 44:ece6330e9b57 | 1829 | # using doxygen -e rtf extensionFile. |
| Matt Briggs | 44:ece6330e9b57 | 1830 | # This tag requires that the tag GENERATE_RTF is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1831 | |
| Matt Briggs | 44:ece6330e9b57 | 1832 | RTF_EXTENSIONS_FILE = |
| Matt Briggs | 44:ece6330e9b57 | 1833 | |
| Matt Briggs | 44:ece6330e9b57 | 1834 | # If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code |
| Matt Briggs | 44:ece6330e9b57 | 1835 | # with syntax highlighting in the RTF output. |
| Matt Briggs | 44:ece6330e9b57 | 1836 | # |
| Matt Briggs | 44:ece6330e9b57 | 1837 | # Note that which sources are shown also depends on other settings such as |
| Matt Briggs | 44:ece6330e9b57 | 1838 | # SOURCE_BROWSER. |
| Matt Briggs | 44:ece6330e9b57 | 1839 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 1840 | # This tag requires that the tag GENERATE_RTF is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1841 | |
| Matt Briggs | 44:ece6330e9b57 | 1842 | RTF_SOURCE_CODE = NO |
| Matt Briggs | 44:ece6330e9b57 | 1843 | |
| Matt Briggs | 44:ece6330e9b57 | 1844 | #--------------------------------------------------------------------------- |
| Matt Briggs | 44:ece6330e9b57 | 1845 | # Configuration options related to the man page output |
| Matt Briggs | 44:ece6330e9b57 | 1846 | #--------------------------------------------------------------------------- |
| Matt Briggs | 44:ece6330e9b57 | 1847 | |
| Matt Briggs | 44:ece6330e9b57 | 1848 | # If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for |
| Matt Briggs | 44:ece6330e9b57 | 1849 | # classes and files. |
| Matt Briggs | 44:ece6330e9b57 | 1850 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 1851 | |
| Matt Briggs | 44:ece6330e9b57 | 1852 | GENERATE_MAN = NO |
| Matt Briggs | 44:ece6330e9b57 | 1853 | |
| Matt Briggs | 44:ece6330e9b57 | 1854 | # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a |
| Matt Briggs | 44:ece6330e9b57 | 1855 | # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of |
| Matt Briggs | 44:ece6330e9b57 | 1856 | # it. A directory man3 will be created inside the directory specified by |
| Matt Briggs | 44:ece6330e9b57 | 1857 | # MAN_OUTPUT. |
| Matt Briggs | 44:ece6330e9b57 | 1858 | # The default directory is: man. |
| Matt Briggs | 44:ece6330e9b57 | 1859 | # This tag requires that the tag GENERATE_MAN is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1860 | |
| Matt Briggs | 44:ece6330e9b57 | 1861 | MAN_OUTPUT = man |
| Matt Briggs | 44:ece6330e9b57 | 1862 | |
| Matt Briggs | 44:ece6330e9b57 | 1863 | # The MAN_EXTENSION tag determines the extension that is added to the generated |
| Matt Briggs | 44:ece6330e9b57 | 1864 | # man pages. In case the manual section does not start with a number, the number |
| Matt Briggs | 44:ece6330e9b57 | 1865 | # 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is |
| Matt Briggs | 44:ece6330e9b57 | 1866 | # optional. |
| Matt Briggs | 44:ece6330e9b57 | 1867 | # The default value is: .3. |
| Matt Briggs | 44:ece6330e9b57 | 1868 | # This tag requires that the tag GENERATE_MAN is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1869 | |
| Matt Briggs | 44:ece6330e9b57 | 1870 | MAN_EXTENSION = .3 |
| Matt Briggs | 44:ece6330e9b57 | 1871 | |
| Matt Briggs | 44:ece6330e9b57 | 1872 | # The MAN_SUBDIR tag determines the name of the directory created within |
| Matt Briggs | 44:ece6330e9b57 | 1873 | # MAN_OUTPUT in which the man pages are placed. If defaults to man followed by |
| Matt Briggs | 44:ece6330e9b57 | 1874 | # MAN_EXTENSION with the initial . removed. |
| Matt Briggs | 44:ece6330e9b57 | 1875 | # This tag requires that the tag GENERATE_MAN is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1876 | |
| Matt Briggs | 44:ece6330e9b57 | 1877 | MAN_SUBDIR = |
| Matt Briggs | 44:ece6330e9b57 | 1878 | |
| Matt Briggs | 44:ece6330e9b57 | 1879 | # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it |
| Matt Briggs | 44:ece6330e9b57 | 1880 | # will generate one additional man file for each entity documented in the real |
| Matt Briggs | 44:ece6330e9b57 | 1881 | # man page(s). These additional files only source the real man page, but without |
| Matt Briggs | 44:ece6330e9b57 | 1882 | # them the man command would be unable to find the correct page. |
| Matt Briggs | 44:ece6330e9b57 | 1883 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 1884 | # This tag requires that the tag GENERATE_MAN is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1885 | |
| Matt Briggs | 44:ece6330e9b57 | 1886 | MAN_LINKS = NO |
| Matt Briggs | 44:ece6330e9b57 | 1887 | |
| Matt Briggs | 44:ece6330e9b57 | 1888 | #--------------------------------------------------------------------------- |
| Matt Briggs | 44:ece6330e9b57 | 1889 | # Configuration options related to the XML output |
| Matt Briggs | 44:ece6330e9b57 | 1890 | #--------------------------------------------------------------------------- |
| Matt Briggs | 44:ece6330e9b57 | 1891 | |
| Matt Briggs | 44:ece6330e9b57 | 1892 | # If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that |
| Matt Briggs | 44:ece6330e9b57 | 1893 | # captures the structure of the code including all documentation. |
| Matt Briggs | 44:ece6330e9b57 | 1894 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 1895 | |
| Matt Briggs | 44:ece6330e9b57 | 1896 | GENERATE_XML = NO |
| Matt Briggs | 44:ece6330e9b57 | 1897 | |
| Matt Briggs | 44:ece6330e9b57 | 1898 | # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a |
| Matt Briggs | 44:ece6330e9b57 | 1899 | # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of |
| Matt Briggs | 44:ece6330e9b57 | 1900 | # it. |
| Matt Briggs | 44:ece6330e9b57 | 1901 | # The default directory is: xml. |
| Matt Briggs | 44:ece6330e9b57 | 1902 | # This tag requires that the tag GENERATE_XML is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1903 | |
| Matt Briggs | 44:ece6330e9b57 | 1904 | XML_OUTPUT = xml |
| Matt Briggs | 44:ece6330e9b57 | 1905 | |
| Matt Briggs | 44:ece6330e9b57 | 1906 | # If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program |
| Matt Briggs | 44:ece6330e9b57 | 1907 | # listings (including syntax highlighting and cross-referencing information) to |
| Matt Briggs | 44:ece6330e9b57 | 1908 | # the XML output. Note that enabling this will significantly increase the size |
| Matt Briggs | 44:ece6330e9b57 | 1909 | # of the XML output. |
| Matt Briggs | 44:ece6330e9b57 | 1910 | # The default value is: YES. |
| Matt Briggs | 44:ece6330e9b57 | 1911 | # This tag requires that the tag GENERATE_XML is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1912 | |
| Matt Briggs | 44:ece6330e9b57 | 1913 | XML_PROGRAMLISTING = YES |
| Matt Briggs | 44:ece6330e9b57 | 1914 | |
| Matt Briggs | 44:ece6330e9b57 | 1915 | #--------------------------------------------------------------------------- |
| Matt Briggs | 44:ece6330e9b57 | 1916 | # Configuration options related to the DOCBOOK output |
| Matt Briggs | 44:ece6330e9b57 | 1917 | #--------------------------------------------------------------------------- |
| Matt Briggs | 44:ece6330e9b57 | 1918 | |
| Matt Briggs | 44:ece6330e9b57 | 1919 | # If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files |
| Matt Briggs | 44:ece6330e9b57 | 1920 | # that can be used to generate PDF. |
| Matt Briggs | 44:ece6330e9b57 | 1921 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 1922 | |
| Matt Briggs | 44:ece6330e9b57 | 1923 | GENERATE_DOCBOOK = NO |
| Matt Briggs | 44:ece6330e9b57 | 1924 | |
| Matt Briggs | 44:ece6330e9b57 | 1925 | # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put. |
| Matt Briggs | 44:ece6330e9b57 | 1926 | # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in |
| Matt Briggs | 44:ece6330e9b57 | 1927 | # front of it. |
| Matt Briggs | 44:ece6330e9b57 | 1928 | # The default directory is: docbook. |
| Matt Briggs | 44:ece6330e9b57 | 1929 | # This tag requires that the tag GENERATE_DOCBOOK is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1930 | |
| Matt Briggs | 44:ece6330e9b57 | 1931 | DOCBOOK_OUTPUT = docbook |
| Matt Briggs | 44:ece6330e9b57 | 1932 | |
| Matt Briggs | 44:ece6330e9b57 | 1933 | # If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the |
| Matt Briggs | 44:ece6330e9b57 | 1934 | # program listings (including syntax highlighting and cross-referencing |
| Matt Briggs | 44:ece6330e9b57 | 1935 | # information) to the DOCBOOK output. Note that enabling this will significantly |
| Matt Briggs | 44:ece6330e9b57 | 1936 | # increase the size of the DOCBOOK output. |
| Matt Briggs | 44:ece6330e9b57 | 1937 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 1938 | # This tag requires that the tag GENERATE_DOCBOOK is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1939 | |
| Matt Briggs | 44:ece6330e9b57 | 1940 | DOCBOOK_PROGRAMLISTING = NO |
| Matt Briggs | 44:ece6330e9b57 | 1941 | |
| Matt Briggs | 44:ece6330e9b57 | 1942 | #--------------------------------------------------------------------------- |
| Matt Briggs | 44:ece6330e9b57 | 1943 | # Configuration options for the AutoGen Definitions output |
| Matt Briggs | 44:ece6330e9b57 | 1944 | #--------------------------------------------------------------------------- |
| Matt Briggs | 44:ece6330e9b57 | 1945 | |
| Matt Briggs | 44:ece6330e9b57 | 1946 | # If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an |
| Matt Briggs | 44:ece6330e9b57 | 1947 | # AutoGen Definitions (see http://autogen.sf.net) file that captures the |
| Matt Briggs | 44:ece6330e9b57 | 1948 | # structure of the code including all documentation. Note that this feature is |
| Matt Briggs | 44:ece6330e9b57 | 1949 | # still experimental and incomplete at the moment. |
| Matt Briggs | 44:ece6330e9b57 | 1950 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 1951 | |
| Matt Briggs | 44:ece6330e9b57 | 1952 | GENERATE_AUTOGEN_DEF = NO |
| Matt Briggs | 44:ece6330e9b57 | 1953 | |
| Matt Briggs | 44:ece6330e9b57 | 1954 | #--------------------------------------------------------------------------- |
| Matt Briggs | 44:ece6330e9b57 | 1955 | # Configuration options related to the Perl module output |
| Matt Briggs | 44:ece6330e9b57 | 1956 | #--------------------------------------------------------------------------- |
| Matt Briggs | 44:ece6330e9b57 | 1957 | |
| Matt Briggs | 44:ece6330e9b57 | 1958 | # If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module |
| Matt Briggs | 44:ece6330e9b57 | 1959 | # file that captures the structure of the code including all documentation. |
| Matt Briggs | 44:ece6330e9b57 | 1960 | # |
| Matt Briggs | 44:ece6330e9b57 | 1961 | # Note that this feature is still experimental and incomplete at the moment. |
| Matt Briggs | 44:ece6330e9b57 | 1962 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 1963 | |
| Matt Briggs | 44:ece6330e9b57 | 1964 | GENERATE_PERLMOD = NO |
| Matt Briggs | 44:ece6330e9b57 | 1965 | |
| Matt Briggs | 44:ece6330e9b57 | 1966 | # If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary |
| Matt Briggs | 44:ece6330e9b57 | 1967 | # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI |
| Matt Briggs | 44:ece6330e9b57 | 1968 | # output from the Perl module output. |
| Matt Briggs | 44:ece6330e9b57 | 1969 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 1970 | # This tag requires that the tag GENERATE_PERLMOD is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1971 | |
| Matt Briggs | 44:ece6330e9b57 | 1972 | PERLMOD_LATEX = NO |
| Matt Briggs | 44:ece6330e9b57 | 1973 | |
| Matt Briggs | 44:ece6330e9b57 | 1974 | # If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely |
| Matt Briggs | 44:ece6330e9b57 | 1975 | # formatted so it can be parsed by a human reader. This is useful if you want to |
| Matt Briggs | 44:ece6330e9b57 | 1976 | # understand what is going on. On the other hand, if this tag is set to NO, the |
| Matt Briggs | 44:ece6330e9b57 | 1977 | # size of the Perl module output will be much smaller and Perl will parse it |
| Matt Briggs | 44:ece6330e9b57 | 1978 | # just the same. |
| Matt Briggs | 44:ece6330e9b57 | 1979 | # The default value is: YES. |
| Matt Briggs | 44:ece6330e9b57 | 1980 | # This tag requires that the tag GENERATE_PERLMOD is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1981 | |
| Matt Briggs | 44:ece6330e9b57 | 1982 | PERLMOD_PRETTY = YES |
| Matt Briggs | 44:ece6330e9b57 | 1983 | |
| Matt Briggs | 44:ece6330e9b57 | 1984 | # The names of the make variables in the generated doxyrules.make file are |
| Matt Briggs | 44:ece6330e9b57 | 1985 | # prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful |
| Matt Briggs | 44:ece6330e9b57 | 1986 | # so different doxyrules.make files included by the same Makefile don't |
| Matt Briggs | 44:ece6330e9b57 | 1987 | # overwrite each other's variables. |
| Matt Briggs | 44:ece6330e9b57 | 1988 | # This tag requires that the tag GENERATE_PERLMOD is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 1989 | |
| Matt Briggs | 44:ece6330e9b57 | 1990 | PERLMOD_MAKEVAR_PREFIX = |
| Matt Briggs | 44:ece6330e9b57 | 1991 | |
| Matt Briggs | 44:ece6330e9b57 | 1992 | #--------------------------------------------------------------------------- |
| Matt Briggs | 44:ece6330e9b57 | 1993 | # Configuration options related to the preprocessor |
| Matt Briggs | 44:ece6330e9b57 | 1994 | #--------------------------------------------------------------------------- |
| Matt Briggs | 44:ece6330e9b57 | 1995 | |
| Matt Briggs | 44:ece6330e9b57 | 1996 | # If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all |
| Matt Briggs | 44:ece6330e9b57 | 1997 | # C-preprocessor directives found in the sources and include files. |
| Matt Briggs | 44:ece6330e9b57 | 1998 | # The default value is: YES. |
| Matt Briggs | 44:ece6330e9b57 | 1999 | |
| Matt Briggs | 44:ece6330e9b57 | 2000 | ENABLE_PREPROCESSING = YES |
| Matt Briggs | 44:ece6330e9b57 | 2001 | |
| Matt Briggs | 44:ece6330e9b57 | 2002 | # If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names |
| Matt Briggs | 44:ece6330e9b57 | 2003 | # in the source code. If set to NO, only conditional compilation will be |
| Matt Briggs | 44:ece6330e9b57 | 2004 | # performed. Macro expansion can be done in a controlled way by setting |
| Matt Briggs | 44:ece6330e9b57 | 2005 | # EXPAND_ONLY_PREDEF to YES. |
| Matt Briggs | 44:ece6330e9b57 | 2006 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 2007 | # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 2008 | |
| Matt Briggs | 44:ece6330e9b57 | 2009 | MACRO_EXPANSION = NO |
| Matt Briggs | 44:ece6330e9b57 | 2010 | |
| Matt Briggs | 44:ece6330e9b57 | 2011 | # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then |
| Matt Briggs | 44:ece6330e9b57 | 2012 | # the macro expansion is limited to the macros specified with the PREDEFINED and |
| Matt Briggs | 44:ece6330e9b57 | 2013 | # EXPAND_AS_DEFINED tags. |
| Matt Briggs | 44:ece6330e9b57 | 2014 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 2015 | # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 2016 | |
| Matt Briggs | 44:ece6330e9b57 | 2017 | EXPAND_ONLY_PREDEF = NO |
| Matt Briggs | 44:ece6330e9b57 | 2018 | |
| Matt Briggs | 44:ece6330e9b57 | 2019 | # If the SEARCH_INCLUDES tag is set to YES, the include files in the |
| Matt Briggs | 44:ece6330e9b57 | 2020 | # INCLUDE_PATH will be searched if a #include is found. |
| Matt Briggs | 44:ece6330e9b57 | 2021 | # The default value is: YES. |
| Matt Briggs | 44:ece6330e9b57 | 2022 | # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 2023 | |
| Matt Briggs | 44:ece6330e9b57 | 2024 | SEARCH_INCLUDES = YES |
| Matt Briggs | 44:ece6330e9b57 | 2025 | |
| Matt Briggs | 44:ece6330e9b57 | 2026 | # The INCLUDE_PATH tag can be used to specify one or more directories that |
| Matt Briggs | 44:ece6330e9b57 | 2027 | # contain include files that are not input files but should be processed by the |
| Matt Briggs | 44:ece6330e9b57 | 2028 | # preprocessor. |
| Matt Briggs | 44:ece6330e9b57 | 2029 | # This tag requires that the tag SEARCH_INCLUDES is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 2030 | |
| Matt Briggs | 44:ece6330e9b57 | 2031 | INCLUDE_PATH = |
| Matt Briggs | 44:ece6330e9b57 | 2032 | |
| Matt Briggs | 44:ece6330e9b57 | 2033 | # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard |
| Matt Briggs | 44:ece6330e9b57 | 2034 | # patterns (like *.h and *.hpp) to filter out the header-files in the |
| Matt Briggs | 44:ece6330e9b57 | 2035 | # directories. If left blank, the patterns specified with FILE_PATTERNS will be |
| Matt Briggs | 44:ece6330e9b57 | 2036 | # used. |
| Matt Briggs | 44:ece6330e9b57 | 2037 | # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 2038 | |
| Matt Briggs | 44:ece6330e9b57 | 2039 | INCLUDE_FILE_PATTERNS = |
| Matt Briggs | 44:ece6330e9b57 | 2040 | |
| Matt Briggs | 44:ece6330e9b57 | 2041 | # The PREDEFINED tag can be used to specify one or more macro names that are |
| Matt Briggs | 44:ece6330e9b57 | 2042 | # defined before the preprocessor is started (similar to the -D option of e.g. |
| Matt Briggs | 44:ece6330e9b57 | 2043 | # gcc). The argument of the tag is a list of macros of the form: name or |
| Matt Briggs | 44:ece6330e9b57 | 2044 | # name=definition (no spaces). If the definition and the "=" are omitted, "=1" |
| Matt Briggs | 44:ece6330e9b57 | 2045 | # is assumed. To prevent a macro definition from being undefined via #undef or |
| Matt Briggs | 44:ece6330e9b57 | 2046 | # recursively expanded use the := operator instead of the = operator. |
| Matt Briggs | 44:ece6330e9b57 | 2047 | # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 2048 | |
| Matt Briggs | 44:ece6330e9b57 | 2049 | PREDEFINED = |
| Matt Briggs | 44:ece6330e9b57 | 2050 | |
| Matt Briggs | 44:ece6330e9b57 | 2051 | # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this |
| Matt Briggs | 44:ece6330e9b57 | 2052 | # tag can be used to specify a list of macro names that should be expanded. The |
| Matt Briggs | 44:ece6330e9b57 | 2053 | # macro definition that is found in the sources will be used. Use the PREDEFINED |
| Matt Briggs | 44:ece6330e9b57 | 2054 | # tag if you want to use a different macro definition that overrules the |
| Matt Briggs | 44:ece6330e9b57 | 2055 | # definition found in the source code. |
| Matt Briggs | 44:ece6330e9b57 | 2056 | # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 2057 | |
| Matt Briggs | 44:ece6330e9b57 | 2058 | EXPAND_AS_DEFINED = |
| Matt Briggs | 44:ece6330e9b57 | 2059 | |
| Matt Briggs | 44:ece6330e9b57 | 2060 | # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will |
| Matt Briggs | 44:ece6330e9b57 | 2061 | # remove all references to function-like macros that are alone on a line, have |
| Matt Briggs | 44:ece6330e9b57 | 2062 | # an all uppercase name, and do not end with a semicolon. Such function macros |
| Matt Briggs | 44:ece6330e9b57 | 2063 | # are typically used for boiler-plate code, and will confuse the parser if not |
| Matt Briggs | 44:ece6330e9b57 | 2064 | # removed. |
| Matt Briggs | 44:ece6330e9b57 | 2065 | # The default value is: YES. |
| Matt Briggs | 44:ece6330e9b57 | 2066 | # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 2067 | |
| Matt Briggs | 44:ece6330e9b57 | 2068 | SKIP_FUNCTION_MACROS = YES |
| Matt Briggs | 44:ece6330e9b57 | 2069 | |
| Matt Briggs | 44:ece6330e9b57 | 2070 | #--------------------------------------------------------------------------- |
| Matt Briggs | 44:ece6330e9b57 | 2071 | # Configuration options related to external references |
| Matt Briggs | 44:ece6330e9b57 | 2072 | #--------------------------------------------------------------------------- |
| Matt Briggs | 44:ece6330e9b57 | 2073 | |
| Matt Briggs | 44:ece6330e9b57 | 2074 | # The TAGFILES tag can be used to specify one or more tag files. For each tag |
| Matt Briggs | 44:ece6330e9b57 | 2075 | # file the location of the external documentation should be added. The format of |
| Matt Briggs | 44:ece6330e9b57 | 2076 | # a tag file without this location is as follows: |
| Matt Briggs | 44:ece6330e9b57 | 2077 | # TAGFILES = file1 file2 ... |
| Matt Briggs | 44:ece6330e9b57 | 2078 | # Adding location for the tag files is done as follows: |
| Matt Briggs | 44:ece6330e9b57 | 2079 | # TAGFILES = file1=loc1 "file2 = loc2" ... |
| Matt Briggs | 44:ece6330e9b57 | 2080 | # where loc1 and loc2 can be relative or absolute paths or URLs. See the |
| Matt Briggs | 44:ece6330e9b57 | 2081 | # section "Linking to external documentation" for more information about the use |
| Matt Briggs | 44:ece6330e9b57 | 2082 | # of tag files. |
| Matt Briggs | 44:ece6330e9b57 | 2083 | # Note: Each tag file must have a unique name (where the name does NOT include |
| Matt Briggs | 44:ece6330e9b57 | 2084 | # the path). If a tag file is not located in the directory in which doxygen is |
| Matt Briggs | 44:ece6330e9b57 | 2085 | # run, you must also specify the path to the tagfile here. |
| Matt Briggs | 44:ece6330e9b57 | 2086 | |
| Matt Briggs | 44:ece6330e9b57 | 2087 | TAGFILES = |
| Matt Briggs | 44:ece6330e9b57 | 2088 | |
| Matt Briggs | 44:ece6330e9b57 | 2089 | # When a file name is specified after GENERATE_TAGFILE, doxygen will create a |
| Matt Briggs | 44:ece6330e9b57 | 2090 | # tag file that is based on the input files it reads. See section "Linking to |
| Matt Briggs | 44:ece6330e9b57 | 2091 | # external documentation" for more information about the usage of tag files. |
| Matt Briggs | 44:ece6330e9b57 | 2092 | |
| Matt Briggs | 44:ece6330e9b57 | 2093 | GENERATE_TAGFILE = |
| Matt Briggs | 44:ece6330e9b57 | 2094 | |
| Matt Briggs | 44:ece6330e9b57 | 2095 | # If the ALLEXTERNALS tag is set to YES, all external class will be listed in |
| Matt Briggs | 44:ece6330e9b57 | 2096 | # the class index. If set to NO, only the inherited external classes will be |
| Matt Briggs | 44:ece6330e9b57 | 2097 | # listed. |
| Matt Briggs | 44:ece6330e9b57 | 2098 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 2099 | |
| Matt Briggs | 44:ece6330e9b57 | 2100 | ALLEXTERNALS = NO |
| Matt Briggs | 44:ece6330e9b57 | 2101 | |
| Matt Briggs | 44:ece6330e9b57 | 2102 | # If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed |
| Matt Briggs | 44:ece6330e9b57 | 2103 | # in the modules index. If set to NO, only the current project's groups will be |
| Matt Briggs | 44:ece6330e9b57 | 2104 | # listed. |
| Matt Briggs | 44:ece6330e9b57 | 2105 | # The default value is: YES. |
| Matt Briggs | 44:ece6330e9b57 | 2106 | |
| Matt Briggs | 44:ece6330e9b57 | 2107 | EXTERNAL_GROUPS = YES |
| Matt Briggs | 44:ece6330e9b57 | 2108 | |
| Matt Briggs | 44:ece6330e9b57 | 2109 | # If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in |
| Matt Briggs | 44:ece6330e9b57 | 2110 | # the related pages index. If set to NO, only the current project's pages will |
| Matt Briggs | 44:ece6330e9b57 | 2111 | # be listed. |
| Matt Briggs | 44:ece6330e9b57 | 2112 | # The default value is: YES. |
| Matt Briggs | 44:ece6330e9b57 | 2113 | |
| Matt Briggs | 44:ece6330e9b57 | 2114 | EXTERNAL_PAGES = YES |
| Matt Briggs | 44:ece6330e9b57 | 2115 | |
| Matt Briggs | 44:ece6330e9b57 | 2116 | # The PERL_PATH should be the absolute path and name of the perl script |
| Matt Briggs | 44:ece6330e9b57 | 2117 | # interpreter (i.e. the result of 'which perl'). |
| Matt Briggs | 44:ece6330e9b57 | 2118 | # The default file (with absolute path) is: /usr/bin/perl. |
| Matt Briggs | 44:ece6330e9b57 | 2119 | |
| Matt Briggs | 44:ece6330e9b57 | 2120 | PERL_PATH = /usr/bin/perl |
| Matt Briggs | 44:ece6330e9b57 | 2121 | |
| Matt Briggs | 44:ece6330e9b57 | 2122 | #--------------------------------------------------------------------------- |
| Matt Briggs | 44:ece6330e9b57 | 2123 | # Configuration options related to the dot tool |
| Matt Briggs | 44:ece6330e9b57 | 2124 | #--------------------------------------------------------------------------- |
| Matt Briggs | 44:ece6330e9b57 | 2125 | |
| Matt Briggs | 44:ece6330e9b57 | 2126 | # If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram |
| Matt Briggs | 44:ece6330e9b57 | 2127 | # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to |
| Matt Briggs | 44:ece6330e9b57 | 2128 | # NO turns the diagrams off. Note that this option also works with HAVE_DOT |
| Matt Briggs | 44:ece6330e9b57 | 2129 | # disabled, but it is recommended to install and use dot, since it yields more |
| Matt Briggs | 44:ece6330e9b57 | 2130 | # powerful graphs. |
| Matt Briggs | 44:ece6330e9b57 | 2131 | # The default value is: YES. |
| Matt Briggs | 44:ece6330e9b57 | 2132 | |
| Matt Briggs | 44:ece6330e9b57 | 2133 | CLASS_DIAGRAMS = YES |
| Matt Briggs | 44:ece6330e9b57 | 2134 | |
| Matt Briggs | 44:ece6330e9b57 | 2135 | # You can define message sequence charts within doxygen comments using the \msc |
| Matt Briggs | 44:ece6330e9b57 | 2136 | # command. Doxygen will then run the mscgen tool (see: |
| Matt Briggs | 44:ece6330e9b57 | 2137 | # http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the |
| Matt Briggs | 44:ece6330e9b57 | 2138 | # documentation. The MSCGEN_PATH tag allows you to specify the directory where |
| Matt Briggs | 44:ece6330e9b57 | 2139 | # the mscgen tool resides. If left empty the tool is assumed to be found in the |
| Matt Briggs | 44:ece6330e9b57 | 2140 | # default search path. |
| Matt Briggs | 44:ece6330e9b57 | 2141 | |
| Matt Briggs | 44:ece6330e9b57 | 2142 | MSCGEN_PATH = |
| Matt Briggs | 44:ece6330e9b57 | 2143 | |
| Matt Briggs | 44:ece6330e9b57 | 2144 | # You can include diagrams made with dia in doxygen documentation. Doxygen will |
| Matt Briggs | 44:ece6330e9b57 | 2145 | # then run dia to produce the diagram and insert it in the documentation. The |
| Matt Briggs | 44:ece6330e9b57 | 2146 | # DIA_PATH tag allows you to specify the directory where the dia binary resides. |
| Matt Briggs | 44:ece6330e9b57 | 2147 | # If left empty dia is assumed to be found in the default search path. |
| Matt Briggs | 44:ece6330e9b57 | 2148 | |
| Matt Briggs | 44:ece6330e9b57 | 2149 | DIA_PATH = |
| Matt Briggs | 44:ece6330e9b57 | 2150 | |
| Matt Briggs | 44:ece6330e9b57 | 2151 | # If set to YES the inheritance and collaboration graphs will hide inheritance |
| Matt Briggs | 44:ece6330e9b57 | 2152 | # and usage relations if the target is undocumented or is not a class. |
| Matt Briggs | 44:ece6330e9b57 | 2153 | # The default value is: YES. |
| Matt Briggs | 44:ece6330e9b57 | 2154 | |
| Matt Briggs | 44:ece6330e9b57 | 2155 | HIDE_UNDOC_RELATIONS = YES |
| Matt Briggs | 44:ece6330e9b57 | 2156 | |
| Matt Briggs | 44:ece6330e9b57 | 2157 | # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is |
| Matt Briggs | 44:ece6330e9b57 | 2158 | # available from the path. This tool is part of Graphviz (see: |
| Matt Briggs | 44:ece6330e9b57 | 2159 | # http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent |
| Matt Briggs | 44:ece6330e9b57 | 2160 | # Bell Labs. The other options in this section have no effect if this option is |
| Matt Briggs | 44:ece6330e9b57 | 2161 | # set to NO |
| Matt Briggs | 44:ece6330e9b57 | 2162 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 2163 | |
| Matt Briggs | 44:ece6330e9b57 | 2164 | HAVE_DOT = NO |
| Matt Briggs | 44:ece6330e9b57 | 2165 | |
| Matt Briggs | 44:ece6330e9b57 | 2166 | # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed |
| Matt Briggs | 44:ece6330e9b57 | 2167 | # to run in parallel. When set to 0 doxygen will base this on the number of |
| Matt Briggs | 44:ece6330e9b57 | 2168 | # processors available in the system. You can set it explicitly to a value |
| Matt Briggs | 44:ece6330e9b57 | 2169 | # larger than 0 to get control over the balance between CPU load and processing |
| Matt Briggs | 44:ece6330e9b57 | 2170 | # speed. |
| Matt Briggs | 44:ece6330e9b57 | 2171 | # Minimum value: 0, maximum value: 32, default value: 0. |
| Matt Briggs | 44:ece6330e9b57 | 2172 | # This tag requires that the tag HAVE_DOT is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 2173 | |
| Matt Briggs | 44:ece6330e9b57 | 2174 | DOT_NUM_THREADS = 0 |
| Matt Briggs | 44:ece6330e9b57 | 2175 | |
| Matt Briggs | 44:ece6330e9b57 | 2176 | # When you want a differently looking font in the dot files that doxygen |
| Matt Briggs | 44:ece6330e9b57 | 2177 | # generates you can specify the font name using DOT_FONTNAME. You need to make |
| Matt Briggs | 44:ece6330e9b57 | 2178 | # sure dot is able to find the font, which can be done by putting it in a |
| Matt Briggs | 44:ece6330e9b57 | 2179 | # standard location or by setting the DOTFONTPATH environment variable or by |
| Matt Briggs | 44:ece6330e9b57 | 2180 | # setting DOT_FONTPATH to the directory containing the font. |
| Matt Briggs | 44:ece6330e9b57 | 2181 | # The default value is: Helvetica. |
| Matt Briggs | 44:ece6330e9b57 | 2182 | # This tag requires that the tag HAVE_DOT is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 2183 | |
| Matt Briggs | 44:ece6330e9b57 | 2184 | DOT_FONTNAME = Helvetica |
| Matt Briggs | 44:ece6330e9b57 | 2185 | |
| Matt Briggs | 44:ece6330e9b57 | 2186 | # The DOT_FONTSIZE tag can be used to set the size (in points) of the font of |
| Matt Briggs | 44:ece6330e9b57 | 2187 | # dot graphs. |
| Matt Briggs | 44:ece6330e9b57 | 2188 | # Minimum value: 4, maximum value: 24, default value: 10. |
| Matt Briggs | 44:ece6330e9b57 | 2189 | # This tag requires that the tag HAVE_DOT is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 2190 | |
| Matt Briggs | 44:ece6330e9b57 | 2191 | DOT_FONTSIZE = 10 |
| Matt Briggs | 44:ece6330e9b57 | 2192 | |
| Matt Briggs | 44:ece6330e9b57 | 2193 | # By default doxygen will tell dot to use the default font as specified with |
| Matt Briggs | 44:ece6330e9b57 | 2194 | # DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set |
| Matt Briggs | 44:ece6330e9b57 | 2195 | # the path where dot can find it using this tag. |
| Matt Briggs | 44:ece6330e9b57 | 2196 | # This tag requires that the tag HAVE_DOT is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 2197 | |
| Matt Briggs | 44:ece6330e9b57 | 2198 | DOT_FONTPATH = |
| Matt Briggs | 44:ece6330e9b57 | 2199 | |
| Matt Briggs | 44:ece6330e9b57 | 2200 | # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for |
| Matt Briggs | 44:ece6330e9b57 | 2201 | # each documented class showing the direct and indirect inheritance relations. |
| Matt Briggs | 44:ece6330e9b57 | 2202 | # Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO. |
| Matt Briggs | 44:ece6330e9b57 | 2203 | # The default value is: YES. |
| Matt Briggs | 44:ece6330e9b57 | 2204 | # This tag requires that the tag HAVE_DOT is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 2205 | |
| Matt Briggs | 44:ece6330e9b57 | 2206 | CLASS_GRAPH = YES |
| Matt Briggs | 44:ece6330e9b57 | 2207 | |
| Matt Briggs | 44:ece6330e9b57 | 2208 | # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a |
| Matt Briggs | 44:ece6330e9b57 | 2209 | # graph for each documented class showing the direct and indirect implementation |
| Matt Briggs | 44:ece6330e9b57 | 2210 | # dependencies (inheritance, containment, and class references variables) of the |
| Matt Briggs | 44:ece6330e9b57 | 2211 | # class with other documented classes. |
| Matt Briggs | 44:ece6330e9b57 | 2212 | # The default value is: YES. |
| Matt Briggs | 44:ece6330e9b57 | 2213 | # This tag requires that the tag HAVE_DOT is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 2214 | |
| Matt Briggs | 44:ece6330e9b57 | 2215 | COLLABORATION_GRAPH = YES |
| Matt Briggs | 44:ece6330e9b57 | 2216 | |
| Matt Briggs | 44:ece6330e9b57 | 2217 | # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for |
| Matt Briggs | 44:ece6330e9b57 | 2218 | # groups, showing the direct groups dependencies. |
| Matt Briggs | 44:ece6330e9b57 | 2219 | # The default value is: YES. |
| Matt Briggs | 44:ece6330e9b57 | 2220 | # This tag requires that the tag HAVE_DOT is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 2221 | |
| Matt Briggs | 44:ece6330e9b57 | 2222 | GROUP_GRAPHS = YES |
| Matt Briggs | 44:ece6330e9b57 | 2223 | |
| Matt Briggs | 44:ece6330e9b57 | 2224 | # If the UML_LOOK tag is set to YES, doxygen will generate inheritance and |
| Matt Briggs | 44:ece6330e9b57 | 2225 | # collaboration diagrams in a style similar to the OMG's Unified Modeling |
| Matt Briggs | 44:ece6330e9b57 | 2226 | # Language. |
| Matt Briggs | 44:ece6330e9b57 | 2227 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 2228 | # This tag requires that the tag HAVE_DOT is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 2229 | |
| Matt Briggs | 44:ece6330e9b57 | 2230 | UML_LOOK = NO |
| Matt Briggs | 44:ece6330e9b57 | 2231 | |
| Matt Briggs | 44:ece6330e9b57 | 2232 | # If the UML_LOOK tag is enabled, the fields and methods are shown inside the |
| Matt Briggs | 44:ece6330e9b57 | 2233 | # class node. If there are many fields or methods and many nodes the graph may |
| Matt Briggs | 44:ece6330e9b57 | 2234 | # become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the |
| Matt Briggs | 44:ece6330e9b57 | 2235 | # number of items for each type to make the size more manageable. Set this to 0 |
| Matt Briggs | 44:ece6330e9b57 | 2236 | # for no limit. Note that the threshold may be exceeded by 50% before the limit |
| Matt Briggs | 44:ece6330e9b57 | 2237 | # is enforced. So when you set the threshold to 10, up to 15 fields may appear, |
| Matt Briggs | 44:ece6330e9b57 | 2238 | # but if the number exceeds 15, the total amount of fields shown is limited to |
| Matt Briggs | 44:ece6330e9b57 | 2239 | # 10. |
| Matt Briggs | 44:ece6330e9b57 | 2240 | # Minimum value: 0, maximum value: 100, default value: 10. |
| Matt Briggs | 44:ece6330e9b57 | 2241 | # This tag requires that the tag HAVE_DOT is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 2242 | |
| Matt Briggs | 44:ece6330e9b57 | 2243 | UML_LIMIT_NUM_FIELDS = 10 |
| Matt Briggs | 44:ece6330e9b57 | 2244 | |
| Matt Briggs | 44:ece6330e9b57 | 2245 | # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and |
| Matt Briggs | 44:ece6330e9b57 | 2246 | # collaboration graphs will show the relations between templates and their |
| Matt Briggs | 44:ece6330e9b57 | 2247 | # instances. |
| Matt Briggs | 44:ece6330e9b57 | 2248 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 2249 | # This tag requires that the tag HAVE_DOT is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 2250 | |
| Matt Briggs | 44:ece6330e9b57 | 2251 | TEMPLATE_RELATIONS = NO |
| Matt Briggs | 44:ece6330e9b57 | 2252 | |
| Matt Briggs | 44:ece6330e9b57 | 2253 | # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to |
| Matt Briggs | 44:ece6330e9b57 | 2254 | # YES then doxygen will generate a graph for each documented file showing the |
| Matt Briggs | 44:ece6330e9b57 | 2255 | # direct and indirect include dependencies of the file with other documented |
| Matt Briggs | 44:ece6330e9b57 | 2256 | # files. |
| Matt Briggs | 44:ece6330e9b57 | 2257 | # The default value is: YES. |
| Matt Briggs | 44:ece6330e9b57 | 2258 | # This tag requires that the tag HAVE_DOT is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 2259 | |
| Matt Briggs | 44:ece6330e9b57 | 2260 | INCLUDE_GRAPH = YES |
| Matt Briggs | 44:ece6330e9b57 | 2261 | |
| Matt Briggs | 44:ece6330e9b57 | 2262 | # If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are |
| Matt Briggs | 44:ece6330e9b57 | 2263 | # set to YES then doxygen will generate a graph for each documented file showing |
| Matt Briggs | 44:ece6330e9b57 | 2264 | # the direct and indirect include dependencies of the file with other documented |
| Matt Briggs | 44:ece6330e9b57 | 2265 | # files. |
| Matt Briggs | 44:ece6330e9b57 | 2266 | # The default value is: YES. |
| Matt Briggs | 44:ece6330e9b57 | 2267 | # This tag requires that the tag HAVE_DOT is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 2268 | |
| Matt Briggs | 44:ece6330e9b57 | 2269 | INCLUDED_BY_GRAPH = YES |
| Matt Briggs | 44:ece6330e9b57 | 2270 | |
| Matt Briggs | 44:ece6330e9b57 | 2271 | # If the CALL_GRAPH tag is set to YES then doxygen will generate a call |
| Matt Briggs | 44:ece6330e9b57 | 2272 | # dependency graph for every global function or class method. |
| Matt Briggs | 44:ece6330e9b57 | 2273 | # |
| Matt Briggs | 44:ece6330e9b57 | 2274 | # Note that enabling this option will significantly increase the time of a run. |
| Matt Briggs | 44:ece6330e9b57 | 2275 | # So in most cases it will be better to enable call graphs for selected |
| Matt Briggs | 44:ece6330e9b57 | 2276 | # functions only using the \callgraph command. Disabling a call graph can be |
| Matt Briggs | 44:ece6330e9b57 | 2277 | # accomplished by means of the command \hidecallgraph. |
| Matt Briggs | 44:ece6330e9b57 | 2278 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 2279 | # This tag requires that the tag HAVE_DOT is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 2280 | |
| Matt Briggs | 44:ece6330e9b57 | 2281 | CALL_GRAPH = NO |
| Matt Briggs | 44:ece6330e9b57 | 2282 | |
| Matt Briggs | 44:ece6330e9b57 | 2283 | # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller |
| Matt Briggs | 44:ece6330e9b57 | 2284 | # dependency graph for every global function or class method. |
| Matt Briggs | 44:ece6330e9b57 | 2285 | # |
| Matt Briggs | 44:ece6330e9b57 | 2286 | # Note that enabling this option will significantly increase the time of a run. |
| Matt Briggs | 44:ece6330e9b57 | 2287 | # So in most cases it will be better to enable caller graphs for selected |
| Matt Briggs | 44:ece6330e9b57 | 2288 | # functions only using the \callergraph command. Disabling a caller graph can be |
| Matt Briggs | 44:ece6330e9b57 | 2289 | # accomplished by means of the command \hidecallergraph. |
| Matt Briggs | 44:ece6330e9b57 | 2290 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 2291 | # This tag requires that the tag HAVE_DOT is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 2292 | |
| Matt Briggs | 44:ece6330e9b57 | 2293 | CALLER_GRAPH = NO |
| Matt Briggs | 44:ece6330e9b57 | 2294 | |
| Matt Briggs | 44:ece6330e9b57 | 2295 | # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical |
| Matt Briggs | 44:ece6330e9b57 | 2296 | # hierarchy of all classes instead of a textual one. |
| Matt Briggs | 44:ece6330e9b57 | 2297 | # The default value is: YES. |
| Matt Briggs | 44:ece6330e9b57 | 2298 | # This tag requires that the tag HAVE_DOT is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 2299 | |
| Matt Briggs | 44:ece6330e9b57 | 2300 | GRAPHICAL_HIERARCHY = YES |
| Matt Briggs | 44:ece6330e9b57 | 2301 | |
| Matt Briggs | 44:ece6330e9b57 | 2302 | # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the |
| Matt Briggs | 44:ece6330e9b57 | 2303 | # dependencies a directory has on other directories in a graphical way. The |
| Matt Briggs | 44:ece6330e9b57 | 2304 | # dependency relations are determined by the #include relations between the |
| Matt Briggs | 44:ece6330e9b57 | 2305 | # files in the directories. |
| Matt Briggs | 44:ece6330e9b57 | 2306 | # The default value is: YES. |
| Matt Briggs | 44:ece6330e9b57 | 2307 | # This tag requires that the tag HAVE_DOT is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 2308 | |
| Matt Briggs | 44:ece6330e9b57 | 2309 | DIRECTORY_GRAPH = YES |
| Matt Briggs | 44:ece6330e9b57 | 2310 | |
| Matt Briggs | 44:ece6330e9b57 | 2311 | # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images |
| Matt Briggs | 44:ece6330e9b57 | 2312 | # generated by dot. For an explanation of the image formats see the section |
| Matt Briggs | 44:ece6330e9b57 | 2313 | # output formats in the documentation of the dot tool (Graphviz (see: |
| Matt Briggs | 44:ece6330e9b57 | 2314 | # http://www.graphviz.org/)). |
| Matt Briggs | 44:ece6330e9b57 | 2315 | # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order |
| Matt Briggs | 44:ece6330e9b57 | 2316 | # to make the SVG files visible in IE 9+ (other browsers do not have this |
| Matt Briggs | 44:ece6330e9b57 | 2317 | # requirement). |
| Matt Briggs | 44:ece6330e9b57 | 2318 | # Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo, |
| Matt Briggs | 44:ece6330e9b57 | 2319 | # png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and |
| Matt Briggs | 44:ece6330e9b57 | 2320 | # png:gdiplus:gdiplus. |
| Matt Briggs | 44:ece6330e9b57 | 2321 | # The default value is: png. |
| Matt Briggs | 44:ece6330e9b57 | 2322 | # This tag requires that the tag HAVE_DOT is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 2323 | |
| Matt Briggs | 44:ece6330e9b57 | 2324 | DOT_IMAGE_FORMAT = png |
| Matt Briggs | 44:ece6330e9b57 | 2325 | |
| Matt Briggs | 44:ece6330e9b57 | 2326 | # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to |
| Matt Briggs | 44:ece6330e9b57 | 2327 | # enable generation of interactive SVG images that allow zooming and panning. |
| Matt Briggs | 44:ece6330e9b57 | 2328 | # |
| Matt Briggs | 44:ece6330e9b57 | 2329 | # Note that this requires a modern browser other than Internet Explorer. Tested |
| Matt Briggs | 44:ece6330e9b57 | 2330 | # and working are Firefox, Chrome, Safari, and Opera. |
| Matt Briggs | 44:ece6330e9b57 | 2331 | # Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make |
| Matt Briggs | 44:ece6330e9b57 | 2332 | # the SVG files visible. Older versions of IE do not have SVG support. |
| Matt Briggs | 44:ece6330e9b57 | 2333 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 2334 | # This tag requires that the tag HAVE_DOT is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 2335 | |
| Matt Briggs | 44:ece6330e9b57 | 2336 | INTERACTIVE_SVG = NO |
| Matt Briggs | 44:ece6330e9b57 | 2337 | |
| Matt Briggs | 44:ece6330e9b57 | 2338 | # The DOT_PATH tag can be used to specify the path where the dot tool can be |
| Matt Briggs | 44:ece6330e9b57 | 2339 | # found. If left blank, it is assumed the dot tool can be found in the path. |
| Matt Briggs | 44:ece6330e9b57 | 2340 | # This tag requires that the tag HAVE_DOT is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 2341 | |
| Matt Briggs | 44:ece6330e9b57 | 2342 | DOT_PATH = |
| Matt Briggs | 44:ece6330e9b57 | 2343 | |
| Matt Briggs | 44:ece6330e9b57 | 2344 | # The DOTFILE_DIRS tag can be used to specify one or more directories that |
| Matt Briggs | 44:ece6330e9b57 | 2345 | # contain dot files that are included in the documentation (see the \dotfile |
| Matt Briggs | 44:ece6330e9b57 | 2346 | # command). |
| Matt Briggs | 44:ece6330e9b57 | 2347 | # This tag requires that the tag HAVE_DOT is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 2348 | |
| Matt Briggs | 44:ece6330e9b57 | 2349 | DOTFILE_DIRS = |
| Matt Briggs | 44:ece6330e9b57 | 2350 | |
| Matt Briggs | 44:ece6330e9b57 | 2351 | # The MSCFILE_DIRS tag can be used to specify one or more directories that |
| Matt Briggs | 44:ece6330e9b57 | 2352 | # contain msc files that are included in the documentation (see the \mscfile |
| Matt Briggs | 44:ece6330e9b57 | 2353 | # command). |
| Matt Briggs | 44:ece6330e9b57 | 2354 | |
| Matt Briggs | 44:ece6330e9b57 | 2355 | MSCFILE_DIRS = |
| Matt Briggs | 44:ece6330e9b57 | 2356 | |
| Matt Briggs | 44:ece6330e9b57 | 2357 | # The DIAFILE_DIRS tag can be used to specify one or more directories that |
| Matt Briggs | 44:ece6330e9b57 | 2358 | # contain dia files that are included in the documentation (see the \diafile |
| Matt Briggs | 44:ece6330e9b57 | 2359 | # command). |
| Matt Briggs | 44:ece6330e9b57 | 2360 | |
| Matt Briggs | 44:ece6330e9b57 | 2361 | DIAFILE_DIRS = |
| Matt Briggs | 44:ece6330e9b57 | 2362 | |
| Matt Briggs | 44:ece6330e9b57 | 2363 | # When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the |
| Matt Briggs | 44:ece6330e9b57 | 2364 | # path where java can find the plantuml.jar file. If left blank, it is assumed |
| Matt Briggs | 44:ece6330e9b57 | 2365 | # PlantUML is not used or called during a preprocessing step. Doxygen will |
| Matt Briggs | 44:ece6330e9b57 | 2366 | # generate a warning when it encounters a \startuml command in this case and |
| Matt Briggs | 44:ece6330e9b57 | 2367 | # will not generate output for the diagram. |
| Matt Briggs | 44:ece6330e9b57 | 2368 | |
| Matt Briggs | 44:ece6330e9b57 | 2369 | PLANTUML_JAR_PATH = |
| Matt Briggs | 44:ece6330e9b57 | 2370 | |
| Matt Briggs | 44:ece6330e9b57 | 2371 | # When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a |
| Matt Briggs | 44:ece6330e9b57 | 2372 | # configuration file for plantuml. |
| Matt Briggs | 44:ece6330e9b57 | 2373 | |
| Matt Briggs | 44:ece6330e9b57 | 2374 | PLANTUML_CFG_FILE = |
| Matt Briggs | 44:ece6330e9b57 | 2375 | |
| Matt Briggs | 44:ece6330e9b57 | 2376 | # When using plantuml, the specified paths are searched for files specified by |
| Matt Briggs | 44:ece6330e9b57 | 2377 | # the !include statement in a plantuml block. |
| Matt Briggs | 44:ece6330e9b57 | 2378 | |
| Matt Briggs | 44:ece6330e9b57 | 2379 | PLANTUML_INCLUDE_PATH = |
| Matt Briggs | 44:ece6330e9b57 | 2380 | |
| Matt Briggs | 44:ece6330e9b57 | 2381 | # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes |
| Matt Briggs | 44:ece6330e9b57 | 2382 | # that will be shown in the graph. If the number of nodes in a graph becomes |
| Matt Briggs | 44:ece6330e9b57 | 2383 | # larger than this value, doxygen will truncate the graph, which is visualized |
| Matt Briggs | 44:ece6330e9b57 | 2384 | # by representing a node as a red box. Note that doxygen if the number of direct |
| Matt Briggs | 44:ece6330e9b57 | 2385 | # children of the root node in a graph is already larger than |
| Matt Briggs | 44:ece6330e9b57 | 2386 | # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that |
| Matt Briggs | 44:ece6330e9b57 | 2387 | # the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. |
| Matt Briggs | 44:ece6330e9b57 | 2388 | # Minimum value: 0, maximum value: 10000, default value: 50. |
| Matt Briggs | 44:ece6330e9b57 | 2389 | # This tag requires that the tag HAVE_DOT is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 2390 | |
| Matt Briggs | 44:ece6330e9b57 | 2391 | DOT_GRAPH_MAX_NODES = 50 |
| Matt Briggs | 44:ece6330e9b57 | 2392 | |
| Matt Briggs | 44:ece6330e9b57 | 2393 | # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs |
| Matt Briggs | 44:ece6330e9b57 | 2394 | # generated by dot. A depth value of 3 means that only nodes reachable from the |
| Matt Briggs | 44:ece6330e9b57 | 2395 | # root by following a path via at most 3 edges will be shown. Nodes that lay |
| Matt Briggs | 44:ece6330e9b57 | 2396 | # further from the root node will be omitted. Note that setting this option to 1 |
| Matt Briggs | 44:ece6330e9b57 | 2397 | # or 2 may greatly reduce the computation time needed for large code bases. Also |
| Matt Briggs | 44:ece6330e9b57 | 2398 | # note that the size of a graph can be further restricted by |
| Matt Briggs | 44:ece6330e9b57 | 2399 | # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. |
| Matt Briggs | 44:ece6330e9b57 | 2400 | # Minimum value: 0, maximum value: 1000, default value: 0. |
| Matt Briggs | 44:ece6330e9b57 | 2401 | # This tag requires that the tag HAVE_DOT is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 2402 | |
| Matt Briggs | 44:ece6330e9b57 | 2403 | MAX_DOT_GRAPH_DEPTH = 0 |
| Matt Briggs | 44:ece6330e9b57 | 2404 | |
| Matt Briggs | 44:ece6330e9b57 | 2405 | # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent |
| Matt Briggs | 44:ece6330e9b57 | 2406 | # background. This is disabled by default, because dot on Windows does not seem |
| Matt Briggs | 44:ece6330e9b57 | 2407 | # to support this out of the box. |
| Matt Briggs | 44:ece6330e9b57 | 2408 | # |
| Matt Briggs | 44:ece6330e9b57 | 2409 | # Warning: Depending on the platform used, enabling this option may lead to |
| Matt Briggs | 44:ece6330e9b57 | 2410 | # badly anti-aliased labels on the edges of a graph (i.e. they become hard to |
| Matt Briggs | 44:ece6330e9b57 | 2411 | # read). |
| Matt Briggs | 44:ece6330e9b57 | 2412 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 2413 | # This tag requires that the tag HAVE_DOT is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 2414 | |
| Matt Briggs | 44:ece6330e9b57 | 2415 | DOT_TRANSPARENT = NO |
| Matt Briggs | 44:ece6330e9b57 | 2416 | |
| Matt Briggs | 44:ece6330e9b57 | 2417 | # Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output |
| Matt Briggs | 44:ece6330e9b57 | 2418 | # files in one run (i.e. multiple -o and -T options on the command line). This |
| Matt Briggs | 44:ece6330e9b57 | 2419 | # makes dot run faster, but since only newer versions of dot (>1.8.10) support |
| Matt Briggs | 44:ece6330e9b57 | 2420 | # this, this feature is disabled by default. |
| Matt Briggs | 44:ece6330e9b57 | 2421 | # The default value is: NO. |
| Matt Briggs | 44:ece6330e9b57 | 2422 | # This tag requires that the tag HAVE_DOT is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 2423 | |
| Matt Briggs | 44:ece6330e9b57 | 2424 | DOT_MULTI_TARGETS = NO |
| Matt Briggs | 44:ece6330e9b57 | 2425 | |
| Matt Briggs | 44:ece6330e9b57 | 2426 | # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page |
| Matt Briggs | 44:ece6330e9b57 | 2427 | # explaining the meaning of the various boxes and arrows in the dot generated |
| Matt Briggs | 44:ece6330e9b57 | 2428 | # graphs. |
| Matt Briggs | 44:ece6330e9b57 | 2429 | # The default value is: YES. |
| Matt Briggs | 44:ece6330e9b57 | 2430 | # This tag requires that the tag HAVE_DOT is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 2431 | |
| Matt Briggs | 44:ece6330e9b57 | 2432 | GENERATE_LEGEND = YES |
| Matt Briggs | 44:ece6330e9b57 | 2433 | |
| Matt Briggs | 44:ece6330e9b57 | 2434 | # If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot |
| Matt Briggs | 44:ece6330e9b57 | 2435 | # files that are used to generate the various graphs. |
| Matt Briggs | 44:ece6330e9b57 | 2436 | # The default value is: YES. |
| Matt Briggs | 44:ece6330e9b57 | 2437 | # This tag requires that the tag HAVE_DOT is set to YES. |
| Matt Briggs | 44:ece6330e9b57 | 2438 | |
| Matt Briggs | 44:ece6330e9b57 | 2439 | DOT_CLEANUP = YES |