doxyfile · rachel/workerd

File
Blob: doxyfile

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