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