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