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