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