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