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