xref: /aosp_15_r20/external/grpc-grpc/tools/doxygen/Doxyfile.objc.internal (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 Objective-C"
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         = 1.63.1
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/objc.internal
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/cpp-style-guide.md \
775doc/environment_variables.md \
776doc/fail_fast.md \
777doc/fork_support.md \
778doc/g_stands_for.md \
779doc/grpc_release_schedule.md \
780doc/grpc_xds_features.md \
781doc/health-checking.md \
782doc/http-grpc-status-mapping.md \
783doc/http2-interop-test-descriptions.md \
784doc/internationalization.md \
785doc/interop-test-descriptions.md \
786doc/keepalive.md \
787doc/load-balancing.md \
788doc/naming.md \
789doc/qos-dscp.md \
790doc/security_audit.md \
791doc/server-reflection.md \
792doc/server_reflection_tutorial.md \
793doc/server_side_auth.md \
794doc/service_config.md \
795doc/ssl-performance.md \
796doc/status_ordering.md \
797doc/statuscodes.md \
798doc/unit_testing.md \
799doc/versioning.md \
800doc/wait-for-ready.md \
801doc/workarounds.md \
802doc/xds-test-descriptions.md \
803src/objective-c/GRPCClient/GRPCCall+ChannelArg.h \
804src/objective-c/GRPCClient/GRPCCall+ChannelCredentials.h \
805src/objective-c/GRPCClient/GRPCCall+Cronet.h \
806src/objective-c/GRPCClient/GRPCCall+GID.h \
807src/objective-c/GRPCClient/GRPCCall+Interceptor.h \
808src/objective-c/GRPCClient/GRPCCall+OAuth2.h \
809src/objective-c/GRPCClient/GRPCCall+Tests.h \
810src/objective-c/GRPCClient/GRPCCall.h \
811src/objective-c/GRPCClient/GRPCCallLegacy.h \
812src/objective-c/GRPCClient/GRPCCallOptions.h \
813src/objective-c/GRPCClient/GRPCDispatchable.h \
814src/objective-c/GRPCClient/GRPCInterceptor.h \
815src/objective-c/GRPCClient/GRPCTransport.h \
816src/objective-c/GRPCClient/GRPCTypes.h \
817src/objective-c/GRPCClient/README.md \
818src/objective-c/GRPCClient/internal/GRPCCallOptions+Internal.h \
819src/objective-c/GRPCClient/internal_testing/GRPCCall+InternalTests.h \
820src/objective-c/GRPCClient/private/GRPCCore/ChannelArgsUtil.h \
821src/objective-c/GRPCClient/private/GRPCCore/GRPCCall+V2API.h \
822src/objective-c/GRPCClient/private/GRPCCore/GRPCCallInternal.h \
823src/objective-c/GRPCClient/private/GRPCCore/GRPCChannel.h \
824src/objective-c/GRPCClient/private/GRPCCore/GRPCChannelFactory.h \
825src/objective-c/GRPCClient/private/GRPCCore/GRPCChannelPool+Test.h \
826src/objective-c/GRPCClient/private/GRPCCore/GRPCChannelPool.h \
827src/objective-c/GRPCClient/private/GRPCCore/GRPCCompletionQueue.h \
828src/objective-c/GRPCClient/private/GRPCCore/GRPCCoreCronet/GRPCCoreCronetFactory.h \
829src/objective-c/GRPCClient/private/GRPCCore/GRPCCoreCronet/GRPCCronetChannelFactory.h \
830src/objective-c/GRPCClient/private/GRPCCore/GRPCCoreFactory.h \
831src/objective-c/GRPCClient/private/GRPCCore/GRPCHost.h \
832src/objective-c/GRPCClient/private/GRPCCore/GRPCInsecureChannelFactory.h \
833src/objective-c/GRPCClient/private/GRPCCore/GRPCOpBatchLog.h \
834src/objective-c/GRPCClient/private/GRPCCore/GRPCReachabilityFlagNames.xmacro.h \
835src/objective-c/GRPCClient/private/GRPCCore/GRPCRequestHeaders.h \
836src/objective-c/GRPCClient/private/GRPCCore/GRPCSecureChannelFactory.h \
837src/objective-c/GRPCClient/private/GRPCCore/GRPCWrappedCall.h \
838src/objective-c/GRPCClient/private/GRPCCore/NSData+GRPC.h \
839src/objective-c/GRPCClient/private/GRPCCore/NSDictionary+GRPC.h \
840src/objective-c/GRPCClient/private/GRPCCore/NSError+GRPC.h \
841src/objective-c/GRPCClient/private/GRPCTransport+Private.h \
842src/objective-c/GRPCClient/version.h \
843src/objective-c/NetworkTransitionBehavior.md \
844src/objective-c/ProtoRPC/ProtoMethod.h \
845src/objective-c/ProtoRPC/ProtoRPC.h \
846src/objective-c/ProtoRPC/ProtoRPCLegacy.h \
847src/objective-c/ProtoRPC/ProtoService.h \
848src/objective-c/ProtoRPC/ProtoServiceLegacy.h \
849src/objective-c/README-CFSTREAM.md \
850src/objective-c/README.md \
851src/objective-c/RxLibrary/GRXBufferedPipe.h \
852src/objective-c/RxLibrary/GRXConcurrentWriteable.h \
853src/objective-c/RxLibrary/GRXForwardingWriter.h \
854src/objective-c/RxLibrary/GRXImmediateSingleWriter.h \
855src/objective-c/RxLibrary/GRXImmediateWriter.h \
856src/objective-c/RxLibrary/GRXMappingWriter.h \
857src/objective-c/RxLibrary/GRXWriteable.h \
858src/objective-c/RxLibrary/GRXWriter+Immediate.h \
859src/objective-c/RxLibrary/GRXWriter+Transformations.h \
860src/objective-c/RxLibrary/GRXWriter.h \
861src/objective-c/RxLibrary/NSEnumerator+GRXUtil.h \
862src/objective-c/RxLibrary/README.md \
863src/objective-c/RxLibrary/private/GRXNSBlockEnumerator.h \
864src/objective-c/RxLibrary/private/GRXNSFastEnumerator.h \
865src/objective-c/RxLibrary/private/GRXNSScalarEnumerator.h \
866src/objective-c/examples/Sample/README.md \
867src/objective-c/tests/Connectivity/README.md
868
869# This tag can be used to specify the character encoding of the source files
870# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
871# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
872# documentation (see: http://www.gnu.org/software/libiconv) for the list of
873# possible encodings.
874# The default value is: UTF-8.
875
876INPUT_ENCODING         = UTF-8
877
878# If the value of the INPUT tag contains directories, you can use the
879# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
880# *.h) to filter out the source-files in the directories. If left blank the
881# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii,
882# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,
883# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,
884# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
885# *.qsf, *.as and *.js.
886
887FILE_PATTERNS          =
888
889# The RECURSIVE tag can be used to specify whether or not subdirectories should
890# be searched for input files as well.
891# The default value is: NO.
892
893RECURSIVE              = NO
894
895# The EXCLUDE tag can be used to specify files and/or directories that should be
896# excluded from the INPUT source files. This way you can easily exclude a
897# subdirectory from a directory tree whose root is specified with the INPUT tag.
898#
899# Note that relative paths are relative to the directory from which doxygen is
900# run.
901
902EXCLUDE                =
903
904# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
905# directories that are symbolic links (a Unix file system feature) are excluded
906# from the input.
907# The default value is: NO.
908
909EXCLUDE_SYMLINKS       = NO
910
911# If the value of the INPUT tag contains directories, you can use the
912# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
913# certain files from those directories.
914#
915# Note that the wildcards are matched against the file with absolute path, so to
916# exclude all test directories for example use the pattern */test/*
917
918EXCLUDE_PATTERNS       =
919
920# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
921# (namespaces, classes, functions, etc.) that should be excluded from the
922# output. The symbol name can be a fully qualified name, a word, or if the
923# wildcard * is used, a substring. Examples: ANamespace, AClass,
924# AClass::ANamespace, ANamespace::*Test
925#
926# Note that the wildcards are matched against the file with absolute path, so to
927# exclude all test directories use the pattern */test/*
928
929EXCLUDE_SYMBOLS        =
930
931# The EXAMPLE_PATH tag can be used to specify one or more files or directories
932# that contain example code fragments that are included (see the \include
933# command).
934
935EXAMPLE_PATH           =
936
937# If the value of the EXAMPLE_PATH tag contains directories, you can use the
938# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
939# *.h) to filter out the source-files in the directories. If left blank all
940# files are included.
941
942EXAMPLE_PATTERNS       =
943
944# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
945# searched for input files to be used with the \include or \dontinclude commands
946# irrespective of the value of the RECURSIVE tag.
947# The default value is: NO.
948
949EXAMPLE_RECURSIVE      = NO
950
951# The IMAGE_PATH tag can be used to specify one or more files or directories
952# that contain images that are to be included in the documentation (see the
953# \image command).
954
955IMAGE_PATH             =
956
957# The INPUT_FILTER tag can be used to specify a program that doxygen should
958# invoke to filter for each input file. Doxygen will invoke the filter program
959# by executing (via popen()) the command:
960#
961# <filter> <input-file>
962#
963# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
964# name of an input file. Doxygen will then use the output that the filter
965# program writes to standard output. If FILTER_PATTERNS is specified, this tag
966# will be ignored.
967#
968# Note that the filter must not add or remove lines; it is applied before the
969# code is scanned, but not when the output code is generated. If lines are added
970# or removed, the anchors will not be placed correctly.
971
972INPUT_FILTER           =
973
974# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
975# basis. Doxygen will compare the file name with each pattern and apply the
976# filter if there is a match. The filters are a list of the form: pattern=filter
977# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
978# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
979# patterns match the file name, INPUT_FILTER is applied.
980
981FILTER_PATTERNS        =
982
983# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
984# INPUT_FILTER) will also be used to filter the input files that are used for
985# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
986# The default value is: NO.
987
988FILTER_SOURCE_FILES    = NO
989
990# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
991# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
992# it is also possible to disable source filtering for a specific pattern using
993# *.ext= (so without naming a filter).
994# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
995
996FILTER_SOURCE_PATTERNS =
997
998# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
999# is part of the input, its contents will be placed on the main page
1000# (index.html). This can be useful if you have a project on for instance GitHub
1001# and want to reuse the introduction page also for the doxygen output.
1002
1003USE_MDFILE_AS_MAINPAGE =
1004
1005#---------------------------------------------------------------------------
1006# Configuration options related to source browsing
1007#---------------------------------------------------------------------------
1008
1009# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
1010# generated. Documented entities will be cross-referenced with these sources.
1011#
1012# Note: To get rid of all source code in the generated output, make sure that
1013# also VERBATIM_HEADERS is set to NO.
1014# The default value is: NO.
1015
1016SOURCE_BROWSER         = NO
1017
1018# Setting the INLINE_SOURCES tag to YES will include the body of functions,
1019# classes and enums directly into the documentation.
1020# The default value is: NO.
1021
1022INLINE_SOURCES         = NO
1023
1024# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
1025# special comment blocks from generated source code fragments. Normal C, C++ and
1026# Fortran comments will always remain visible.
1027# The default value is: YES.
1028
1029STRIP_CODE_COMMENTS    = YES
1030
1031# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
1032# function all documented functions referencing it will be listed.
1033# The default value is: NO.
1034
1035REFERENCED_BY_RELATION = NO
1036
1037# If the REFERENCES_RELATION tag is set to YES then for each documented function
1038# all documented entities called/used by that function will be listed.
1039# The default value is: NO.
1040
1041REFERENCES_RELATION    = NO
1042
1043# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
1044# to YES then the hyperlinks from functions in REFERENCES_RELATION and
1045# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
1046# link to the documentation.
1047# The default value is: YES.
1048
1049REFERENCES_LINK_SOURCE = YES
1050
1051# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
1052# source code will show a tooltip with additional information such as prototype,
1053# brief description and links to the definition and documentation. Since this
1054# will make the HTML file larger and loading of large files a bit slower, you
1055# can opt to disable this feature.
1056# The default value is: YES.
1057# This tag requires that the tag SOURCE_BROWSER is set to YES.
1058
1059SOURCE_TOOLTIPS        = YES
1060
1061# If the USE_HTAGS tag is set to YES then the references to source code will
1062# point to the HTML generated by the htags(1) tool instead of doxygen built-in
1063# source browser. The htags tool is part of GNU's global source tagging system
1064# (see http://www.gnu.org/software/global/global.html). You will need version
1065# 4.8.6 or higher.
1066#
1067# To use it do the following:
1068# - Install the latest version of global
1069# - Enable SOURCE_BROWSER and USE_HTAGS in the config file
1070# - Make sure the INPUT points to the root of the source tree
1071# - Run doxygen as normal
1072#
1073# Doxygen will invoke htags (and that will in turn invoke gtags), so these
1074# tools must be available from the command line (i.e. in the search path).
1075#
1076# The result: instead of the source browser generated by doxygen, the links to
1077# source code will now point to the output of htags.
1078# The default value is: NO.
1079# This tag requires that the tag SOURCE_BROWSER is set to YES.
1080
1081USE_HTAGS              = NO
1082
1083# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
1084# verbatim copy of the header file for each class for which an include is
1085# specified. Set to NO to disable this.
1086# See also: Section \class.
1087# The default value is: YES.
1088
1089VERBATIM_HEADERS       = YES
1090
1091#---------------------------------------------------------------------------
1092# Configuration options related to the alphabetical class index
1093#---------------------------------------------------------------------------
1094
1095# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1096# compounds will be generated. Enable this if the project contains a lot of
1097# classes, structs, unions or interfaces.
1098# The default value is: YES.
1099
1100ALPHABETICAL_INDEX     = YES
1101
1102# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
1103# which the alphabetical index list will be split.
1104# Minimum value: 1, maximum value: 20, default value: 5.
1105# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1106
1107COLS_IN_ALPHA_INDEX    = 5
1108
1109# In case all classes in a project start with a common prefix, all classes will
1110# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
1111# can be used to specify a prefix (or a list of prefixes) that should be ignored
1112# while generating the index headers.
1113# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1114
1115IGNORE_PREFIX          =
1116
1117#---------------------------------------------------------------------------
1118# Configuration options related to the HTML output
1119#---------------------------------------------------------------------------
1120
1121# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
1122# The default value is: YES.
1123
1124GENERATE_HTML          = YES
1125
1126# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1127# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1128# it.
1129# The default directory is: html.
1130# This tag requires that the tag GENERATE_HTML is set to YES.
1131
1132HTML_OUTPUT            = html
1133
1134# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1135# generated HTML page (for example: .htm, .php, .asp).
1136# The default value is: .html.
1137# This tag requires that the tag GENERATE_HTML is set to YES.
1138
1139HTML_FILE_EXTENSION    = .html
1140
1141# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1142# each generated HTML page. If the tag is left blank doxygen will generate a
1143# standard header.
1144#
1145# To get valid HTML the header file that includes any scripts and style sheets
1146# that doxygen needs, which is dependent on the configuration options used (e.g.
1147# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1148# default header using
1149# doxygen -w html new_header.html new_footer.html new_stylesheet.css
1150# YourConfigFile
1151# and then modify the file new_header.html. See also section "Doxygen usage"
1152# for information on how to generate the default header that doxygen normally
1153# uses.
1154# Note: The header is subject to change so you typically have to regenerate the
1155# default header when upgrading to a newer version of doxygen. For a description
1156# of the possible markers and block names see the documentation.
1157# This tag requires that the tag GENERATE_HTML is set to YES.
1158
1159HTML_HEADER            =
1160
1161# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1162# generated HTML page. If the tag is left blank doxygen will generate a standard
1163# footer. See HTML_HEADER for more information on how to generate a default
1164# footer and what special commands can be used inside the footer. See also
1165# section "Doxygen usage" for information on how to generate the default footer
1166# that doxygen normally uses.
1167# This tag requires that the tag GENERATE_HTML is set to YES.
1168
1169HTML_FOOTER            =
1170
1171# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1172# sheet that is used by each HTML page. It can be used to fine-tune the look of
1173# the HTML output. If left blank doxygen will generate a default style sheet.
1174# See also section "Doxygen usage" for information on how to generate the style
1175# sheet that doxygen normally uses.
1176# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1177# it is more robust and this tag (HTML_STYLESHEET) will in the future become
1178# obsolete.
1179# This tag requires that the tag GENERATE_HTML is set to YES.
1180
1181HTML_STYLESHEET        =
1182
1183# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1184# cascading style sheets that are included after the standard style sheets
1185# created by doxygen. Using this option one can overrule certain style aspects.
1186# This is preferred over using HTML_STYLESHEET since it does not replace the
1187# standard style sheet and is therefore more robust against future updates.
1188# Doxygen will copy the style sheet files to the output directory.
1189# Note: The order of the extra style sheet files is of importance (e.g. the last
1190# style sheet in the list overrules the setting of the previous ones in the
1191# list). For an example see the documentation.
1192# This tag requires that the tag GENERATE_HTML is set to YES.
1193
1194HTML_EXTRA_STYLESHEET  =
1195
1196# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1197# other source files which should be copied to the HTML output directory. Note
1198# that these files will be copied to the base HTML output directory. Use the
1199# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1200# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1201# files will be copied as-is; there are no commands or markers available.
1202# This tag requires that the tag GENERATE_HTML is set to YES.
1203
1204HTML_EXTRA_FILES       =
1205
1206# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
1207# will adjust the colors in the style sheet and background images according to
1208# this color. Hue is specified as an angle on a colorwheel, see
1209# http://en.wikipedia.org/wiki/Hue for more information. For instance the value
1210# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
1211# purple, and 360 is red again.
1212# Minimum value: 0, maximum value: 359, default value: 220.
1213# This tag requires that the tag GENERATE_HTML is set to YES.
1214
1215HTML_COLORSTYLE_HUE    = 220
1216
1217# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
1218# in the HTML output. For a value of 0 the output will use grayscales only. A
1219# value of 255 will produce the most vivid colors.
1220# Minimum value: 0, maximum value: 255, default value: 100.
1221# This tag requires that the tag GENERATE_HTML is set to YES.
1222
1223HTML_COLORSTYLE_SAT    = 100
1224
1225# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1226# luminance component of the colors in the HTML output. Values below 100
1227# gradually make the output lighter, whereas values above 100 make the output
1228# darker. The value divided by 100 is the actual gamma applied, so 80 represents
1229# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1230# change the gamma.
1231# Minimum value: 40, maximum value: 240, default value: 80.
1232# This tag requires that the tag GENERATE_HTML is set to YES.
1233
1234HTML_COLORSTYLE_GAMMA  = 80
1235
1236# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1237# page will contain the date and time when the page was generated. Setting this
1238# to NO can help when comparing the output of multiple runs.
1239# The default value is: YES.
1240# This tag requires that the tag GENERATE_HTML is set to YES.
1241
1242HTML_TIMESTAMP         = YES
1243
1244# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1245# documentation will contain sections that can be hidden and shown after the
1246# page has loaded.
1247# The default value is: NO.
1248# This tag requires that the tag GENERATE_HTML is set to YES.
1249
1250HTML_DYNAMIC_SECTIONS  = NO
1251
1252# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
1253# shown in the various tree structured indices initially; the user can expand
1254# and collapse entries dynamically later on. Doxygen will expand the tree to
1255# such a level that at most the specified number of entries are visible (unless
1256# a fully collapsed tree already exceeds this amount). So setting the number of
1257# entries 1 will produce a full collapsed tree by default. 0 is a special value
1258# representing an infinite number of entries and will result in a full expanded
1259# tree by default.
1260# Minimum value: 0, maximum value: 9999, default value: 100.
1261# This tag requires that the tag GENERATE_HTML is set to YES.
1262
1263HTML_INDEX_NUM_ENTRIES = 100
1264
1265# If the GENERATE_DOCSET tag is set to YES, additional index files will be
1266# generated that can be used as input for Apple's Xcode 3 integrated development
1267# environment (see: http://developer.apple.com/tools/xcode/), introduced with
1268# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
1269# Makefile in the HTML output directory. Running make will produce the docset in
1270# that directory and running make install will install the docset in
1271# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1272# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
1273# for more information.
1274# The default value is: NO.
1275# This tag requires that the tag GENERATE_HTML is set to YES.
1276
1277GENERATE_DOCSET        = NO
1278
1279# This tag determines the name of the docset feed. A documentation feed provides
1280# an umbrella under which multiple documentation sets from a single provider
1281# (such as a company or product suite) can be grouped.
1282# The default value is: Doxygen generated docs.
1283# This tag requires that the tag GENERATE_DOCSET is set to YES.
1284
1285DOCSET_FEEDNAME        = "Doxygen generated docs"
1286
1287# This tag specifies a string that should uniquely identify the documentation
1288# set bundle. This should be a reverse domain-name style string, e.g.
1289# com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1290# The default value is: org.doxygen.Project.
1291# This tag requires that the tag GENERATE_DOCSET is set to YES.
1292
1293DOCSET_BUNDLE_ID       = org.doxygen.Project
1294
1295# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1296# the documentation publisher. This should be a reverse domain-name style
1297# string, e.g. com.mycompany.MyDocSet.documentation.
1298# The default value is: org.doxygen.Publisher.
1299# This tag requires that the tag GENERATE_DOCSET is set to YES.
1300
1301DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
1302
1303# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1304# The default value is: Publisher.
1305# This tag requires that the tag GENERATE_DOCSET is set to YES.
1306
1307DOCSET_PUBLISHER_NAME  = Publisher
1308
1309# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1310# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1311# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1312# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
1313# Windows.
1314#
1315# The HTML Help Workshop contains a compiler that can convert all HTML output
1316# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1317# files are now used as the Windows 98 help format, and will replace the old
1318# Windows help format (.hlp) on all Windows platforms in the future. Compressed
1319# HTML files also contain an index, a table of contents, and you can search for
1320# words in the documentation. The HTML workshop also contains a viewer for
1321# compressed HTML files.
1322# The default value is: NO.
1323# This tag requires that the tag GENERATE_HTML is set to YES.
1324
1325GENERATE_HTMLHELP      = NO
1326
1327# The CHM_FILE tag can be used to specify the file name of the resulting .chm
1328# file. You can add a path in front of the file if the result should not be
1329# written to the html output directory.
1330# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1331
1332CHM_FILE               =
1333
1334# The HHC_LOCATION tag can be used to specify the location (absolute path
1335# including file name) of the HTML help compiler (hhc.exe). If non-empty,
1336# doxygen will try to run the HTML help compiler on the generated index.hhp.
1337# The file has to be specified with full path.
1338# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1339
1340HHC_LOCATION           =
1341
1342# The GENERATE_CHI flag controls if a separate .chi index file is generated
1343# (YES) or that it should be included in the master .chm file (NO).
1344# The default value is: NO.
1345# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1346
1347GENERATE_CHI           = NO
1348
1349# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
1350# and project file content.
1351# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1352
1353CHM_INDEX_ENCODING     =
1354
1355# The BINARY_TOC flag controls whether a binary table of contents is generated
1356# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
1357# enables the Previous and Next buttons.
1358# The default value is: NO.
1359# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1360
1361BINARY_TOC             = NO
1362
1363# The TOC_EXPAND flag can be set to YES to add extra items for group members to
1364# the table of contents of the HTML help documentation and to the tree view.
1365# The default value is: NO.
1366# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1367
1368TOC_EXPAND             = NO
1369
1370# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1371# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1372# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1373# (.qch) of the generated HTML documentation.
1374# The default value is: NO.
1375# This tag requires that the tag GENERATE_HTML is set to YES.
1376
1377GENERATE_QHP           = NO
1378
1379# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1380# the file name of the resulting .qch file. The path specified is relative to
1381# the HTML output folder.
1382# This tag requires that the tag GENERATE_QHP is set to YES.
1383
1384QCH_FILE               =
1385
1386# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1387# Project output. For more information please see Qt Help Project / Namespace
1388# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
1389# The default value is: org.doxygen.Project.
1390# This tag requires that the tag GENERATE_QHP is set to YES.
1391
1392QHP_NAMESPACE          = org.doxygen.Project
1393
1394# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1395# Help Project output. For more information please see Qt Help Project / Virtual
1396# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
1397# folders).
1398# The default value is: doc.
1399# This tag requires that the tag GENERATE_QHP is set to YES.
1400
1401QHP_VIRTUAL_FOLDER     = doc
1402
1403# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1404# filter to add. For more information please see Qt Help Project / Custom
1405# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1406# filters).
1407# This tag requires that the tag GENERATE_QHP is set to YES.
1408
1409QHP_CUST_FILTER_NAME   =
1410
1411# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
1412# custom filter to add. For more information please see Qt Help Project / Custom
1413# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1414# filters).
1415# This tag requires that the tag GENERATE_QHP is set to YES.
1416
1417QHP_CUST_FILTER_ATTRS  =
1418
1419# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1420# project's filter section matches. Qt Help Project / Filter Attributes (see:
1421# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
1422# This tag requires that the tag GENERATE_QHP is set to YES.
1423
1424QHP_SECT_FILTER_ATTRS  =
1425
1426# The QHG_LOCATION tag can be used to specify the location of Qt's
1427# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
1428# generated .qhp file.
1429# This tag requires that the tag GENERATE_QHP is set to YES.
1430
1431QHG_LOCATION           =
1432
1433# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1434# generated, together with the HTML files, they form an Eclipse help plugin. To
1435# install this plugin and make it available under the help contents menu in
1436# Eclipse, the contents of the directory containing the HTML and XML files needs
1437# to be copied into the plugins directory of eclipse. The name of the directory
1438# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1439# After copying Eclipse needs to be restarted before the help appears.
1440# The default value is: NO.
1441# This tag requires that the tag GENERATE_HTML is set to YES.
1442
1443GENERATE_ECLIPSEHELP   = NO
1444
1445# A unique identifier for the Eclipse help plugin. When installing the plugin
1446# the directory name containing the HTML and XML files should also have this
1447# name. Each documentation set should have its own identifier.
1448# The default value is: org.doxygen.Project.
1449# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1450
1451ECLIPSE_DOC_ID         = org.doxygen.Project
1452
1453# If you want full control over the layout of the generated HTML pages it might
1454# be necessary to disable the index and replace it with your own. The
1455# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1456# of each HTML page. A value of NO enables the index and the value YES disables
1457# it. Since the tabs in the index contain the same information as the navigation
1458# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1459# The default value is: NO.
1460# This tag requires that the tag GENERATE_HTML is set to YES.
1461
1462DISABLE_INDEX          = NO
1463
1464# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1465# structure should be generated to display hierarchical information. If the tag
1466# value is set to YES, a side panel will be generated containing a tree-like
1467# index structure (just like the one that is generated for HTML Help). For this
1468# to work a browser that supports JavaScript, DHTML, CSS and frames is required
1469# (i.e. any modern browser). Windows users are probably better off using the
1470# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
1471# further fine-tune the look of the index. As an example, the default style
1472# sheet generated by doxygen has an example that shows how to put an image at
1473# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
1474# the same information as the tab index, you could consider setting
1475# DISABLE_INDEX to YES when enabling this option.
1476# The default value is: NO.
1477# This tag requires that the tag GENERATE_HTML is set to YES.
1478
1479GENERATE_TREEVIEW      = NO
1480
1481# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1482# doxygen will group on one line in the generated HTML documentation.
1483#
1484# Note that a value of 0 will completely suppress the enum values from appearing
1485# in the overview section.
1486# Minimum value: 0, maximum value: 20, default value: 4.
1487# This tag requires that the tag GENERATE_HTML is set to YES.
1488
1489ENUM_VALUES_PER_LINE   = 4
1490
1491# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1492# to set the initial width (in pixels) of the frame in which the tree is shown.
1493# Minimum value: 0, maximum value: 1500, default value: 250.
1494# This tag requires that the tag GENERATE_HTML is set to YES.
1495
1496TREEVIEW_WIDTH         = 250
1497
1498# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
1499# external symbols imported via tag files in a separate window.
1500# The default value is: NO.
1501# This tag requires that the tag GENERATE_HTML is set to YES.
1502
1503EXT_LINKS_IN_WINDOW    = NO
1504
1505# Use this tag to change the font size of LaTeX formulas included as images in
1506# the HTML documentation. When you change the font size after a successful
1507# doxygen run you need to manually remove any form_*.png images from the HTML
1508# output directory to force them to be regenerated.
1509# Minimum value: 8, maximum value: 50, default value: 10.
1510# This tag requires that the tag GENERATE_HTML is set to YES.
1511
1512FORMULA_FONTSIZE       = 10
1513
1514# Use the FORMULA_TRANPARENT tag to determine whether or not the images
1515# generated for formulas are transparent PNGs. Transparent PNGs are not
1516# supported properly for IE 6.0, but are supported on all modern browsers.
1517#
1518# Note that when changing this option you need to delete any form_*.png files in
1519# the HTML output directory before the changes have effect.
1520# The default value is: YES.
1521# This tag requires that the tag GENERATE_HTML is set to YES.
1522
1523FORMULA_TRANSPARENT    = YES
1524
1525# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1526# http://www.mathjax.org) which uses client side Javascript for the rendering
1527# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
1528# installed or if you want to formulas look prettier in the HTML output. When
1529# enabled you may also need to install MathJax separately and configure the path
1530# to it using the MATHJAX_RELPATH option.
1531# The default value is: NO.
1532# This tag requires that the tag GENERATE_HTML is set to YES.
1533
1534USE_MATHJAX            = NO
1535
1536# When MathJax is enabled you can set the default output format to be used for
1537# the MathJax output. See the MathJax site (see:
1538# http://docs.mathjax.org/en/latest/output.html) for more details.
1539# Possible values are: HTML-CSS (which is slower, but has the best
1540# compatibility), NativeMML (i.e. MathML) and SVG.
1541# The default value is: HTML-CSS.
1542# This tag requires that the tag USE_MATHJAX is set to YES.
1543
1544MATHJAX_FORMAT         = HTML-CSS
1545
1546# When MathJax is enabled you need to specify the location relative to the HTML
1547# output directory using the MATHJAX_RELPATH option. The destination directory
1548# should contain the MathJax.js script. For instance, if the mathjax directory
1549# is located at the same level as the HTML output directory, then
1550# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1551# Content Delivery Network so you can quickly see the result without installing
1552# MathJax. However, it is strongly recommended to install a local copy of
1553# MathJax from http://www.mathjax.org before deployment.
1554# The default value is: http://cdn.mathjax.org/mathjax/latest.
1555# This tag requires that the tag USE_MATHJAX is set to YES.
1556
1557MATHJAX_RELPATH        = http://cdn.mathjax.org/mathjax/latest
1558
1559# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1560# extension names that should be enabled during MathJax rendering. For example
1561# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
1562# This tag requires that the tag USE_MATHJAX is set to YES.
1563
1564MATHJAX_EXTENSIONS     =
1565
1566# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1567# of code that will be used on startup of the MathJax code. See the MathJax site
1568# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
1569# example see the documentation.
1570# This tag requires that the tag USE_MATHJAX is set to YES.
1571
1572MATHJAX_CODEFILE       =
1573
1574# When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1575# the HTML output. The underlying search engine uses javascript and DHTML and
1576# should work on any modern browser. Note that when using HTML help
1577# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
1578# there is already a search function so this one should typically be disabled.
1579# For large projects the javascript based search engine can be slow, then
1580# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1581# search using the keyboard; to jump to the search box use <access key> + S
1582# (what the <access key> is depends on the OS and browser, but it is typically
1583# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
1584# key> to jump into the search results window, the results can be navigated
1585# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1586# the search. The filter options can be selected when the cursor is inside the
1587# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
1588# to select a filter and <Enter> or <escape> to activate or cancel the filter
1589# option.
1590# The default value is: YES.
1591# This tag requires that the tag GENERATE_HTML is set to YES.
1592
1593SEARCHENGINE           = YES
1594
1595# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1596# implemented using a web server instead of a web client using Javascript. There
1597# are two flavors of web server based searching depending on the EXTERNAL_SEARCH
1598# setting. When disabled, doxygen will generate a PHP script for searching and
1599# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
1600# and searching needs to be provided by external tools. See the section
1601# "External Indexing and Searching" for details.
1602# The default value is: NO.
1603# This tag requires that the tag SEARCHENGINE is set to YES.
1604
1605SERVER_BASED_SEARCH    = NO
1606
1607# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1608# script for searching. Instead the search results are written to an XML file
1609# which needs to be processed by an external indexer. Doxygen will invoke an
1610# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1611# search results.
1612#
1613# Doxygen ships with an example indexer (doxyindexer) and search engine
1614# (doxysearch.cgi) which are based on the open source search engine library
1615# Xapian (see: http://xapian.org/).
1616#
1617# See the section "External Indexing and Searching" for details.
1618# The default value is: NO.
1619# This tag requires that the tag SEARCHENGINE is set to YES.
1620
1621EXTERNAL_SEARCH        = NO
1622
1623# The SEARCHENGINE_URL should point to a search engine hosted by a web server
1624# which will return the search results when EXTERNAL_SEARCH is enabled.
1625#
1626# Doxygen ships with an example indexer (doxyindexer) and search engine
1627# (doxysearch.cgi) which are based on the open source search engine library
1628# Xapian (see: http://xapian.org/). See the section "External Indexing and
1629# Searching" for details.
1630# This tag requires that the tag SEARCHENGINE is set to YES.
1631
1632SEARCHENGINE_URL       =
1633
1634# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
1635# search data is written to a file for indexing by an external tool. With the
1636# SEARCHDATA_FILE tag the name of this file can be specified.
1637# The default file is: searchdata.xml.
1638# This tag requires that the tag SEARCHENGINE is set to YES.
1639
1640SEARCHDATA_FILE        = searchdata.xml
1641
1642# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
1643# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1644# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1645# projects and redirect the results back to the right project.
1646# This tag requires that the tag SEARCHENGINE is set to YES.
1647
1648EXTERNAL_SEARCH_ID     =
1649
1650# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1651# projects other than the one defined by this configuration file, but that are
1652# all added to the same external search index. Each project needs to have a
1653# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
1654# to a relative location where the documentation can be found. The format is:
1655# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
1656# This tag requires that the tag SEARCHENGINE is set to YES.
1657
1658EXTRA_SEARCH_MAPPINGS  =
1659
1660#---------------------------------------------------------------------------
1661# Configuration options related to the LaTeX output
1662#---------------------------------------------------------------------------
1663
1664# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
1665# The default value is: YES.
1666
1667GENERATE_LATEX         = NO
1668
1669# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1670# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1671# it.
1672# The default directory is: latex.
1673# This tag requires that the tag GENERATE_LATEX is set to YES.
1674
1675LATEX_OUTPUT           = latex
1676
1677# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1678# invoked.
1679#
1680# Note that when enabling USE_PDFLATEX this option is only used for generating
1681# bitmaps for formulas in the HTML output, but not in the Makefile that is
1682# written to the output directory.
1683# The default file is: latex.
1684# This tag requires that the tag GENERATE_LATEX is set to YES.
1685
1686LATEX_CMD_NAME         = latex
1687
1688# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
1689# index for LaTeX.
1690# The default file is: makeindex.
1691# This tag requires that the tag GENERATE_LATEX is set to YES.
1692
1693MAKEINDEX_CMD_NAME     = makeindex
1694
1695# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
1696# documents. This may be useful for small projects and may help to save some
1697# trees in general.
1698# The default value is: NO.
1699# This tag requires that the tag GENERATE_LATEX is set to YES.
1700
1701COMPACT_LATEX          = NO
1702
1703# The PAPER_TYPE tag can be used to set the paper type that is used by the
1704# printer.
1705# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
1706# 14 inches) and executive (7.25 x 10.5 inches).
1707# The default value is: a4.
1708# This tag requires that the tag GENERATE_LATEX is set to YES.
1709
1710PAPER_TYPE             = a4
1711
1712# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
1713# that should be included in the LaTeX output. To get the times font for
1714# instance you can specify
1715# EXTRA_PACKAGES=times
1716# If left blank no extra packages will be included.
1717# This tag requires that the tag GENERATE_LATEX is set to YES.
1718
1719EXTRA_PACKAGES         =
1720
1721# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
1722# generated LaTeX document. The header should contain everything until the first
1723# chapter. If it is left blank doxygen will generate a standard header. See
1724# section "Doxygen usage" for information on how to let doxygen write the
1725# default header to a separate file.
1726#
1727# Note: Only use a user-defined header if you know what you are doing! The
1728# following commands have a special meaning inside the header: $title,
1729# $datetime, $date, $doxygenversion, $projectname, $projectnumber,
1730# $projectbrief, $projectlogo. Doxygen will replace $title with the empty
1731# string, for the replacement values of the other commands the user is referred
1732# to HTML_HEADER.
1733# This tag requires that the tag GENERATE_LATEX is set to YES.
1734
1735LATEX_HEADER           =
1736
1737# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
1738# generated LaTeX document. The footer should contain everything after the last
1739# chapter. If it is left blank doxygen will generate a standard footer. See
1740# LATEX_HEADER for more information on how to generate a default footer and what
1741# special commands can be used inside the footer.
1742#
1743# Note: Only use a user-defined footer if you know what you are doing!
1744# This tag requires that the tag GENERATE_LATEX is set to YES.
1745
1746LATEX_FOOTER           =
1747
1748# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1749# LaTeX style sheets that are included after the standard style sheets created
1750# by doxygen. Using this option one can overrule certain style aspects. Doxygen
1751# will copy the style sheet files to the output directory.
1752# Note: The order of the extra style sheet files is of importance (e.g. the last
1753# style sheet in the list overrules the setting of the previous ones in the
1754# list).
1755# This tag requires that the tag GENERATE_LATEX is set to YES.
1756
1757LATEX_EXTRA_STYLESHEET =
1758
1759# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
1760# other source files which should be copied to the LATEX_OUTPUT output
1761# directory. Note that the files will be copied as-is; there are no commands or
1762# markers available.
1763# This tag requires that the tag GENERATE_LATEX is set to YES.
1764
1765LATEX_EXTRA_FILES      =
1766
1767# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1768# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
1769# contain links (just like the HTML output) instead of page references. This
1770# makes the output suitable for online browsing using a PDF viewer.
1771# The default value is: YES.
1772# This tag requires that the tag GENERATE_LATEX is set to YES.
1773
1774PDF_HYPERLINKS         = YES
1775
1776# If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1777# the PDF file directly from the LaTeX files. Set this option to YES, to get a
1778# higher quality PDF documentation.
1779# The default value is: YES.
1780# This tag requires that the tag GENERATE_LATEX is set to YES.
1781
1782USE_PDFLATEX           = YES
1783
1784# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1785# command to the generated LaTeX files. This will instruct LaTeX to keep running
1786# if errors occur, instead of asking the user for help. This option is also used
1787# when generating formulas in HTML.
1788# The default value is: NO.
1789# This tag requires that the tag GENERATE_LATEX is set to YES.
1790
1791LATEX_BATCHMODE        = NO
1792
1793# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1794# index chapters (such as File Index, Compound Index, etc.) in the output.
1795# The default value is: NO.
1796# This tag requires that the tag GENERATE_LATEX is set to YES.
1797
1798LATEX_HIDE_INDICES     = NO
1799
1800# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
1801# code with syntax highlighting in the LaTeX output.
1802#
1803# Note that which sources are shown also depends on other settings such as
1804# SOURCE_BROWSER.
1805# The default value is: NO.
1806# This tag requires that the tag GENERATE_LATEX is set to YES.
1807
1808LATEX_SOURCE_CODE      = NO
1809
1810# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1811# bibliography, e.g. plainnat, or ieeetr. See
1812# http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
1813# The default value is: plain.
1814# This tag requires that the tag GENERATE_LATEX is set to YES.
1815
1816LATEX_BIB_STYLE        = plain
1817
1818#---------------------------------------------------------------------------
1819# Configuration options related to the RTF output
1820#---------------------------------------------------------------------------
1821
1822# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
1823# RTF output is optimized for Word 97 and may not look too pretty with other RTF
1824# readers/editors.
1825# The default value is: NO.
1826
1827GENERATE_RTF           = NO
1828
1829# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
1830# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1831# it.
1832# The default directory is: rtf.
1833# This tag requires that the tag GENERATE_RTF is set to YES.
1834
1835RTF_OUTPUT             = rtf
1836
1837# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
1838# documents. This may be useful for small projects and may help to save some
1839# trees in general.
1840# The default value is: NO.
1841# This tag requires that the tag GENERATE_RTF is set to YES.
1842
1843COMPACT_RTF            = NO
1844
1845# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
1846# contain hyperlink fields. The RTF file will contain links (just like the HTML
1847# output) instead of page references. This makes the output suitable for online
1848# browsing using Word or some other Word compatible readers that support those
1849# fields.
1850#
1851# Note: WordPad (write) and others do not support links.
1852# The default value is: NO.
1853# This tag requires that the tag GENERATE_RTF is set to YES.
1854
1855RTF_HYPERLINKS         = NO
1856
1857# Load stylesheet definitions from file. Syntax is similar to doxygen's config
1858# file, i.e. a series of assignments. You only have to provide replacements,
1859# missing definitions are set to their default value.
1860#
1861# See also section "Doxygen usage" for information on how to generate the
1862# default style sheet that doxygen normally uses.
1863# This tag requires that the tag GENERATE_RTF is set to YES.
1864
1865RTF_STYLESHEET_FILE    =
1866
1867# Set optional variables used in the generation of an RTF document. Syntax is
1868# similar to doxygen's config file. A template extensions file can be generated
1869# using doxygen -e rtf extensionFile.
1870# This tag requires that the tag GENERATE_RTF is set to YES.
1871
1872RTF_EXTENSIONS_FILE    =
1873
1874# If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
1875# with syntax highlighting in the RTF output.
1876#
1877# Note that which sources are shown also depends on other settings such as
1878# SOURCE_BROWSER.
1879# The default value is: NO.
1880# This tag requires that the tag GENERATE_RTF is set to YES.
1881
1882RTF_SOURCE_CODE        = NO
1883
1884#---------------------------------------------------------------------------
1885# Configuration options related to the man page output
1886#---------------------------------------------------------------------------
1887
1888# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
1889# classes and files.
1890# The default value is: NO.
1891
1892GENERATE_MAN           = NO
1893
1894# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
1895# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1896# it. A directory man3 will be created inside the directory specified by
1897# MAN_OUTPUT.
1898# The default directory is: man.
1899# This tag requires that the tag GENERATE_MAN is set to YES.
1900
1901MAN_OUTPUT             = man
1902
1903# The MAN_EXTENSION tag determines the extension that is added to the generated
1904# man pages. In case the manual section does not start with a number, the number
1905# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
1906# optional.
1907# The default value is: .3.
1908# This tag requires that the tag GENERATE_MAN is set to YES.
1909
1910MAN_EXTENSION          = .3
1911
1912# The MAN_SUBDIR tag determines the name of the directory created within
1913# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
1914# MAN_EXTENSION with the initial . removed.
1915# This tag requires that the tag GENERATE_MAN is set to YES.
1916
1917MAN_SUBDIR             =
1918
1919# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
1920# will generate one additional man file for each entity documented in the real
1921# man page(s). These additional files only source the real man page, but without
1922# them the man command would be unable to find the correct page.
1923# The default value is: NO.
1924# This tag requires that the tag GENERATE_MAN is set to YES.
1925
1926MAN_LINKS              = NO
1927
1928#---------------------------------------------------------------------------
1929# Configuration options related to the XML output
1930#---------------------------------------------------------------------------
1931
1932# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
1933# captures the structure of the code including all documentation.
1934# The default value is: NO.
1935
1936GENERATE_XML           = NO
1937
1938# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
1939# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1940# it.
1941# The default directory is: xml.
1942# This tag requires that the tag GENERATE_XML is set to YES.
1943
1944XML_OUTPUT             = xml
1945
1946# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
1947# listings (including syntax highlighting and cross-referencing information) to
1948# the XML output. Note that enabling this will significantly increase the size
1949# of the XML output.
1950# The default value is: YES.
1951# This tag requires that the tag GENERATE_XML is set to YES.
1952
1953XML_PROGRAMLISTING     = YES
1954
1955#---------------------------------------------------------------------------
1956# Configuration options related to the DOCBOOK output
1957#---------------------------------------------------------------------------
1958
1959# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
1960# that can be used to generate PDF.
1961# The default value is: NO.
1962
1963GENERATE_DOCBOOK       = NO
1964
1965# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
1966# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
1967# front of it.
1968# The default directory is: docbook.
1969# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1970
1971DOCBOOK_OUTPUT         = docbook
1972
1973# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
1974# program listings (including syntax highlighting and cross-referencing
1975# information) to the DOCBOOK output. Note that enabling this will significantly
1976# increase the size of the DOCBOOK output.
1977# The default value is: NO.
1978# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1979
1980DOCBOOK_PROGRAMLISTING = NO
1981
1982#---------------------------------------------------------------------------
1983# Configuration options for the AutoGen Definitions output
1984#---------------------------------------------------------------------------
1985
1986# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
1987# AutoGen Definitions (see http://autogen.sf.net) file that captures the
1988# structure of the code including all documentation. Note that this feature is
1989# still experimental and incomplete at the moment.
1990# The default value is: NO.
1991
1992GENERATE_AUTOGEN_DEF   = NO
1993
1994#---------------------------------------------------------------------------
1995# Configuration options related to the Perl module output
1996#---------------------------------------------------------------------------
1997
1998# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
1999# file that captures the structure of the code including all documentation.
2000#
2001# Note that this feature is still experimental and incomplete at the moment.
2002# The default value is: NO.
2003
2004GENERATE_PERLMOD       = NO
2005
2006# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
2007# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
2008# output from the Perl module output.
2009# The default value is: NO.
2010# This tag requires that the tag GENERATE_PERLMOD is set to YES.
2011
2012PERLMOD_LATEX          = NO
2013
2014# If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
2015# formatted so it can be parsed by a human reader. This is useful if you want to
2016# understand what is going on. On the other hand, if this tag is set to NO, the
2017# size of the Perl module output will be much smaller and Perl will parse it
2018# just the same.
2019# The default value is: YES.
2020# This tag requires that the tag GENERATE_PERLMOD is set to YES.
2021
2022PERLMOD_PRETTY         = YES
2023
2024# The names of the make variables in the generated doxyrules.make file are
2025# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
2026# so different doxyrules.make files included by the same Makefile don't
2027# overwrite each other's variables.
2028# This tag requires that the tag GENERATE_PERLMOD is set to YES.
2029
2030PERLMOD_MAKEVAR_PREFIX =
2031
2032#---------------------------------------------------------------------------
2033# Configuration options related to the preprocessor
2034#---------------------------------------------------------------------------
2035
2036# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
2037# C-preprocessor directives found in the sources and include files.
2038# The default value is: YES.
2039
2040ENABLE_PREPROCESSING   = YES
2041
2042# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
2043# in the source code. If set to NO, only conditional compilation will be
2044# performed. Macro expansion can be done in a controlled way by setting
2045# EXPAND_ONLY_PREDEF to YES.
2046# The default value is: NO.
2047# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2048
2049MACRO_EXPANSION        = YES
2050
2051# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
2052# the macro expansion is limited to the macros specified with the PREDEFINED and
2053# EXPAND_AS_DEFINED tags.
2054# The default value is: NO.
2055# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2056
2057EXPAND_ONLY_PREDEF     = NO
2058
2059# If the SEARCH_INCLUDES tag is set to YES, the include files in the
2060# INCLUDE_PATH will be searched if a #include is found.
2061# The default value is: YES.
2062# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2063
2064SEARCH_INCLUDES        = YES
2065
2066# The INCLUDE_PATH tag can be used to specify one or more directories that
2067# contain include files that are not input files but should be processed by the
2068# preprocessor.
2069# This tag requires that the tag SEARCH_INCLUDES is set to YES.
2070
2071INCLUDE_PATH           =
2072
2073# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
2074# patterns (like *.h and *.hpp) to filter out the header-files in the
2075# directories. If left blank, the patterns specified with FILE_PATTERNS will be
2076# used.
2077# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2078
2079INCLUDE_FILE_PATTERNS  =
2080
2081# The PREDEFINED tag can be used to specify one or more macro names that are
2082# defined before the preprocessor is started (similar to the -D option of e.g.
2083# gcc). The argument of the tag is a list of macros of the form: name or
2084# name=definition (no spaces). If the definition and the "=" are omitted, "=1"
2085# is assumed. To prevent a macro definition from being undefined via #undef or
2086# recursively expanded use the := operator instead of the = operator.
2087# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2088
2089PREDEFINED             = GRPC_FINAL= GRPC_OVERIDE=
2090
2091# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
2092# tag can be used to specify a list of macro names that should be expanded. The
2093# macro definition that is found in the sources will be used. Use the PREDEFINED
2094# tag if you want to use a different macro definition that overrules the
2095# definition found in the source code.
2096# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2097
2098EXPAND_AS_DEFINED      =
2099
2100# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
2101# remove all references to function-like macros that are alone on a line, have
2102# an all uppercase name, and do not end with a semicolon. Such function macros
2103# are typically used for boiler-plate code, and will confuse the parser if not
2104# removed.
2105# The default value is: YES.
2106# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2107
2108SKIP_FUNCTION_MACROS   = YES
2109
2110#---------------------------------------------------------------------------
2111# Configuration options related to external references
2112#---------------------------------------------------------------------------
2113
2114# The TAGFILES tag can be used to specify one or more tag files. For each tag
2115# file the location of the external documentation should be added. The format of
2116# a tag file without this location is as follows:
2117# TAGFILES = file1 file2 ...
2118# Adding location for the tag files is done as follows:
2119# TAGFILES = file1=loc1 "file2 = loc2" ...
2120# where loc1 and loc2 can be relative or absolute paths or URLs. See the
2121# section "Linking to external documentation" for more information about the use
2122# of tag files.
2123# Note: Each tag file must have a unique name (where the name does NOT include
2124# the path). If a tag file is not located in the directory in which doxygen is
2125# run, you must also specify the path to the tagfile here.
2126
2127TAGFILES               =
2128
2129# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
2130# tag file that is based on the input files it reads. See section "Linking to
2131# external documentation" for more information about the usage of tag files.
2132
2133GENERATE_TAGFILE       =
2134
2135# If the ALLEXTERNALS tag is set to YES, all external class will be listed in
2136# the class index. If set to NO, only the inherited external classes will be
2137# listed.
2138# The default value is: NO.
2139
2140ALLEXTERNALS           = NO
2141
2142# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
2143# in the modules index. If set to NO, only the current project's groups will be
2144# listed.
2145# The default value is: YES.
2146
2147EXTERNAL_GROUPS        = YES
2148
2149# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
2150# the related pages index. If set to NO, only the current project's pages will
2151# be listed.
2152# The default value is: YES.
2153
2154EXTERNAL_PAGES         = YES
2155
2156# The PERL_PATH should be the absolute path and name of the perl script
2157# interpreter (i.e. the result of 'which perl').
2158# The default file (with absolute path) is: /usr/bin/perl.
2159
2160PERL_PATH              = /usr/bin/perl
2161
2162#---------------------------------------------------------------------------
2163# Configuration options related to the dot tool
2164#---------------------------------------------------------------------------
2165
2166# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
2167# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
2168# NO turns the diagrams off. Note that this option also works with HAVE_DOT
2169# disabled, but it is recommended to install and use dot, since it yields more
2170# powerful graphs.
2171# The default value is: YES.
2172
2173CLASS_DIAGRAMS         = YES
2174
2175# You can define message sequence charts within doxygen comments using the \msc
2176# command. Doxygen will then run the mscgen tool (see:
2177# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
2178# documentation. The MSCGEN_PATH tag allows you to specify the directory where
2179# the mscgen tool resides. If left empty the tool is assumed to be found in the
2180# default search path.
2181
2182MSCGEN_PATH            =
2183
2184# You can include diagrams made with dia in doxygen documentation. Doxygen will
2185# then run dia to produce the diagram and insert it in the documentation. The
2186# DIA_PATH tag allows you to specify the directory where the dia binary resides.
2187# If left empty dia is assumed to be found in the default search path.
2188
2189DIA_PATH               =
2190
2191# If set to YES the inheritance and collaboration graphs will hide inheritance
2192# and usage relations if the target is undocumented or is not a class.
2193# The default value is: YES.
2194
2195HIDE_UNDOC_RELATIONS   = YES
2196
2197# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2198# available from the path. This tool is part of Graphviz (see:
2199# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
2200# Bell Labs. The other options in this section have no effect if this option is
2201# set to NO
2202# The default value is: NO.
2203
2204HAVE_DOT               = YES
2205
2206# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2207# to run in parallel. When set to 0 doxygen will base this on the number of
2208# processors available in the system. You can set it explicitly to a value
2209# larger than 0 to get control over the balance between CPU load and processing
2210# speed.
2211# Minimum value: 0, maximum value: 32, default value: 0.
2212# This tag requires that the tag HAVE_DOT is set to YES.
2213
2214DOT_NUM_THREADS        = 0
2215
2216# When you want a differently looking font in the dot files that doxygen
2217# generates you can specify the font name using DOT_FONTNAME. You need to make
2218# sure dot is able to find the font, which can be done by putting it in a
2219# standard location or by setting the DOTFONTPATH environment variable or by
2220# setting DOT_FONTPATH to the directory containing the font.
2221# The default value is: Helvetica.
2222# This tag requires that the tag HAVE_DOT is set to YES.
2223
2224DOT_FONTNAME           = Helvetica
2225
2226# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
2227# dot graphs.
2228# Minimum value: 4, maximum value: 24, default value: 10.
2229# This tag requires that the tag HAVE_DOT is set to YES.
2230
2231DOT_FONTSIZE           = 10
2232
2233# By default doxygen will tell dot to use the default font as specified with
2234# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
2235# the path where dot can find it using this tag.
2236# This tag requires that the tag HAVE_DOT is set to YES.
2237
2238DOT_FONTPATH           =
2239
2240# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2241# each documented class showing the direct and indirect inheritance relations.
2242# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
2243# The default value is: YES.
2244# This tag requires that the tag HAVE_DOT is set to YES.
2245
2246CLASS_GRAPH            = NO
2247
2248# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2249# graph for each documented class showing the direct and indirect implementation
2250# dependencies (inheritance, containment, and class references variables) of the
2251# class with other documented classes.
2252# The default value is: YES.
2253# This tag requires that the tag HAVE_DOT is set to YES.
2254
2255COLLABORATION_GRAPH    = NO
2256
2257# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2258# groups, showing the direct groups dependencies.
2259# The default value is: YES.
2260# This tag requires that the tag HAVE_DOT is set to YES.
2261
2262GROUP_GRAPHS           = NO
2263
2264# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
2265# collaboration diagrams in a style similar to the OMG's Unified Modeling
2266# Language.
2267# The default value is: NO.
2268# This tag requires that the tag HAVE_DOT is set to YES.
2269
2270UML_LOOK               = NO
2271
2272# If the UML_LOOK tag is enabled, the fields and methods are shown inside the
2273# class node. If there are many fields or methods and many nodes the graph may
2274# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2275# number of items for each type to make the size more manageable. Set this to 0
2276# for no limit. Note that the threshold may be exceeded by 50% before the limit
2277# is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2278# but if the number exceeds 15, the total amount of fields shown is limited to
2279# 10.
2280# Minimum value: 0, maximum value: 100, default value: 10.
2281# This tag requires that the tag HAVE_DOT is set to YES.
2282
2283UML_LIMIT_NUM_FIELDS   = 10
2284
2285# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2286# collaboration graphs will show the relations between templates and their
2287# instances.
2288# The default value is: NO.
2289# This tag requires that the tag HAVE_DOT is set to YES.
2290
2291TEMPLATE_RELATIONS     = NO
2292
2293# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2294# YES then doxygen will generate a graph for each documented file showing the
2295# direct and indirect include dependencies of the file with other documented
2296# files.
2297# The default value is: YES.
2298# This tag requires that the tag HAVE_DOT is set to YES.
2299
2300INCLUDE_GRAPH          = NO
2301
2302# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
2303# set to YES then doxygen will generate a graph for each documented file showing
2304# the direct and indirect include dependencies of the file with other documented
2305# files.
2306# The default value is: YES.
2307# This tag requires that the tag HAVE_DOT is set to YES.
2308
2309INCLUDED_BY_GRAPH      = NO
2310
2311# If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2312# dependency graph for every global function or class method.
2313#
2314# Note that enabling this option will significantly increase the time of a run.
2315# So in most cases it will be better to enable call graphs for selected
2316# functions only using the \callgraph command.
2317# The default value is: NO.
2318# This tag requires that the tag HAVE_DOT is set to YES.
2319
2320CALL_GRAPH             = NO
2321
2322# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2323# dependency graph for every global function or class method.
2324#
2325# Note that enabling this option will significantly increase the time of a run.
2326# So in most cases it will be better to enable caller graphs for selected
2327# functions only using the \callergraph command.
2328# The default value is: NO.
2329# This tag requires that the tag HAVE_DOT is set to YES.
2330
2331CALLER_GRAPH           = NO
2332
2333# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2334# hierarchy of all classes instead of a textual one.
2335# The default value is: YES.
2336# This tag requires that the tag HAVE_DOT is set to YES.
2337
2338GRAPHICAL_HIERARCHY    = NO
2339
2340# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2341# dependencies a directory has on other directories in a graphical way. The
2342# dependency relations are determined by the #include relations between the
2343# files in the directories.
2344# The default value is: YES.
2345# This tag requires that the tag HAVE_DOT is set to YES.
2346
2347DIRECTORY_GRAPH        = NO
2348
2349# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2350# generated by dot.
2351# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2352# to make the SVG files visible in IE 9+ (other browsers do not have this
2353# requirement).
2354# Possible values are: png, jpg, gif and svg.
2355# The default value is: png.
2356# This tag requires that the tag HAVE_DOT is set to YES.
2357
2358DOT_IMAGE_FORMAT       = png
2359
2360# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2361# enable generation of interactive SVG images that allow zooming and panning.
2362#
2363# Note that this requires a modern browser other than Internet Explorer. Tested
2364# and working are Firefox, Chrome, Safari, and Opera.
2365# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2366# the SVG files visible. Older versions of IE do not have SVG support.
2367# The default value is: NO.
2368# This tag requires that the tag HAVE_DOT is set to YES.
2369
2370INTERACTIVE_SVG        = NO
2371
2372# The DOT_PATH tag can be used to specify the path where the dot tool can be
2373# found. If left blank, it is assumed the dot tool can be found in the path.
2374# This tag requires that the tag HAVE_DOT is set to YES.
2375
2376DOT_PATH               =
2377
2378# The DOTFILE_DIRS tag can be used to specify one or more directories that
2379# contain dot files that are included in the documentation (see the \dotfile
2380# command).
2381# This tag requires that the tag HAVE_DOT is set to YES.
2382
2383DOTFILE_DIRS           =
2384
2385# The MSCFILE_DIRS tag can be used to specify one or more directories that
2386# contain msc files that are included in the documentation (see the \mscfile
2387# command).
2388
2389MSCFILE_DIRS           =
2390
2391# The DIAFILE_DIRS tag can be used to specify one or more directories that
2392# contain dia files that are included in the documentation (see the \diafile
2393# command).
2394
2395DIAFILE_DIRS           =
2396
2397# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
2398# path where java can find the plantuml.jar file. If left blank, it is assumed
2399# PlantUML is not used or called during a preprocessing step. Doxygen will
2400# generate a warning when it encounters a \startuml command in this case and
2401# will not generate output for the diagram.
2402
2403PLANTUML_JAR_PATH      =
2404
2405# When using plantuml, the specified paths are searched for files specified by
2406# the !include statement in a plantuml block.
2407
2408PLANTUML_INCLUDE_PATH  =
2409
2410# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2411# that will be shown in the graph. If the number of nodes in a graph becomes
2412# larger than this value, doxygen will truncate the graph, which is visualized
2413# by representing a node as a red box. Note that doxygen if the number of direct
2414# children of the root node in a graph is already larger than
2415# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2416# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2417# Minimum value: 0, maximum value: 10000, default value: 50.
2418# This tag requires that the tag HAVE_DOT is set to YES.
2419
2420DOT_GRAPH_MAX_NODES    = 50
2421
2422# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2423# generated by dot. A depth value of 3 means that only nodes reachable from the
2424# root by following a path via at most 3 edges will be shown. Nodes that lay
2425# further from the root node will be omitted. Note that setting this option to 1
2426# or 2 may greatly reduce the computation time needed for large code bases. Also
2427# note that the size of a graph can be further restricted by
2428# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
2429# Minimum value: 0, maximum value: 1000, default value: 0.
2430# This tag requires that the tag HAVE_DOT is set to YES.
2431
2432MAX_DOT_GRAPH_DEPTH    = 0
2433
2434# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2435# background. This is disabled by default, because dot on Windows does not seem
2436# to support this out of the box.
2437#
2438# Warning: Depending on the platform used, enabling this option may lead to
2439# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2440# read).
2441# The default value is: NO.
2442# This tag requires that the tag HAVE_DOT is set to YES.
2443
2444DOT_TRANSPARENT        = NO
2445
2446# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
2447# files in one run (i.e. multiple -o and -T options on the command line). This
2448# makes dot run faster, but since only newer versions of dot (>1.8.10) support
2449# this, this feature is disabled by default.
2450# The default value is: NO.
2451# This tag requires that the tag HAVE_DOT is set to YES.
2452
2453DOT_MULTI_TARGETS      = NO
2454
2455# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2456# explaining the meaning of the various boxes and arrows in the dot generated
2457# graphs.
2458# The default value is: YES.
2459# This tag requires that the tag HAVE_DOT is set to YES.
2460
2461GENERATE_LEGEND        = YES
2462
2463# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
2464# files that are used to generate the various graphs.
2465# The default value is: YES.
2466# This tag requires that the tag HAVE_DOT is set to YES.
2467
2468DOT_CLEANUP            = YES
2469
2470