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