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