blob: 597f22b63408f6bc274f044507607722346fa6fd [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 Core"
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
Sree Kuchibhotla9a7bab52017-03-29 11:51:25 -070043PROJECT_NUMBER = 4.0.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/core.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 \
ncteisen4c2e57d2017-03-21 19:08:53 -0700774doc/core/grpc-error.md \
Craig Tilleraa272bc2017-01-10 12:48:52 -0800775doc/core/pending_api_cleanups.md \
776doc/cpp-style-guide.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 \
797include/grpc/byte_buffer.h \
Craig Tillereb327fb2015-06-23 16:51:38 -0700798include/grpc/byte_buffer_reader.h \
Craig Tilleraa272bc2017-01-10 12:48:52 -0800799include/grpc/census.h \
Craig Tillereb327fb2015-06-23 16:51:38 -0700800include/grpc/compression.h \
801include/grpc/grpc.h \
Adam Michalik321b1fb2016-05-16 15:42:36 -0700802include/grpc/grpc_posix.h \
Craig Tilleraa272bc2017-01-10 12:48:52 -0800803include/grpc/grpc_security.h \
Nicolas "Pixel" Noblea469e5d2016-08-16 22:09:27 +0200804include/grpc/grpc_security_constants.h \
Craig Tilleraa272bc2017-01-10 12:48:52 -0800805include/grpc/impl/codegen/atm.h \
806include/grpc/impl/codegen/atm.h \
807include/grpc/impl/codegen/atm_gcc_atomic.h \
808include/grpc/impl/codegen/atm_gcc_atomic.h \
809include/grpc/impl/codegen/atm_gcc_sync.h \
810include/grpc/impl/codegen/atm_gcc_sync.h \
811include/grpc/impl/codegen/atm_windows.h \
812include/grpc/impl/codegen/atm_windows.h \
David Garcia Quintas1b2db632016-04-27 15:06:54 -0700813include/grpc/impl/codegen/byte_buffer_reader.h \
Craig Tiller6c4ae602015-05-28 08:41:41 -0700814include/grpc/impl/codegen/compression_types.h \
815include/grpc/impl/codegen/connectivity_state.h \
Craig Tillerb995e8b2016-12-12 06:36:43 -0800816include/grpc/impl/codegen/exec_ctx_fwd.h \
Mark D. Roth92c93b92017-01-13 15:07:57 -0800817include/grpc/impl/codegen/gpr_slice.h \
818include/grpc/impl/codegen/gpr_slice.h \
David Garcia Quintas8c5424f2016-08-01 22:49:00 -0700819include/grpc/impl/codegen/gpr_types.h \
Craig Tilleraa272bc2017-01-10 12:48:52 -0800820include/grpc/impl/codegen/gpr_types.h \
821include/grpc/impl/codegen/grpc_types.h \
Craig Tiller03915e52016-04-07 09:15:10 -0700822include/grpc/impl/codegen/port_platform.h \
Craig Tilleraa272bc2017-01-10 12:48:52 -0800823include/grpc/impl/codegen/port_platform.h \
824include/grpc/impl/codegen/propagation_bits.h \
Craig Tiller03915e52016-04-07 09:15:10 -0700825include/grpc/impl/codegen/slice.h \
Craig Tilleraa272bc2017-01-10 12:48:52 -0800826include/grpc/impl/codegen/status.h \
827include/grpc/impl/codegen/sync.h \
Craig Tiller03915e52016-04-07 09:15:10 -0700828include/grpc/impl/codegen/sync.h \
829include/grpc/impl/codegen/sync_generic.h \
Craig Tilleraa272bc2017-01-10 12:48:52 -0800830include/grpc/impl/codegen/sync_generic.h \
831include/grpc/impl/codegen/sync_posix.h \
Craig Tiller03915e52016-04-07 09:15:10 -0700832include/grpc/impl/codegen/sync_posix.h \
Yuchen Zeng12dfdc32016-04-26 22:05:41 -0700833include/grpc/impl/codegen/sync_windows.h \
Craig Tilleraa272bc2017-01-10 12:48:52 -0800834include/grpc/impl/codegen/sync_windows.h \
David Garcia Quintasf31f0962017-02-10 14:53:58 -0800835include/grpc/load_reporting.h \
Craig Tilleraa272bc2017-01-10 12:48:52 -0800836include/grpc/slice.h \
837include/grpc/slice_buffer.h \
838include/grpc/status.h \
Craig Tillerda179ce2016-02-09 12:01:53 -0800839include/grpc/support/alloc.h \
840include/grpc/support/atm.h \
841include/grpc/support/atm_gcc_atomic.h \
842include/grpc/support/atm_gcc_sync.h \
Yuchen Zeng12dfdc32016-04-26 22:05:41 -0700843include/grpc/support/atm_windows.h \
Craig Tillerda179ce2016-02-09 12:01:53 -0800844include/grpc/support/avl.h \
845include/grpc/support/cmdline.h \
846include/grpc/support/cpu.h \
847include/grpc/support/histogram.h \
848include/grpc/support/host_port.h \
849include/grpc/support/log.h \
Yuchen Zeng12dfdc32016-04-26 22:05:41 -0700850include/grpc/support/log_windows.h \
Craig Tillerda179ce2016-02-09 12:01:53 -0800851include/grpc/support/port_platform.h \
Craig Tillerda179ce2016-02-09 12:01:53 -0800852include/grpc/support/string_util.h \
853include/grpc/support/subprocess.h \
854include/grpc/support/sync.h \
855include/grpc/support/sync_generic.h \
856include/grpc/support/sync_posix.h \
Yuchen Zeng12dfdc32016-04-26 22:05:41 -0700857include/grpc/support/sync_windows.h \
Craig Tillerda179ce2016-02-09 12:01:53 -0800858include/grpc/support/thd.h \
859include/grpc/support/time.h \
860include/grpc/support/tls.h \
861include/grpc/support/tls_gcc.h \
862include/grpc/support/tls_msvc.h \
863include/grpc/support/tls_pthread.h \
864include/grpc/support/useful.h \
Muxi Yan29ff4662017-05-15 10:27:55 -0700865include/grpc/support/workaround_list.h \
Craig Tilleraa272bc2017-01-10 12:48:52 -0800866src/core/README.md \
867src/core/ext/README.md \
868src/core/ext/census/README.md \
869src/core/ext/census/aggregation.h \
870src/core/ext/census/base_resources.c \
871src/core/ext/census/base_resources.h \
872src/core/ext/census/census_interface.h \
873src/core/ext/census/census_rpc_stats.h \
874src/core/ext/census/context.c \
875src/core/ext/census/gen/README.md \
876src/core/ext/census/gen/census.pb.c \
877src/core/ext/census/gen/census.pb.h \
878src/core/ext/census/gen/trace_context.pb.c \
879src/core/ext/census/gen/trace_context.pb.h \
880src/core/ext/census/grpc_context.c \
881src/core/ext/census/grpc_filter.c \
882src/core/ext/census/grpc_filter.h \
883src/core/ext/census/grpc_plugin.c \
884src/core/ext/census/initialize.c \
885src/core/ext/census/mlog.c \
886src/core/ext/census/mlog.h \
887src/core/ext/census/operation.c \
888src/core/ext/census/placeholders.c \
889src/core/ext/census/resource.c \
890src/core/ext/census/resource.h \
891src/core/ext/census/rpc_metric_id.h \
892src/core/ext/census/trace_context.c \
893src/core/ext/census/trace_context.h \
Vizerai0e5b67f2017-01-20 14:02:18 -0800894src/core/ext/census/trace_label.h \
895src/core/ext/census/trace_propagation.h \
896src/core/ext/census/trace_status.h \
897src/core/ext/census/trace_string.h \
Craig Tilleraa272bc2017-01-10 12:48:52 -0800898src/core/ext/census/tracing.c \
Vizerai0e5b67f2017-01-20 14:02:18 -0800899src/core/ext/census/tracing.h \
Craig Tiller6d4894e2017-03-31 17:22:06 -0700900src/core/ext/filters/client_channel/README.md \
Craig Tiller9eb0fde2017-03-31 16:59:30 -0700901src/core/ext/filters/client_channel/channel_connectivity.c \
902src/core/ext/filters/client_channel/client_channel.c \
903src/core/ext/filters/client_channel/client_channel.h \
904src/core/ext/filters/client_channel/client_channel_factory.c \
905src/core/ext/filters/client_channel/client_channel_factory.h \
906src/core/ext/filters/client_channel/client_channel_plugin.c \
907src/core/ext/filters/client_channel/connector.c \
908src/core/ext/filters/client_channel/connector.h \
909src/core/ext/filters/client_channel/http_connect_handshaker.c \
910src/core/ext/filters/client_channel/http_connect_handshaker.h \
911src/core/ext/filters/client_channel/http_proxy.c \
912src/core/ext/filters/client_channel/http_proxy.h \
913src/core/ext/filters/client_channel/lb_policy.c \
914src/core/ext/filters/client_channel/lb_policy.h \
Mark D. Roth09e458c2017-05-02 08:13:26 -0700915src/core/ext/filters/client_channel/lb_policy/grpclb/client_load_reporting_filter.c \
916src/core/ext/filters/client_channel/lb_policy/grpclb/client_load_reporting_filter.h \
Craig Tiller6d4894e2017-03-31 17:22:06 -0700917src/core/ext/filters/client_channel/lb_policy/grpclb/grpclb.c \
918src/core/ext/filters/client_channel/lb_policy/grpclb/grpclb.h \
919src/core/ext/filters/client_channel/lb_policy/grpclb/grpclb_channel.h \
920src/core/ext/filters/client_channel/lb_policy/grpclb/grpclb_channel_secure.c \
Mark D. Roth09e458c2017-05-02 08:13:26 -0700921src/core/ext/filters/client_channel/lb_policy/grpclb/grpclb_client_stats.c \
922src/core/ext/filters/client_channel/lb_policy/grpclb/grpclb_client_stats.h \
Craig Tiller6d4894e2017-03-31 17:22:06 -0700923src/core/ext/filters/client_channel/lb_policy/grpclb/load_balancer_api.c \
924src/core/ext/filters/client_channel/lb_policy/grpclb/load_balancer_api.h \
925src/core/ext/filters/client_channel/lb_policy/grpclb/proto/grpc/lb/v1/load_balancer.pb.c \
926src/core/ext/filters/client_channel/lb_policy/grpclb/proto/grpc/lb/v1/load_balancer.pb.h \
927src/core/ext/filters/client_channel/lb_policy/pick_first/pick_first.c \
928src/core/ext/filters/client_channel/lb_policy/round_robin/round_robin.c \
Craig Tiller9eb0fde2017-03-31 16:59:30 -0700929src/core/ext/filters/client_channel/lb_policy_factory.c \
930src/core/ext/filters/client_channel/lb_policy_factory.h \
931src/core/ext/filters/client_channel/lb_policy_registry.c \
932src/core/ext/filters/client_channel/lb_policy_registry.h \
933src/core/ext/filters/client_channel/parse_address.c \
934src/core/ext/filters/client_channel/parse_address.h \
935src/core/ext/filters/client_channel/proxy_mapper.c \
936src/core/ext/filters/client_channel/proxy_mapper.h \
937src/core/ext/filters/client_channel/proxy_mapper_registry.c \
938src/core/ext/filters/client_channel/proxy_mapper_registry.h \
939src/core/ext/filters/client_channel/resolver.c \
940src/core/ext/filters/client_channel/resolver.h \
Craig Tiller6d4894e2017-03-31 17:22:06 -0700941src/core/ext/filters/client_channel/resolver/README.md \
942src/core/ext/filters/client_channel/resolver/dns/c_ares/dns_resolver_ares.c \
943src/core/ext/filters/client_channel/resolver/dns/c_ares/grpc_ares_ev_driver.h \
944src/core/ext/filters/client_channel/resolver/dns/c_ares/grpc_ares_ev_driver_posix.c \
945src/core/ext/filters/client_channel/resolver/dns/c_ares/grpc_ares_wrapper.c \
946src/core/ext/filters/client_channel/resolver/dns/c_ares/grpc_ares_wrapper.h \
947src/core/ext/filters/client_channel/resolver/dns/native/README.md \
948src/core/ext/filters/client_channel/resolver/dns/native/dns_resolver.c \
949src/core/ext/filters/client_channel/resolver/sockaddr/README.md \
950src/core/ext/filters/client_channel/resolver/sockaddr/sockaddr_resolver.c \
Craig Tiller9eb0fde2017-03-31 16:59:30 -0700951src/core/ext/filters/client_channel/resolver_factory.c \
952src/core/ext/filters/client_channel/resolver_factory.h \
953src/core/ext/filters/client_channel/resolver_registry.c \
954src/core/ext/filters/client_channel/resolver_registry.h \
955src/core/ext/filters/client_channel/retry_throttle.c \
956src/core/ext/filters/client_channel/retry_throttle.h \
957src/core/ext/filters/client_channel/subchannel.c \
958src/core/ext/filters/client_channel/subchannel.h \
959src/core/ext/filters/client_channel/subchannel_index.c \
960src/core/ext/filters/client_channel/subchannel_index.h \
961src/core/ext/filters/client_channel/uri_parser.c \
962src/core/ext/filters/client_channel/uri_parser.h \
Craig Tiller3be7dd02017-04-03 14:30:03 -0700963src/core/ext/filters/deadline/deadline_filter.c \
964src/core/ext/filters/deadline/deadline_filter.h \
Craig Tilleraf767432017-04-03 13:54:31 -0700965src/core/ext/filters/http/client/http_client_filter.c \
966src/core/ext/filters/http/client/http_client_filter.h \
Craig Tiller71d6ce62017-04-06 09:10:09 -0700967src/core/ext/filters/http/http_filters_plugin.c \
Craig Tillera24b9712017-04-06 09:03:21 -0700968src/core/ext/filters/http/message_compress/message_compress_filter.c \
969src/core/ext/filters/http/message_compress/message_compress_filter.h \
Craig Tilleraf767432017-04-03 13:54:31 -0700970src/core/ext/filters/http/server/http_server_filter.c \
971src/core/ext/filters/http/server/http_server_filter.h \
Craig Tiller9eb0fde2017-03-31 16:59:30 -0700972src/core/ext/filters/load_reporting/load_reporting.c \
973src/core/ext/filters/load_reporting/load_reporting.h \
974src/core/ext/filters/load_reporting/load_reporting_filter.c \
975src/core/ext/filters/load_reporting/load_reporting_filter.h \
Craig Tiller6d4894e2017-03-31 17:22:06 -0700976src/core/ext/filters/max_age/max_age_filter.c \
977src/core/ext/filters/max_age/max_age_filter.h \
Craig Tiller9b3648a2017-04-03 12:25:19 -0700978src/core/ext/filters/message_size/message_size_filter.c \
979src/core/ext/filters/message_size/message_size_filter.h \
Muxi Yan29ff4662017-05-15 10:27:55 -0700980src/core/ext/filters/workarounds/workaround_cronet_compression_filter.c \
981src/core/ext/filters/workarounds/workaround_cronet_compression_filter.h \
982src/core/ext/filters/workarounds/workaround_utils.c \
983src/core/ext/filters/workarounds/workaround_utils.h \
Craig Tilleraa272bc2017-01-10 12:48:52 -0800984src/core/ext/transport/README.md \
985src/core/ext/transport/chttp2/README.md \
986src/core/ext/transport/chttp2/alpn/alpn.c \
987src/core/ext/transport/chttp2/alpn/alpn.h \
988src/core/ext/transport/chttp2/client/chttp2_connector.c \
989src/core/ext/transport/chttp2/client/chttp2_connector.h \
990src/core/ext/transport/chttp2/client/insecure/README.md \
991src/core/ext/transport/chttp2/client/insecure/channel_create.c \
992src/core/ext/transport/chttp2/client/insecure/channel_create_posix.c \
993src/core/ext/transport/chttp2/client/secure/README.md \
994src/core/ext/transport/chttp2/client/secure/secure_channel_create.c \
995src/core/ext/transport/chttp2/server/chttp2_server.c \
996src/core/ext/transport/chttp2/server/chttp2_server.h \
997src/core/ext/transport/chttp2/server/insecure/README.md \
998src/core/ext/transport/chttp2/server/insecure/server_chttp2.c \
999src/core/ext/transport/chttp2/server/insecure/server_chttp2_posix.c \
1000src/core/ext/transport/chttp2/server/secure/README.md \
1001src/core/ext/transport/chttp2/server/secure/server_secure_chttp2.c \
1002src/core/ext/transport/chttp2/transport/README.md \
1003src/core/ext/transport/chttp2/transport/bin_decoder.c \
1004src/core/ext/transport/chttp2/transport/bin_decoder.h \
1005src/core/ext/transport/chttp2/transport/bin_encoder.c \
1006src/core/ext/transport/chttp2/transport/bin_encoder.h \
1007src/core/ext/transport/chttp2/transport/chttp2_plugin.c \
1008src/core/ext/transport/chttp2/transport/chttp2_transport.c \
1009src/core/ext/transport/chttp2/transport/chttp2_transport.h \
1010src/core/ext/transport/chttp2/transport/frame.h \
1011src/core/ext/transport/chttp2/transport/frame_data.c \
1012src/core/ext/transport/chttp2/transport/frame_data.h \
1013src/core/ext/transport/chttp2/transport/frame_goaway.c \
1014src/core/ext/transport/chttp2/transport/frame_goaway.h \
1015src/core/ext/transport/chttp2/transport/frame_ping.c \
1016src/core/ext/transport/chttp2/transport/frame_ping.h \
1017src/core/ext/transport/chttp2/transport/frame_rst_stream.c \
1018src/core/ext/transport/chttp2/transport/frame_rst_stream.h \
1019src/core/ext/transport/chttp2/transport/frame_settings.c \
1020src/core/ext/transport/chttp2/transport/frame_settings.h \
1021src/core/ext/transport/chttp2/transport/frame_window_update.c \
1022src/core/ext/transport/chttp2/transport/frame_window_update.h \
1023src/core/ext/transport/chttp2/transport/hpack_encoder.c \
1024src/core/ext/transport/chttp2/transport/hpack_encoder.h \
1025src/core/ext/transport/chttp2/transport/hpack_parser.c \
1026src/core/ext/transport/chttp2/transport/hpack_parser.h \
1027src/core/ext/transport/chttp2/transport/hpack_table.c \
1028src/core/ext/transport/chttp2/transport/hpack_table.h \
Craig Tillerc8f62bc2017-04-03 16:25:45 -07001029src/core/ext/transport/chttp2/transport/http2_settings.c \
1030src/core/ext/transport/chttp2/transport/http2_settings.h \
Craig Tilleraa272bc2017-01-10 12:48:52 -08001031src/core/ext/transport/chttp2/transport/huffsyms.c \
1032src/core/ext/transport/chttp2/transport/huffsyms.h \
1033src/core/ext/transport/chttp2/transport/incoming_metadata.c \
1034src/core/ext/transport/chttp2/transport/incoming_metadata.h \
1035src/core/ext/transport/chttp2/transport/internal.h \
1036src/core/ext/transport/chttp2/transport/parsing.c \
Craig Tilleraa272bc2017-01-10 12:48:52 -08001037src/core/ext/transport/chttp2/transport/stream_lists.c \
1038src/core/ext/transport/chttp2/transport/stream_map.c \
1039src/core/ext/transport/chttp2/transport/stream_map.h \
1040src/core/ext/transport/chttp2/transport/varint.c \
1041src/core/ext/transport/chttp2/transport/varint.h \
1042src/core/ext/transport/chttp2/transport/writing.c \
1043src/core/lib/README.md \
1044src/core/lib/channel/README.md \
1045src/core/lib/channel/channel_args.c \
1046src/core/lib/channel/channel_args.h \
1047src/core/lib/channel/channel_stack.c \
1048src/core/lib/channel/channel_stack.h \
1049src/core/lib/channel/channel_stack_builder.c \
1050src/core/lib/channel/channel_stack_builder.h \
Craig Tilleraa272bc2017-01-10 12:48:52 -08001051src/core/lib/channel/connected_channel.c \
1052src/core/lib/channel/connected_channel.h \
1053src/core/lib/channel/context.h \
Craig Tilleraa272bc2017-01-10 12:48:52 -08001054src/core/lib/channel/handshaker.c \
1055src/core/lib/channel/handshaker.h \
1056src/core/lib/channel/handshaker_factory.c \
1057src/core/lib/channel/handshaker_factory.h \
1058src/core/lib/channel/handshaker_registry.c \
1059src/core/lib/channel/handshaker_registry.h \
Craig Tilleraa272bc2017-01-10 12:48:52 -08001060src/core/lib/compression/algorithm_metadata.h \
1061src/core/lib/compression/compression.c \
1062src/core/lib/compression/message_compress.c \
1063src/core/lib/compression/message_compress.h \
1064src/core/lib/debug/trace.c \
1065src/core/lib/debug/trace.h \
1066src/core/lib/http/format_request.c \
1067src/core/lib/http/format_request.h \
1068src/core/lib/http/httpcli.c \
1069src/core/lib/http/httpcli.h \
1070src/core/lib/http/httpcli_security_connector.c \
1071src/core/lib/http/parser.c \
1072src/core/lib/http/parser.h \
1073src/core/lib/iomgr/README.md \
1074src/core/lib/iomgr/closure.c \
1075src/core/lib/iomgr/closure.h \
1076src/core/lib/iomgr/combiner.c \
1077src/core/lib/iomgr/combiner.h \
1078src/core/lib/iomgr/endpoint.c \
1079src/core/lib/iomgr/endpoint.h \
1080src/core/lib/iomgr/endpoint_pair.h \
1081src/core/lib/iomgr/endpoint_pair_posix.c \
1082src/core/lib/iomgr/endpoint_pair_uv.c \
1083src/core/lib/iomgr/endpoint_pair_windows.c \
1084src/core/lib/iomgr/error.c \
1085src/core/lib/iomgr/error.h \
Craig Tiller7c70b6c2017-01-23 07:48:42 -08001086src/core/lib/iomgr/error_internal.h \
Craig Tillerc67cc992017-04-27 10:15:51 -07001087src/core/lib/iomgr/ev_epoll1_linux.c \
1088src/core/lib/iomgr/ev_epoll1_linux.h \
Sree Kuchibhotla5a1a3b42017-05-05 13:14:45 -07001089src/core/lib/iomgr/ev_epoll_limited_pollers_linux.c \
1090src/core/lib/iomgr/ev_epoll_limited_pollers_linux.h \
Sree Kuchibhotlad4fc32e2017-05-02 14:15:12 -07001091src/core/lib/iomgr/ev_epoll_thread_pool_linux.c \
1092src/core/lib/iomgr/ev_epoll_thread_pool_linux.h \
Craig Tillerf4360d72017-04-07 08:51:00 -07001093src/core/lib/iomgr/ev_epollex_linux.c \
1094src/core/lib/iomgr/ev_epollex_linux.h \
Craig Tillerc67cc992017-04-27 10:15:51 -07001095src/core/lib/iomgr/ev_epollsig_linux.c \
1096src/core/lib/iomgr/ev_epollsig_linux.h \
Craig Tilleraa272bc2017-01-10 12:48:52 -08001097src/core/lib/iomgr/ev_poll_posix.c \
1098src/core/lib/iomgr/ev_poll_posix.h \
1099src/core/lib/iomgr/ev_posix.c \
1100src/core/lib/iomgr/ev_posix.h \
1101src/core/lib/iomgr/exec_ctx.c \
1102src/core/lib/iomgr/exec_ctx.h \
1103src/core/lib/iomgr/executor.c \
1104src/core/lib/iomgr/executor.h \
1105src/core/lib/iomgr/iocp_windows.c \
1106src/core/lib/iomgr/iocp_windows.h \
1107src/core/lib/iomgr/iomgr.c \
1108src/core/lib/iomgr/iomgr.h \
1109src/core/lib/iomgr/iomgr_internal.h \
1110src/core/lib/iomgr/iomgr_posix.c \
1111src/core/lib/iomgr/iomgr_posix.h \
1112src/core/lib/iomgr/iomgr_uv.c \
1113src/core/lib/iomgr/iomgr_windows.c \
Craig Tiller819cd882017-04-25 13:18:22 -07001114src/core/lib/iomgr/is_epollexclusive_available.c \
1115src/core/lib/iomgr/is_epollexclusive_available.h \
Craig Tilleraa272bc2017-01-10 12:48:52 -08001116src/core/lib/iomgr/load_file.c \
1117src/core/lib/iomgr/load_file.h \
Craig Tiller376887d2017-04-06 08:27:03 -07001118src/core/lib/iomgr/lockfree_event.c \
1119src/core/lib/iomgr/lockfree_event.h \
Craig Tilleraa272bc2017-01-10 12:48:52 -08001120src/core/lib/iomgr/network_status_tracker.c \
1121src/core/lib/iomgr/network_status_tracker.h \
1122src/core/lib/iomgr/polling_entity.c \
1123src/core/lib/iomgr/polling_entity.h \
1124src/core/lib/iomgr/pollset.h \
1125src/core/lib/iomgr/pollset_set.h \
1126src/core/lib/iomgr/pollset_set_uv.c \
1127src/core/lib/iomgr/pollset_set_windows.c \
1128src/core/lib/iomgr/pollset_set_windows.h \
1129src/core/lib/iomgr/pollset_uv.c \
1130src/core/lib/iomgr/pollset_uv.h \
1131src/core/lib/iomgr/pollset_windows.c \
1132src/core/lib/iomgr/pollset_windows.h \
1133src/core/lib/iomgr/port.h \
1134src/core/lib/iomgr/resolve_address.h \
1135src/core/lib/iomgr/resolve_address_posix.c \
1136src/core/lib/iomgr/resolve_address_uv.c \
1137src/core/lib/iomgr/resolve_address_windows.c \
1138src/core/lib/iomgr/resource_quota.c \
1139src/core/lib/iomgr/resource_quota.h \
1140src/core/lib/iomgr/sockaddr.h \
1141src/core/lib/iomgr/sockaddr_posix.h \
1142src/core/lib/iomgr/sockaddr_utils.c \
1143src/core/lib/iomgr/sockaddr_utils.h \
1144src/core/lib/iomgr/sockaddr_windows.h \
Michael Warresc46b3eb2017-02-22 22:57:04 -05001145src/core/lib/iomgr/socket_factory_posix.c \
1146src/core/lib/iomgr/socket_factory_posix.h \
Craig Tilleraa272bc2017-01-10 12:48:52 -08001147src/core/lib/iomgr/socket_mutator.c \
1148src/core/lib/iomgr/socket_mutator.h \
1149src/core/lib/iomgr/socket_utils.h \
1150src/core/lib/iomgr/socket_utils_common_posix.c \
1151src/core/lib/iomgr/socket_utils_linux.c \
1152src/core/lib/iomgr/socket_utils_posix.c \
1153src/core/lib/iomgr/socket_utils_posix.h \
1154src/core/lib/iomgr/socket_utils_uv.c \
1155src/core/lib/iomgr/socket_utils_windows.c \
1156src/core/lib/iomgr/socket_windows.c \
1157src/core/lib/iomgr/socket_windows.h \
Craig Tiller819cd882017-04-25 13:18:22 -07001158src/core/lib/iomgr/sys_epoll_wrapper.h \
Craig Tilleraa272bc2017-01-10 12:48:52 -08001159src/core/lib/iomgr/tcp_client.h \
1160src/core/lib/iomgr/tcp_client_posix.c \
1161src/core/lib/iomgr/tcp_client_posix.h \
1162src/core/lib/iomgr/tcp_client_uv.c \
1163src/core/lib/iomgr/tcp_client_windows.c \
1164src/core/lib/iomgr/tcp_posix.c \
1165src/core/lib/iomgr/tcp_posix.h \
1166src/core/lib/iomgr/tcp_server.h \
1167src/core/lib/iomgr/tcp_server_posix.c \
Yuchen Zeng47155ed2017-03-13 17:18:07 -07001168src/core/lib/iomgr/tcp_server_utils_posix.h \
Yuchen Zeng68745bb2017-03-14 17:51:07 -07001169src/core/lib/iomgr/tcp_server_utils_posix_common.c \
Yuchen Zeng47155ed2017-03-13 17:18:07 -07001170src/core/lib/iomgr/tcp_server_utils_posix_ifaddrs.c \
1171src/core/lib/iomgr/tcp_server_utils_posix_noifaddrs.c \
Craig Tilleraa272bc2017-01-10 12:48:52 -08001172src/core/lib/iomgr/tcp_server_uv.c \
1173src/core/lib/iomgr/tcp_server_windows.c \
1174src/core/lib/iomgr/tcp_uv.c \
1175src/core/lib/iomgr/tcp_uv.h \
1176src/core/lib/iomgr/tcp_windows.c \
1177src/core/lib/iomgr/tcp_windows.h \
1178src/core/lib/iomgr/time_averaged_stats.c \
1179src/core/lib/iomgr/time_averaged_stats.h \
1180src/core/lib/iomgr/timer.h \
1181src/core/lib/iomgr/timer_generic.c \
1182src/core/lib/iomgr/timer_generic.h \
1183src/core/lib/iomgr/timer_heap.c \
1184src/core/lib/iomgr/timer_heap.h \
Craig Tillerc3571792017-05-02 12:33:38 -07001185src/core/lib/iomgr/timer_manager.c \
1186src/core/lib/iomgr/timer_manager.h \
Craig Tilleraa272bc2017-01-10 12:48:52 -08001187src/core/lib/iomgr/timer_uv.c \
1188src/core/lib/iomgr/timer_uv.h \
1189src/core/lib/iomgr/udp_server.c \
1190src/core/lib/iomgr/udp_server.h \
1191src/core/lib/iomgr/unix_sockets_posix.c \
1192src/core/lib/iomgr/unix_sockets_posix.h \
1193src/core/lib/iomgr/unix_sockets_posix_noop.c \
1194src/core/lib/iomgr/wakeup_fd_cv.c \
1195src/core/lib/iomgr/wakeup_fd_cv.h \
1196src/core/lib/iomgr/wakeup_fd_eventfd.c \
1197src/core/lib/iomgr/wakeup_fd_nospecial.c \
1198src/core/lib/iomgr/wakeup_fd_pipe.c \
1199src/core/lib/iomgr/wakeup_fd_pipe.h \
1200src/core/lib/iomgr/wakeup_fd_posix.c \
1201src/core/lib/iomgr/wakeup_fd_posix.h \
1202src/core/lib/iomgr/workqueue.h \
1203src/core/lib/iomgr/workqueue_uv.c \
1204src/core/lib/iomgr/workqueue_uv.h \
1205src/core/lib/iomgr/workqueue_windows.c \
1206src/core/lib/iomgr/workqueue_windows.h \
1207src/core/lib/json/json.c \
1208src/core/lib/json/json.h \
1209src/core/lib/json/json_common.h \
1210src/core/lib/json/json_reader.c \
1211src/core/lib/json/json_reader.h \
1212src/core/lib/json/json_string.c \
1213src/core/lib/json/json_writer.c \
1214src/core/lib/json/json_writer.h \
Craig Tillerf23078c2016-03-25 17:07:29 -07001215src/core/lib/profiling/basic_timers.c \
1216src/core/lib/profiling/stap_timers.c \
Craig Tilleraa272bc2017-01-10 12:48:52 -08001217src/core/lib/profiling/timers.h \
1218src/core/lib/security/context/security_context.c \
1219src/core/lib/security/context/security_context.h \
1220src/core/lib/security/credentials/composite/composite_credentials.c \
1221src/core/lib/security/credentials/composite/composite_credentials.h \
1222src/core/lib/security/credentials/credentials.c \
1223src/core/lib/security/credentials/credentials.h \
1224src/core/lib/security/credentials/credentials_metadata.c \
1225src/core/lib/security/credentials/fake/fake_credentials.c \
1226src/core/lib/security/credentials/fake/fake_credentials.h \
1227src/core/lib/security/credentials/google_default/credentials_generic.c \
1228src/core/lib/security/credentials/google_default/google_default_credentials.c \
1229src/core/lib/security/credentials/google_default/google_default_credentials.h \
1230src/core/lib/security/credentials/iam/iam_credentials.c \
1231src/core/lib/security/credentials/iam/iam_credentials.h \
1232src/core/lib/security/credentials/jwt/json_token.c \
1233src/core/lib/security/credentials/jwt/json_token.h \
1234src/core/lib/security/credentials/jwt/jwt_credentials.c \
1235src/core/lib/security/credentials/jwt/jwt_credentials.h \
1236src/core/lib/security/credentials/jwt/jwt_verifier.c \
1237src/core/lib/security/credentials/jwt/jwt_verifier.h \
1238src/core/lib/security/credentials/oauth2/oauth2_credentials.c \
1239src/core/lib/security/credentials/oauth2/oauth2_credentials.h \
1240src/core/lib/security/credentials/plugin/plugin_credentials.c \
1241src/core/lib/security/credentials/plugin/plugin_credentials.h \
1242src/core/lib/security/credentials/ssl/ssl_credentials.c \
1243src/core/lib/security/credentials/ssl/ssl_credentials.h \
1244src/core/lib/security/transport/auth_filters.h \
1245src/core/lib/security/transport/client_auth_filter.c \
David Garcia Quintas01291502017-02-07 13:26:41 -08001246src/core/lib/security/transport/lb_targets_info.c \
1247src/core/lib/security/transport/lb_targets_info.h \
Craig Tilleraa272bc2017-01-10 12:48:52 -08001248src/core/lib/security/transport/secure_endpoint.c \
1249src/core/lib/security/transport/secure_endpoint.h \
1250src/core/lib/security/transport/security_connector.c \
1251src/core/lib/security/transport/security_connector.h \
1252src/core/lib/security/transport/security_handshaker.c \
1253src/core/lib/security/transport/security_handshaker.h \
1254src/core/lib/security/transport/server_auth_filter.c \
1255src/core/lib/security/transport/tsi_error.c \
1256src/core/lib/security/transport/tsi_error.h \
Craig Tilleraa272bc2017-01-10 12:48:52 -08001257src/core/lib/security/util/json_util.c \
1258src/core/lib/security/util/json_util.h \
Craig Tiller790f6af2017-03-30 12:39:24 -07001259src/core/lib/slice/b64.c \
1260src/core/lib/slice/b64.h \
Craig Tilleraa272bc2017-01-10 12:48:52 -08001261src/core/lib/slice/percent_encoding.c \
1262src/core/lib/slice/percent_encoding.h \
1263src/core/lib/slice/slice.c \
1264src/core/lib/slice/slice_buffer.c \
Craig Tiller7c70b6c2017-01-23 07:48:42 -08001265src/core/lib/slice/slice_hash_table.c \
1266src/core/lib/slice/slice_hash_table.h \
1267src/core/lib/slice/slice_intern.c \
Craig Tilleraa272bc2017-01-10 12:48:52 -08001268src/core/lib/slice/slice_internal.h \
1269src/core/lib/slice/slice_string_helpers.c \
1270src/core/lib/slice/slice_string_helpers.h \
Craig Tillerf23078c2016-03-25 17:07:29 -07001271src/core/lib/support/alloc.c \
Craig Tiller9202b3f2017-03-12 22:30:38 -07001272src/core/lib/support/arena.c \
1273src/core/lib/support/arena.h \
Mark D. Rothfecba532017-03-17 09:50:48 -07001274src/core/lib/support/atm.c \
Craig Tiller4d780a52017-04-12 13:47:18 -07001275src/core/lib/support/atomic.h \
1276src/core/lib/support/atomic_with_atm.h \
1277src/core/lib/support/atomic_with_std.h \
Craig Tillerf23078c2016-03-25 17:07:29 -07001278src/core/lib/support/avl.c \
1279src/core/lib/support/backoff.c \
Craig Tilleraa272bc2017-01-10 12:48:52 -08001280src/core/lib/support/backoff.h \
1281src/core/lib/support/block_annotate.h \
Craig Tillerf23078c2016-03-25 17:07:29 -07001282src/core/lib/support/cmdline.c \
1283src/core/lib/support/cpu_iphone.c \
1284src/core/lib/support/cpu_linux.c \
1285src/core/lib/support/cpu_posix.c \
1286src/core/lib/support/cpu_windows.c \
Craig Tilleraa272bc2017-01-10 12:48:52 -08001287src/core/lib/support/env.h \
Craig Tillerf23078c2016-03-25 17:07:29 -07001288src/core/lib/support/env_linux.c \
1289src/core/lib/support/env_posix.c \
Yuchen Zeng12dfdc32016-04-26 22:05:41 -07001290src/core/lib/support/env_windows.c \
Craig Tillerf23078c2016-03-25 17:07:29 -07001291src/core/lib/support/histogram.c \
1292src/core/lib/support/host_port.c \
Craig Tillerf23078c2016-03-25 17:07:29 -07001293src/core/lib/support/log.c \
1294src/core/lib/support/log_android.c \
1295src/core/lib/support/log_linux.c \
1296src/core/lib/support/log_posix.c \
Yuchen Zeng12dfdc32016-04-26 22:05:41 -07001297src/core/lib/support/log_windows.c \
Craig Tillerb3d70102017-03-31 14:17:09 -07001298src/core/lib/support/memory.h \
Craig Tiller57726ca2016-09-12 11:59:45 -07001299src/core/lib/support/mpscq.c \
Craig Tilleraa272bc2017-01-10 12:48:52 -08001300src/core/lib/support/mpscq.h \
Craig Tillerf23078c2016-03-25 17:07:29 -07001301src/core/lib/support/murmur_hash.c \
Craig Tilleraa272bc2017-01-10 12:48:52 -08001302src/core/lib/support/murmur_hash.h \
Craig Tilleredbf2b92017-02-27 07:24:00 -08001303src/core/lib/support/spinlock.h \
Craig Tillerf23078c2016-03-25 17:07:29 -07001304src/core/lib/support/stack_lockfree.c \
Craig Tilleraa272bc2017-01-10 12:48:52 -08001305src/core/lib/support/stack_lockfree.h \
Craig Tillerf23078c2016-03-25 17:07:29 -07001306src/core/lib/support/string.c \
Craig Tilleraa272bc2017-01-10 12:48:52 -08001307src/core/lib/support/string.h \
Craig Tillerf23078c2016-03-25 17:07:29 -07001308src/core/lib/support/string_posix.c \
Yuchen Zeng4594bd92016-05-31 14:06:01 -07001309src/core/lib/support/string_util_windows.c \
Yuchen Zeng12dfdc32016-04-26 22:05:41 -07001310src/core/lib/support/string_windows.c \
Craig Tilleraa272bc2017-01-10 12:48:52 -08001311src/core/lib/support/string_windows.h \
Craig Tillerf23078c2016-03-25 17:07:29 -07001312src/core/lib/support/subprocess_posix.c \
1313src/core/lib/support/subprocess_windows.c \
1314src/core/lib/support/sync.c \
1315src/core/lib/support/sync_posix.c \
Yuchen Zeng12dfdc32016-04-26 22:05:41 -07001316src/core/lib/support/sync_windows.c \
Craig Tillerf23078c2016-03-25 17:07:29 -07001317src/core/lib/support/thd.c \
Craig Tilleraa272bc2017-01-10 12:48:52 -08001318src/core/lib/support/thd_internal.h \
Craig Tillerf23078c2016-03-25 17:07:29 -07001319src/core/lib/support/thd_posix.c \
Yuchen Zeng12dfdc32016-04-26 22:05:41 -07001320src/core/lib/support/thd_windows.c \
Craig Tillerf23078c2016-03-25 17:07:29 -07001321src/core/lib/support/time.c \
1322src/core/lib/support/time_posix.c \
1323src/core/lib/support/time_precise.c \
Craig Tilleraa272bc2017-01-10 12:48:52 -08001324src/core/lib/support/time_precise.h \
Yuchen Zeng12dfdc32016-04-26 22:05:41 -07001325src/core/lib/support/time_windows.c \
Craig Tillerf23078c2016-03-25 17:07:29 -07001326src/core/lib/support/tls_pthread.c \
Craig Tilleraa272bc2017-01-10 12:48:52 -08001327src/core/lib/support/tmpfile.h \
Nicolas "Pixel" Noblec4b18a52016-04-15 04:53:54 +02001328src/core/lib/support/tmpfile_msys.c \
Craig Tillerf23078c2016-03-25 17:07:29 -07001329src/core/lib/support/tmpfile_posix.c \
Yuchen Zeng12dfdc32016-04-26 22:05:41 -07001330src/core/lib/support/tmpfile_windows.c \
Craig Tillere519a032017-01-06 12:41:21 -08001331src/core/lib/support/wrap_memcpy.c \
ncteisen7429fd52017-01-09 15:26:05 -08001332src/core/lib/surface/README.md \
Craig Tilleraa272bc2017-01-10 12:48:52 -08001333src/core/lib/surface/alarm.c \
1334src/core/lib/surface/api_trace.c \
1335src/core/lib/surface/api_trace.h \
1336src/core/lib/surface/byte_buffer.c \
1337src/core/lib/surface/byte_buffer_reader.c \
1338src/core/lib/surface/call.c \
1339src/core/lib/surface/call.h \
1340src/core/lib/surface/call_details.c \
1341src/core/lib/surface/call_log_batch.c \
1342src/core/lib/surface/call_test_only.h \
1343src/core/lib/surface/channel.c \
1344src/core/lib/surface/channel.h \
1345src/core/lib/surface/channel_init.c \
1346src/core/lib/surface/channel_init.h \
1347src/core/lib/surface/channel_ping.c \
1348src/core/lib/surface/channel_stack_type.c \
1349src/core/lib/surface/channel_stack_type.h \
1350src/core/lib/surface/completion_queue.c \
1351src/core/lib/surface/completion_queue.h \
Sree Kuchibhotlabf184282017-03-21 15:18:58 -07001352src/core/lib/surface/completion_queue_factory.c \
1353src/core/lib/surface/completion_queue_factory.h \
Craig Tilleraa272bc2017-01-10 12:48:52 -08001354src/core/lib/surface/event_string.c \
1355src/core/lib/surface/event_string.h \
1356src/core/lib/surface/init.c \
1357src/core/lib/surface/init.h \
1358src/core/lib/surface/init_secure.c \
Craig Tiller8ebb5442017-04-07 16:01:55 -07001359src/core/lib/surface/lame_client.cc \
Craig Tilleraa272bc2017-01-10 12:48:52 -08001360src/core/lib/surface/lame_client.h \
1361src/core/lib/surface/metadata_array.c \
1362src/core/lib/surface/server.c \
1363src/core/lib/surface/server.h \
1364src/core/lib/surface/validate_metadata.c \
Craig Tiller5ffd7662017-01-10 15:28:25 -08001365src/core/lib/surface/validate_metadata.h \
Craig Tilleraa272bc2017-01-10 12:48:52 -08001366src/core/lib/surface/version.c \
ncteisen7429fd52017-01-09 15:26:05 -08001367src/core/lib/transport/README.md \
Craig Tillerd4257122017-01-13 09:33:57 -08001368src/core/lib/transport/bdp_estimator.c \
1369src/core/lib/transport/bdp_estimator.h \
Craig Tilleraa272bc2017-01-10 12:48:52 -08001370src/core/lib/transport/byte_stream.c \
1371src/core/lib/transport/byte_stream.h \
1372src/core/lib/transport/connectivity_state.c \
1373src/core/lib/transport/connectivity_state.h \
Craig Tiller7c70b6c2017-01-23 07:48:42 -08001374src/core/lib/transport/error_utils.c \
1375src/core/lib/transport/error_utils.h \
1376src/core/lib/transport/http2_errors.h \
Craig Tilleraa272bc2017-01-10 12:48:52 -08001377src/core/lib/transport/metadata.c \
1378src/core/lib/transport/metadata.h \
1379src/core/lib/transport/metadata_batch.c \
1380src/core/lib/transport/metadata_batch.h \
1381src/core/lib/transport/pid_controller.c \
1382src/core/lib/transport/pid_controller.h \
1383src/core/lib/transport/service_config.c \
1384src/core/lib/transport/service_config.h \
1385src/core/lib/transport/static_metadata.c \
1386src/core/lib/transport/static_metadata.h \
Craig Tiller7c70b6c2017-01-23 07:48:42 -08001387src/core/lib/transport/status_conversion.c \
1388src/core/lib/transport/status_conversion.h \
Craig Tilleraa272bc2017-01-10 12:48:52 -08001389src/core/lib/transport/timeout_encoding.c \
1390src/core/lib/transport/timeout_encoding.h \
1391src/core/lib/transport/transport.c \
1392src/core/lib/transport/transport.h \
1393src/core/lib/transport/transport_impl.h \
1394src/core/lib/transport/transport_op_string.c \
Craig Tilleraa272bc2017-01-10 12:48:52 -08001395src/core/plugin_registry/grpc_plugin_registry.c \
Craig Tiller134fed32017-03-28 14:27:18 -07001396src/core/tsi/README.md \
1397src/core/tsi/fake_transport_security.c \
1398src/core/tsi/fake_transport_security.h \
1399src/core/tsi/ssl_transport_security.c \
1400src/core/tsi/ssl_transport_security.h \
1401src/core/tsi/ssl_types.h \
1402src/core/tsi/transport_security.c \
1403src/core/tsi/transport_security.h \
jiangtaoli2016e69881d2017-04-10 14:29:43 -07001404src/core/tsi/transport_security_adapter.c \
1405src/core/tsi/transport_security_adapter.h \
Craig Tiller134fed32017-03-28 14:27:18 -07001406src/core/tsi/transport_security_interface.h \
Craig Tilleraa272bc2017-01-10 12:48:52 -08001407third_party/nanopb/pb.h \
1408third_party/nanopb/pb_common.c \
1409third_party/nanopb/pb_common.h \
1410third_party/nanopb/pb_decode.c \
1411third_party/nanopb/pb_decode.h \
1412third_party/nanopb/pb_encode.c \
1413third_party/nanopb/pb_encode.h
Craig Tiller6c4ae602015-05-28 08:41:41 -07001414
1415# This tag can be used to specify the character encoding of the source files
1416# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
1417# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
1418# documentation (see: http://www.gnu.org/software/libiconv) for the list of
1419# possible encodings.
1420# The default value is: UTF-8.
1421
1422INPUT_ENCODING = UTF-8
1423
1424# If the value of the INPUT tag contains directories, you can use the
1425# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
1426# *.h) to filter out the source-files in the directories. If left blank the
1427# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii,
1428# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,
1429# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,
1430# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
1431# *.qsf, *.as and *.js.
1432
1433FILE_PATTERNS =
1434
1435# The RECURSIVE tag can be used to specify whether or not subdirectories should
1436# be searched for input files as well.
1437# The default value is: NO.
1438
1439RECURSIVE = NO
1440
1441# The EXCLUDE tag can be used to specify files and/or directories that should be
1442# excluded from the INPUT source files. This way you can easily exclude a
1443# subdirectory from a directory tree whose root is specified with the INPUT tag.
1444#
1445# Note that relative paths are relative to the directory from which doxygen is
1446# run.
1447
1448EXCLUDE =
1449
1450# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
1451# directories that are symbolic links (a Unix file system feature) are excluded
1452# from the input.
1453# The default value is: NO.
1454
1455EXCLUDE_SYMLINKS = NO
1456
1457# If the value of the INPUT tag contains directories, you can use the
1458# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
1459# certain files from those directories.
1460#
1461# Note that the wildcards are matched against the file with absolute path, so to
1462# exclude all test directories for example use the pattern */test/*
1463
1464EXCLUDE_PATTERNS =
1465
1466# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
1467# (namespaces, classes, functions, etc.) that should be excluded from the
1468# output. The symbol name can be a fully qualified name, a word, or if the
1469# wildcard * is used, a substring. Examples: ANamespace, AClass,
1470# AClass::ANamespace, ANamespace::*Test
1471#
1472# Note that the wildcards are matched against the file with absolute path, so to
1473# exclude all test directories use the pattern */test/*
1474
1475EXCLUDE_SYMBOLS =
1476
1477# The EXAMPLE_PATH tag can be used to specify one or more files or directories
1478# that contain example code fragments that are included (see the \include
1479# command).
1480
1481EXAMPLE_PATH =
1482
1483# If the value of the EXAMPLE_PATH tag contains directories, you can use the
1484# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
1485# *.h) to filter out the source-files in the directories. If left blank all
1486# files are included.
1487
1488EXAMPLE_PATTERNS =
1489
1490# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
1491# searched for input files to be used with the \include or \dontinclude commands
1492# irrespective of the value of the RECURSIVE tag.
1493# The default value is: NO.
1494
1495EXAMPLE_RECURSIVE = NO
1496
1497# The IMAGE_PATH tag can be used to specify one or more files or directories
1498# that contain images that are to be included in the documentation (see the
1499# \image command).
1500
1501IMAGE_PATH =
1502
1503# The INPUT_FILTER tag can be used to specify a program that doxygen should
1504# invoke to filter for each input file. Doxygen will invoke the filter program
1505# by executing (via popen()) the command:
1506#
1507# <filter> <input-file>
1508#
1509# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
1510# name of an input file. Doxygen will then use the output that the filter
1511# program writes to standard output. If FILTER_PATTERNS is specified, this tag
1512# will be ignored.
1513#
1514# Note that the filter must not add or remove lines; it is applied before the
1515# code is scanned, but not when the output code is generated. If lines are added
1516# or removed, the anchors will not be placed correctly.
1517
1518INPUT_FILTER =
1519
1520# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
1521# basis. Doxygen will compare the file name with each pattern and apply the
1522# filter if there is a match. The filters are a list of the form: pattern=filter
1523# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
1524# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
1525# patterns match the file name, INPUT_FILTER is applied.
1526
1527FILTER_PATTERNS =
1528
1529# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
1530# INPUT_FILTER) will also be used to filter the input files that are used for
1531# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
1532# The default value is: NO.
1533
1534FILTER_SOURCE_FILES = NO
1535
1536# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
1537# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
1538# it is also possible to disable source filtering for a specific pattern using
1539# *.ext= (so without naming a filter).
1540# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
1541
1542FILTER_SOURCE_PATTERNS =
1543
1544# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
1545# is part of the input, its contents will be placed on the main page
1546# (index.html). This can be useful if you have a project on for instance GitHub
1547# and want to reuse the introduction page also for the doxygen output.
1548
1549USE_MDFILE_AS_MAINPAGE =
1550
1551#---------------------------------------------------------------------------
1552# Configuration options related to source browsing
1553#---------------------------------------------------------------------------
1554
1555# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
1556# generated. Documented entities will be cross-referenced with these sources.
1557#
1558# Note: To get rid of all source code in the generated output, make sure that
1559# also VERBATIM_HEADERS is set to NO.
1560# The default value is: NO.
1561
1562SOURCE_BROWSER = NO
1563
1564# Setting the INLINE_SOURCES tag to YES will include the body of functions,
1565# classes and enums directly into the documentation.
1566# The default value is: NO.
1567
1568INLINE_SOURCES = NO
1569
1570# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
1571# special comment blocks from generated source code fragments. Normal C, C++ and
1572# Fortran comments will always remain visible.
1573# The default value is: YES.
1574
1575STRIP_CODE_COMMENTS = YES
1576
1577# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
1578# function all documented functions referencing it will be listed.
1579# The default value is: NO.
1580
1581REFERENCED_BY_RELATION = NO
1582
1583# If the REFERENCES_RELATION tag is set to YES then for each documented function
1584# all documented entities called/used by that function will be listed.
1585# The default value is: NO.
1586
1587REFERENCES_RELATION = NO
1588
1589# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
1590# to YES then the hyperlinks from functions in REFERENCES_RELATION and
1591# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
1592# link to the documentation.
1593# The default value is: YES.
1594
1595REFERENCES_LINK_SOURCE = YES
1596
1597# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
1598# source code will show a tooltip with additional information such as prototype,
1599# brief description and links to the definition and documentation. Since this
1600# will make the HTML file larger and loading of large files a bit slower, you
1601# can opt to disable this feature.
1602# The default value is: YES.
1603# This tag requires that the tag SOURCE_BROWSER is set to YES.
1604
1605SOURCE_TOOLTIPS = YES
1606
1607# If the USE_HTAGS tag is set to YES then the references to source code will
1608# point to the HTML generated by the htags(1) tool instead of doxygen built-in
1609# source browser. The htags tool is part of GNU's global source tagging system
1610# (see http://www.gnu.org/software/global/global.html). You will need version
1611# 4.8.6 or higher.
1612#
1613# To use it do the following:
1614# - Install the latest version of global
1615# - Enable SOURCE_BROWSER and USE_HTAGS in the config file
1616# - Make sure the INPUT points to the root of the source tree
1617# - Run doxygen as normal
1618#
1619# Doxygen will invoke htags (and that will in turn invoke gtags), so these
1620# tools must be available from the command line (i.e. in the search path).
1621#
1622# The result: instead of the source browser generated by doxygen, the links to
1623# source code will now point to the output of htags.
1624# The default value is: NO.
1625# This tag requires that the tag SOURCE_BROWSER is set to YES.
1626
1627USE_HTAGS = NO
1628
1629# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
1630# verbatim copy of the header file for each class for which an include is
1631# specified. Set to NO to disable this.
1632# See also: Section \class.
1633# The default value is: YES.
1634
1635VERBATIM_HEADERS = YES
1636
1637#---------------------------------------------------------------------------
1638# Configuration options related to the alphabetical class index
1639#---------------------------------------------------------------------------
1640
1641# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1642# compounds will be generated. Enable this if the project contains a lot of
1643# classes, structs, unions or interfaces.
1644# The default value is: YES.
1645
1646ALPHABETICAL_INDEX = YES
1647
1648# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
1649# which the alphabetical index list will be split.
1650# Minimum value: 1, maximum value: 20, default value: 5.
1651# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1652
1653COLS_IN_ALPHA_INDEX = 5
1654
1655# In case all classes in a project start with a common prefix, all classes will
1656# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
1657# can be used to specify a prefix (or a list of prefixes) that should be ignored
1658# while generating the index headers.
1659# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1660
1661IGNORE_PREFIX =
1662
1663#---------------------------------------------------------------------------
1664# Configuration options related to the HTML output
1665#---------------------------------------------------------------------------
1666
1667# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
1668# The default value is: YES.
1669
1670GENERATE_HTML = YES
1671
1672# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1673# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1674# it.
1675# The default directory is: html.
1676# This tag requires that the tag GENERATE_HTML is set to YES.
1677
1678HTML_OUTPUT = html
1679
1680# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1681# generated HTML page (for example: .htm, .php, .asp).
1682# The default value is: .html.
1683# This tag requires that the tag GENERATE_HTML is set to YES.
1684
1685HTML_FILE_EXTENSION = .html
1686
1687# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1688# each generated HTML page. If the tag is left blank doxygen will generate a
1689# standard header.
1690#
1691# To get valid HTML the header file that includes any scripts and style sheets
1692# that doxygen needs, which is dependent on the configuration options used (e.g.
1693# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1694# default header using
1695# doxygen -w html new_header.html new_footer.html new_stylesheet.css
1696# YourConfigFile
1697# and then modify the file new_header.html. See also section "Doxygen usage"
1698# for information on how to generate the default header that doxygen normally
1699# uses.
1700# Note: The header is subject to change so you typically have to regenerate the
1701# default header when upgrading to a newer version of doxygen. For a description
1702# of the possible markers and block names see the documentation.
1703# This tag requires that the tag GENERATE_HTML is set to YES.
1704
1705HTML_HEADER =
1706
1707# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1708# generated HTML page. If the tag is left blank doxygen will generate a standard
1709# footer. See HTML_HEADER for more information on how to generate a default
1710# footer and what special commands can be used inside the footer. See also
1711# section "Doxygen usage" for information on how to generate the default footer
1712# that doxygen normally uses.
1713# This tag requires that the tag GENERATE_HTML is set to YES.
1714
1715HTML_FOOTER =
1716
1717# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1718# sheet that is used by each HTML page. It can be used to fine-tune the look of
1719# the HTML output. If left blank doxygen will generate a default style sheet.
1720# See also section "Doxygen usage" for information on how to generate the style
1721# sheet that doxygen normally uses.
1722# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1723# it is more robust and this tag (HTML_STYLESHEET) will in the future become
1724# obsolete.
1725# This tag requires that the tag GENERATE_HTML is set to YES.
1726
1727HTML_STYLESHEET =
1728
1729# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1730# cascading style sheets that are included after the standard style sheets
1731# created by doxygen. Using this option one can overrule certain style aspects.
1732# This is preferred over using HTML_STYLESHEET since it does not replace the
1733# standard style sheet and is therefore more robust against future updates.
1734# Doxygen will copy the style sheet files to the output directory.
1735# Note: The order of the extra style sheet files is of importance (e.g. the last
1736# style sheet in the list overrules the setting of the previous ones in the
1737# list). For an example see the documentation.
1738# This tag requires that the tag GENERATE_HTML is set to YES.
1739
1740HTML_EXTRA_STYLESHEET =
1741
1742# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1743# other source files which should be copied to the HTML output directory. Note
1744# that these files will be copied to the base HTML output directory. Use the
1745# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1746# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1747# files will be copied as-is; there are no commands or markers available.
1748# This tag requires that the tag GENERATE_HTML is set to YES.
1749
1750HTML_EXTRA_FILES =
1751
1752# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
1753# will adjust the colors in the style sheet and background images according to
1754# this color. Hue is specified as an angle on a colorwheel, see
1755# http://en.wikipedia.org/wiki/Hue for more information. For instance the value
1756# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
1757# purple, and 360 is red again.
1758# Minimum value: 0, maximum value: 359, default value: 220.
1759# This tag requires that the tag GENERATE_HTML is set to YES.
1760
1761HTML_COLORSTYLE_HUE = 220
1762
1763# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
1764# in the HTML output. For a value of 0 the output will use grayscales only. A
1765# value of 255 will produce the most vivid colors.
1766# Minimum value: 0, maximum value: 255, default value: 100.
1767# This tag requires that the tag GENERATE_HTML is set to YES.
1768
1769HTML_COLORSTYLE_SAT = 100
1770
1771# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1772# luminance component of the colors in the HTML output. Values below 100
1773# gradually make the output lighter, whereas values above 100 make the output
1774# darker. The value divided by 100 is the actual gamma applied, so 80 represents
1775# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1776# change the gamma.
1777# Minimum value: 40, maximum value: 240, default value: 80.
1778# This tag requires that the tag GENERATE_HTML is set to YES.
1779
1780HTML_COLORSTYLE_GAMMA = 80
1781
1782# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1783# page will contain the date and time when the page was generated. Setting this
1784# to NO can help when comparing the output of multiple runs.
1785# The default value is: YES.
1786# This tag requires that the tag GENERATE_HTML is set to YES.
1787
1788HTML_TIMESTAMP = YES
1789
1790# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1791# documentation will contain sections that can be hidden and shown after the
1792# page has loaded.
1793# The default value is: NO.
1794# This tag requires that the tag GENERATE_HTML is set to YES.
1795
1796HTML_DYNAMIC_SECTIONS = NO
1797
1798# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
1799# shown in the various tree structured indices initially; the user can expand
1800# and collapse entries dynamically later on. Doxygen will expand the tree to
1801# such a level that at most the specified number of entries are visible (unless
1802# a fully collapsed tree already exceeds this amount). So setting the number of
1803# entries 1 will produce a full collapsed tree by default. 0 is a special value
1804# representing an infinite number of entries and will result in a full expanded
1805# tree by default.
1806# Minimum value: 0, maximum value: 9999, default value: 100.
1807# This tag requires that the tag GENERATE_HTML is set to YES.
1808
1809HTML_INDEX_NUM_ENTRIES = 100
1810
1811# If the GENERATE_DOCSET tag is set to YES, additional index files will be
1812# generated that can be used as input for Apple's Xcode 3 integrated development
1813# environment (see: http://developer.apple.com/tools/xcode/), introduced with
1814# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
1815# Makefile in the HTML output directory. Running make will produce the docset in
1816# that directory and running make install will install the docset in
1817# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1818# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
1819# for more information.
1820# The default value is: NO.
1821# This tag requires that the tag GENERATE_HTML is set to YES.
1822
1823GENERATE_DOCSET = NO
1824
1825# This tag determines the name of the docset feed. A documentation feed provides
1826# an umbrella under which multiple documentation sets from a single provider
1827# (such as a company or product suite) can be grouped.
1828# The default value is: Doxygen generated docs.
1829# This tag requires that the tag GENERATE_DOCSET is set to YES.
1830
1831DOCSET_FEEDNAME = "Doxygen generated docs"
1832
1833# This tag specifies a string that should uniquely identify the documentation
1834# set bundle. This should be a reverse domain-name style string, e.g.
1835# com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1836# The default value is: org.doxygen.Project.
1837# This tag requires that the tag GENERATE_DOCSET is set to YES.
1838
1839DOCSET_BUNDLE_ID = org.doxygen.Project
1840
1841# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1842# the documentation publisher. This should be a reverse domain-name style
1843# string, e.g. com.mycompany.MyDocSet.documentation.
1844# The default value is: org.doxygen.Publisher.
1845# This tag requires that the tag GENERATE_DOCSET is set to YES.
1846
1847DOCSET_PUBLISHER_ID = org.doxygen.Publisher
1848
1849# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1850# The default value is: Publisher.
1851# This tag requires that the tag GENERATE_DOCSET is set to YES.
1852
1853DOCSET_PUBLISHER_NAME = Publisher
1854
1855# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1856# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1857# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1858# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
1859# Windows.
1860#
1861# The HTML Help Workshop contains a compiler that can convert all HTML output
1862# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1863# files are now used as the Windows 98 help format, and will replace the old
1864# Windows help format (.hlp) on all Windows platforms in the future. Compressed
1865# HTML files also contain an index, a table of contents, and you can search for
1866# words in the documentation. The HTML workshop also contains a viewer for
1867# compressed HTML files.
1868# The default value is: NO.
1869# This tag requires that the tag GENERATE_HTML is set to YES.
1870
1871GENERATE_HTMLHELP = NO
1872
1873# The CHM_FILE tag can be used to specify the file name of the resulting .chm
1874# file. You can add a path in front of the file if the result should not be
1875# written to the html output directory.
1876# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1877
1878CHM_FILE =
1879
1880# The HHC_LOCATION tag can be used to specify the location (absolute path
1881# including file name) of the HTML help compiler (hhc.exe). If non-empty,
1882# doxygen will try to run the HTML help compiler on the generated index.hhp.
1883# The file has to be specified with full path.
1884# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1885
1886HHC_LOCATION =
1887
1888# The GENERATE_CHI flag controls if a separate .chi index file is generated
1889# (YES) or that it should be included in the master .chm file (NO).
1890# The default value is: NO.
1891# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1892
1893GENERATE_CHI = NO
1894
1895# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
1896# and project file content.
1897# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1898
1899CHM_INDEX_ENCODING =
1900
1901# The BINARY_TOC flag controls whether a binary table of contents is generated
1902# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
1903# enables the Previous and Next buttons.
1904# The default value is: NO.
1905# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1906
1907BINARY_TOC = NO
1908
1909# The TOC_EXPAND flag can be set to YES to add extra items for group members to
1910# the table of contents of the HTML help documentation and to the tree view.
1911# The default value is: NO.
1912# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1913
1914TOC_EXPAND = NO
1915
1916# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1917# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1918# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1919# (.qch) of the generated HTML documentation.
1920# The default value is: NO.
1921# This tag requires that the tag GENERATE_HTML is set to YES.
1922
1923GENERATE_QHP = NO
1924
1925# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1926# the file name of the resulting .qch file. The path specified is relative to
1927# the HTML output folder.
1928# This tag requires that the tag GENERATE_QHP is set to YES.
1929
1930QCH_FILE =
1931
1932# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1933# Project output. For more information please see Qt Help Project / Namespace
1934# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
1935# The default value is: org.doxygen.Project.
1936# This tag requires that the tag GENERATE_QHP is set to YES.
1937
1938QHP_NAMESPACE = org.doxygen.Project
1939
1940# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1941# Help Project output. For more information please see Qt Help Project / Virtual
1942# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
1943# folders).
1944# The default value is: doc.
1945# This tag requires that the tag GENERATE_QHP is set to YES.
1946
1947QHP_VIRTUAL_FOLDER = doc
1948
1949# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1950# filter to add. For more information please see Qt Help Project / Custom
1951# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1952# filters).
1953# This tag requires that the tag GENERATE_QHP is set to YES.
1954
1955QHP_CUST_FILTER_NAME =
1956
1957# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
1958# custom filter to add. For more information please see Qt Help Project / Custom
1959# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1960# filters).
1961# This tag requires that the tag GENERATE_QHP is set to YES.
1962
1963QHP_CUST_FILTER_ATTRS =
1964
1965# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1966# project's filter section matches. Qt Help Project / Filter Attributes (see:
1967# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
1968# This tag requires that the tag GENERATE_QHP is set to YES.
1969
1970QHP_SECT_FILTER_ATTRS =
1971
1972# The QHG_LOCATION tag can be used to specify the location of Qt's
1973# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
1974# generated .qhp file.
1975# This tag requires that the tag GENERATE_QHP is set to YES.
1976
1977QHG_LOCATION =
1978
1979# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1980# generated, together with the HTML files, they form an Eclipse help plugin. To
1981# install this plugin and make it available under the help contents menu in
1982# Eclipse, the contents of the directory containing the HTML and XML files needs
1983# to be copied into the plugins directory of eclipse. The name of the directory
1984# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1985# After copying Eclipse needs to be restarted before the help appears.
1986# The default value is: NO.
1987# This tag requires that the tag GENERATE_HTML is set to YES.
1988
1989GENERATE_ECLIPSEHELP = NO
1990
1991# A unique identifier for the Eclipse help plugin. When installing the plugin
1992# the directory name containing the HTML and XML files should also have this
1993# name. Each documentation set should have its own identifier.
1994# The default value is: org.doxygen.Project.
1995# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1996
1997ECLIPSE_DOC_ID = org.doxygen.Project
1998
1999# If you want full control over the layout of the generated HTML pages it might
2000# be necessary to disable the index and replace it with your own. The
2001# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
2002# of each HTML page. A value of NO enables the index and the value YES disables
2003# it. Since the tabs in the index contain the same information as the navigation
2004# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
2005# The default value is: NO.
2006# This tag requires that the tag GENERATE_HTML is set to YES.
2007
2008DISABLE_INDEX = NO
2009
2010# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
2011# structure should be generated to display hierarchical information. If the tag
2012# value is set to YES, a side panel will be generated containing a tree-like
2013# index structure (just like the one that is generated for HTML Help). For this
2014# to work a browser that supports JavaScript, DHTML, CSS and frames is required
2015# (i.e. any modern browser). Windows users are probably better off using the
2016# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
2017# further fine-tune the look of the index. As an example, the default style
2018# sheet generated by doxygen has an example that shows how to put an image at
2019# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
2020# the same information as the tab index, you could consider setting
2021# DISABLE_INDEX to YES when enabling this option.
2022# The default value is: NO.
2023# This tag requires that the tag GENERATE_HTML is set to YES.
2024
2025GENERATE_TREEVIEW = NO
2026
2027# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
2028# doxygen will group on one line in the generated HTML documentation.
2029#
2030# Note that a value of 0 will completely suppress the enum values from appearing
2031# in the overview section.
2032# Minimum value: 0, maximum value: 20, default value: 4.
2033# This tag requires that the tag GENERATE_HTML is set to YES.
2034
2035ENUM_VALUES_PER_LINE = 4
2036
2037# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
2038# to set the initial width (in pixels) of the frame in which the tree is shown.
2039# Minimum value: 0, maximum value: 1500, default value: 250.
2040# This tag requires that the tag GENERATE_HTML is set to YES.
2041
2042TREEVIEW_WIDTH = 250
2043
2044# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
2045# external symbols imported via tag files in a separate window.
2046# The default value is: NO.
2047# This tag requires that the tag GENERATE_HTML is set to YES.
2048
2049EXT_LINKS_IN_WINDOW = NO
2050
2051# Use this tag to change the font size of LaTeX formulas included as images in
2052# the HTML documentation. When you change the font size after a successful
2053# doxygen run you need to manually remove any form_*.png images from the HTML
2054# output directory to force them to be regenerated.
2055# Minimum value: 8, maximum value: 50, default value: 10.
2056# This tag requires that the tag GENERATE_HTML is set to YES.
2057
2058FORMULA_FONTSIZE = 10
2059
2060# Use the FORMULA_TRANPARENT tag to determine whether or not the images
2061# generated for formulas are transparent PNGs. Transparent PNGs are not
2062# supported properly for IE 6.0, but are supported on all modern browsers.
2063#
2064# Note that when changing this option you need to delete any form_*.png files in
2065# the HTML output directory before the changes have effect.
2066# The default value is: YES.
2067# This tag requires that the tag GENERATE_HTML is set to YES.
2068
2069FORMULA_TRANSPARENT = YES
2070
2071# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
2072# http://www.mathjax.org) which uses client side Javascript for the rendering
2073# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
2074# installed or if you want to formulas look prettier in the HTML output. When
2075# enabled you may also need to install MathJax separately and configure the path
2076# to it using the MATHJAX_RELPATH option.
2077# The default value is: NO.
2078# This tag requires that the tag GENERATE_HTML is set to YES.
2079
2080USE_MATHJAX = NO
2081
2082# When MathJax is enabled you can set the default output format to be used for
2083# the MathJax output. See the MathJax site (see:
2084# http://docs.mathjax.org/en/latest/output.html) for more details.
2085# Possible values are: HTML-CSS (which is slower, but has the best
2086# compatibility), NativeMML (i.e. MathML) and SVG.
2087# The default value is: HTML-CSS.
2088# This tag requires that the tag USE_MATHJAX is set to YES.
2089
2090MATHJAX_FORMAT = HTML-CSS
2091
2092# When MathJax is enabled you need to specify the location relative to the HTML
2093# output directory using the MATHJAX_RELPATH option. The destination directory
2094# should contain the MathJax.js script. For instance, if the mathjax directory
2095# is located at the same level as the HTML output directory, then
2096# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
2097# Content Delivery Network so you can quickly see the result without installing
2098# MathJax. However, it is strongly recommended to install a local copy of
2099# MathJax from http://www.mathjax.org before deployment.
2100# The default value is: http://cdn.mathjax.org/mathjax/latest.
2101# This tag requires that the tag USE_MATHJAX is set to YES.
2102
2103MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
2104
2105# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
2106# extension names that should be enabled during MathJax rendering. For example
2107# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
2108# This tag requires that the tag USE_MATHJAX is set to YES.
2109
2110MATHJAX_EXTENSIONS =
2111
2112# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
2113# of code that will be used on startup of the MathJax code. See the MathJax site
2114# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
2115# example see the documentation.
2116# This tag requires that the tag USE_MATHJAX is set to YES.
2117
2118MATHJAX_CODEFILE =
2119
2120# When the SEARCHENGINE tag is enabled doxygen will generate a search box for
2121# the HTML output. The underlying search engine uses javascript and DHTML and
2122# should work on any modern browser. Note that when using HTML help
2123# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
2124# there is already a search function so this one should typically be disabled.
2125# For large projects the javascript based search engine can be slow, then
2126# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
2127# search using the keyboard; to jump to the search box use <access key> + S
2128# (what the <access key> is depends on the OS and browser, but it is typically
2129# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
2130# key> to jump into the search results window, the results can be navigated
2131# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
2132# the search. The filter options can be selected when the cursor is inside the
2133# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
2134# to select a filter and <Enter> or <escape> to activate or cancel the filter
2135# option.
2136# The default value is: YES.
2137# This tag requires that the tag GENERATE_HTML is set to YES.
2138
2139SEARCHENGINE = YES
2140
2141# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
2142# implemented using a web server instead of a web client using Javascript. There
2143# are two flavors of web server based searching depending on the EXTERNAL_SEARCH
2144# setting. When disabled, doxygen will generate a PHP script for searching and
2145# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
2146# and searching needs to be provided by external tools. See the section
2147# "External Indexing and Searching" for details.
2148# The default value is: NO.
2149# This tag requires that the tag SEARCHENGINE is set to YES.
2150
2151SERVER_BASED_SEARCH = NO
2152
2153# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
2154# script for searching. Instead the search results are written to an XML file
2155# which needs to be processed by an external indexer. Doxygen will invoke an
2156# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
2157# search results.
2158#
2159# Doxygen ships with an example indexer (doxyindexer) and search engine
2160# (doxysearch.cgi) which are based on the open source search engine library
2161# Xapian (see: http://xapian.org/).
2162#
2163# See the section "External Indexing and Searching" for details.
2164# The default value is: NO.
2165# This tag requires that the tag SEARCHENGINE is set to YES.
2166
2167EXTERNAL_SEARCH = NO
2168
2169# The SEARCHENGINE_URL should point to a search engine hosted by a web server
2170# which will return the search results when EXTERNAL_SEARCH is enabled.
2171#
2172# Doxygen ships with an example indexer (doxyindexer) and search engine
2173# (doxysearch.cgi) which are based on the open source search engine library
2174# Xapian (see: http://xapian.org/). See the section "External Indexing and
2175# Searching" for details.
2176# This tag requires that the tag SEARCHENGINE is set to YES.
2177
2178SEARCHENGINE_URL =
2179
2180# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
2181# search data is written to a file for indexing by an external tool. With the
2182# SEARCHDATA_FILE tag the name of this file can be specified.
2183# The default file is: searchdata.xml.
2184# This tag requires that the tag SEARCHENGINE is set to YES.
2185
2186SEARCHDATA_FILE = searchdata.xml
2187
2188# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
2189# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
2190# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
2191# projects and redirect the results back to the right project.
2192# This tag requires that the tag SEARCHENGINE is set to YES.
2193
2194EXTERNAL_SEARCH_ID =
2195
2196# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
2197# projects other than the one defined by this configuration file, but that are
2198# all added to the same external search index. Each project needs to have a
2199# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
2200# to a relative location where the documentation can be found. The format is:
2201# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
2202# This tag requires that the tag SEARCHENGINE is set to YES.
2203
2204EXTRA_SEARCH_MAPPINGS =
2205
2206#---------------------------------------------------------------------------
2207# Configuration options related to the LaTeX output
2208#---------------------------------------------------------------------------
2209
2210# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
2211# The default value is: YES.
2212
2213GENERATE_LATEX = NO
2214
2215# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
2216# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2217# it.
2218# The default directory is: latex.
2219# This tag requires that the tag GENERATE_LATEX is set to YES.
2220
2221LATEX_OUTPUT = latex
2222
2223# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
2224# invoked.
2225#
2226# Note that when enabling USE_PDFLATEX this option is only used for generating
2227# bitmaps for formulas in the HTML output, but not in the Makefile that is
2228# written to the output directory.
2229# The default file is: latex.
2230# This tag requires that the tag GENERATE_LATEX is set to YES.
2231
2232LATEX_CMD_NAME = latex
2233
2234# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
2235# index for LaTeX.
2236# The default file is: makeindex.
2237# This tag requires that the tag GENERATE_LATEX is set to YES.
2238
2239MAKEINDEX_CMD_NAME = makeindex
2240
2241# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
2242# documents. This may be useful for small projects and may help to save some
2243# trees in general.
2244# The default value is: NO.
2245# This tag requires that the tag GENERATE_LATEX is set to YES.
2246
2247COMPACT_LATEX = NO
2248
2249# The PAPER_TYPE tag can be used to set the paper type that is used by the
2250# printer.
2251# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
2252# 14 inches) and executive (7.25 x 10.5 inches).
2253# The default value is: a4.
2254# This tag requires that the tag GENERATE_LATEX is set to YES.
2255
2256PAPER_TYPE = a4
2257
2258# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
2259# that should be included in the LaTeX output. To get the times font for
2260# instance you can specify
2261# EXTRA_PACKAGES=times
2262# If left blank no extra packages will be included.
2263# This tag requires that the tag GENERATE_LATEX is set to YES.
2264
2265EXTRA_PACKAGES =
2266
2267# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
2268# generated LaTeX document. The header should contain everything until the first
2269# chapter. If it is left blank doxygen will generate a standard header. See
2270# section "Doxygen usage" for information on how to let doxygen write the
2271# default header to a separate file.
2272#
2273# Note: Only use a user-defined header if you know what you are doing! The
2274# following commands have a special meaning inside the header: $title,
2275# $datetime, $date, $doxygenversion, $projectname, $projectnumber,
2276# $projectbrief, $projectlogo. Doxygen will replace $title with the empty
2277# string, for the replacement values of the other commands the user is referred
2278# to HTML_HEADER.
2279# This tag requires that the tag GENERATE_LATEX is set to YES.
2280
2281LATEX_HEADER =
2282
2283# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
2284# generated LaTeX document. The footer should contain everything after the last
2285# chapter. If it is left blank doxygen will generate a standard footer. See
2286# LATEX_HEADER for more information on how to generate a default footer and what
2287# special commands can be used inside the footer.
2288#
2289# Note: Only use a user-defined footer if you know what you are doing!
2290# This tag requires that the tag GENERATE_LATEX is set to YES.
2291
2292LATEX_FOOTER =
2293
2294# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
2295# LaTeX style sheets that are included after the standard style sheets created
2296# by doxygen. Using this option one can overrule certain style aspects. Doxygen
2297# will copy the style sheet files to the output directory.
2298# Note: The order of the extra style sheet files is of importance (e.g. the last
2299# style sheet in the list overrules the setting of the previous ones in the
2300# list).
2301# This tag requires that the tag GENERATE_LATEX is set to YES.
2302
2303LATEX_EXTRA_STYLESHEET =
2304
2305# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
2306# other source files which should be copied to the LATEX_OUTPUT output
2307# directory. Note that the files will be copied as-is; there are no commands or
2308# markers available.
2309# This tag requires that the tag GENERATE_LATEX is set to YES.
2310
2311LATEX_EXTRA_FILES =
2312
2313# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
2314# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
2315# contain links (just like the HTML output) instead of page references. This
2316# makes the output suitable for online browsing using a PDF viewer.
2317# The default value is: YES.
2318# This tag requires that the tag GENERATE_LATEX is set to YES.
2319
2320PDF_HYPERLINKS = YES
2321
2322# If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
2323# the PDF file directly from the LaTeX files. Set this option to YES, to get a
2324# higher quality PDF documentation.
2325# The default value is: YES.
2326# This tag requires that the tag GENERATE_LATEX is set to YES.
2327
2328USE_PDFLATEX = YES
2329
2330# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
2331# command to the generated LaTeX files. This will instruct LaTeX to keep running
2332# if errors occur, instead of asking the user for help. This option is also used
2333# when generating formulas in HTML.
2334# The default value is: NO.
2335# This tag requires that the tag GENERATE_LATEX is set to YES.
2336
2337LATEX_BATCHMODE = NO
2338
2339# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
2340# index chapters (such as File Index, Compound Index, etc.) in the output.
2341# The default value is: NO.
2342# This tag requires that the tag GENERATE_LATEX is set to YES.
2343
2344LATEX_HIDE_INDICES = NO
2345
2346# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
2347# code with syntax highlighting in the LaTeX output.
2348#
2349# Note that which sources are shown also depends on other settings such as
2350# SOURCE_BROWSER.
2351# The default value is: NO.
2352# This tag requires that the tag GENERATE_LATEX is set to YES.
2353
2354LATEX_SOURCE_CODE = NO
2355
2356# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
2357# bibliography, e.g. plainnat, or ieeetr. See
2358# http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
2359# The default value is: plain.
2360# This tag requires that the tag GENERATE_LATEX is set to YES.
2361
2362LATEX_BIB_STYLE = plain
2363
2364#---------------------------------------------------------------------------
2365# Configuration options related to the RTF output
2366#---------------------------------------------------------------------------
2367
2368# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
2369# RTF output is optimized for Word 97 and may not look too pretty with other RTF
2370# readers/editors.
2371# The default value is: NO.
2372
2373GENERATE_RTF = NO
2374
2375# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
2376# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2377# it.
2378# The default directory is: rtf.
2379# This tag requires that the tag GENERATE_RTF is set to YES.
2380
2381RTF_OUTPUT = rtf
2382
2383# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
2384# documents. This may be useful for small projects and may help to save some
2385# trees in general.
2386# The default value is: NO.
2387# This tag requires that the tag GENERATE_RTF is set to YES.
2388
2389COMPACT_RTF = NO
2390
2391# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
2392# contain hyperlink fields. The RTF file will contain links (just like the HTML
2393# output) instead of page references. This makes the output suitable for online
2394# browsing using Word or some other Word compatible readers that support those
2395# fields.
2396#
2397# Note: WordPad (write) and others do not support links.
2398# The default value is: NO.
2399# This tag requires that the tag GENERATE_RTF is set to YES.
2400
2401RTF_HYPERLINKS = NO
2402
2403# Load stylesheet definitions from file. Syntax is similar to doxygen's config
2404# file, i.e. a series of assignments. You only have to provide replacements,
2405# missing definitions are set to their default value.
2406#
2407# See also section "Doxygen usage" for information on how to generate the
2408# default style sheet that doxygen normally uses.
2409# This tag requires that the tag GENERATE_RTF is set to YES.
2410
2411RTF_STYLESHEET_FILE =
2412
2413# Set optional variables used in the generation of an RTF document. Syntax is
2414# similar to doxygen's config file. A template extensions file can be generated
2415# using doxygen -e rtf extensionFile.
2416# This tag requires that the tag GENERATE_RTF is set to YES.
2417
2418RTF_EXTENSIONS_FILE =
2419
2420# If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
2421# with syntax highlighting in the RTF output.
2422#
2423# Note that which sources are shown also depends on other settings such as
2424# SOURCE_BROWSER.
2425# The default value is: NO.
2426# This tag requires that the tag GENERATE_RTF is set to YES.
2427
2428RTF_SOURCE_CODE = NO
2429
2430#---------------------------------------------------------------------------
2431# Configuration options related to the man page output
2432#---------------------------------------------------------------------------
2433
2434# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
2435# classes and files.
2436# The default value is: NO.
2437
2438GENERATE_MAN = NO
2439
2440# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
2441# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2442# it. A directory man3 will be created inside the directory specified by
2443# MAN_OUTPUT.
2444# The default directory is: man.
2445# This tag requires that the tag GENERATE_MAN is set to YES.
2446
2447MAN_OUTPUT = man
2448
2449# The MAN_EXTENSION tag determines the extension that is added to the generated
2450# man pages. In case the manual section does not start with a number, the number
2451# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
2452# optional.
2453# The default value is: .3.
2454# This tag requires that the tag GENERATE_MAN is set to YES.
2455
2456MAN_EXTENSION = .3
2457
2458# The MAN_SUBDIR tag determines the name of the directory created within
2459# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
2460# MAN_EXTENSION with the initial . removed.
2461# This tag requires that the tag GENERATE_MAN is set to YES.
2462
2463MAN_SUBDIR =
2464
2465# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
2466# will generate one additional man file for each entity documented in the real
2467# man page(s). These additional files only source the real man page, but without
2468# them the man command would be unable to find the correct page.
2469# The default value is: NO.
2470# This tag requires that the tag GENERATE_MAN is set to YES.
2471
2472MAN_LINKS = NO
2473
2474#---------------------------------------------------------------------------
2475# Configuration options related to the XML output
2476#---------------------------------------------------------------------------
2477
2478# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
2479# captures the structure of the code including all documentation.
2480# The default value is: NO.
2481
2482GENERATE_XML = NO
2483
2484# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
2485# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2486# it.
2487# The default directory is: xml.
2488# This tag requires that the tag GENERATE_XML is set to YES.
2489
2490XML_OUTPUT = xml
2491
2492# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
2493# listings (including syntax highlighting and cross-referencing information) to
2494# the XML output. Note that enabling this will significantly increase the size
2495# of the XML output.
2496# The default value is: YES.
2497# This tag requires that the tag GENERATE_XML is set to YES.
2498
2499XML_PROGRAMLISTING = YES
2500
2501#---------------------------------------------------------------------------
2502# Configuration options related to the DOCBOOK output
2503#---------------------------------------------------------------------------
2504
2505# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
2506# that can be used to generate PDF.
2507# The default value is: NO.
2508
2509GENERATE_DOCBOOK = NO
2510
2511# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
2512# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
2513# front of it.
2514# The default directory is: docbook.
2515# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
2516
2517DOCBOOK_OUTPUT = docbook
2518
2519# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
2520# program listings (including syntax highlighting and cross-referencing
2521# information) to the DOCBOOK output. Note that enabling this will significantly
2522# increase the size of the DOCBOOK output.
2523# The default value is: NO.
2524# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
2525
2526DOCBOOK_PROGRAMLISTING = NO
2527
2528#---------------------------------------------------------------------------
2529# Configuration options for the AutoGen Definitions output
2530#---------------------------------------------------------------------------
2531
2532# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
2533# AutoGen Definitions (see http://autogen.sf.net) file that captures the
2534# structure of the code including all documentation. Note that this feature is
2535# still experimental and incomplete at the moment.
2536# The default value is: NO.
2537
2538GENERATE_AUTOGEN_DEF = NO
2539
2540#---------------------------------------------------------------------------
2541# Configuration options related to the Perl module output
2542#---------------------------------------------------------------------------
2543
2544# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
2545# file that captures the structure of the code including all documentation.
2546#
2547# Note that this feature is still experimental and incomplete at the moment.
2548# The default value is: NO.
2549
2550GENERATE_PERLMOD = NO
2551
2552# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
2553# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
2554# output from the Perl module output.
2555# The default value is: NO.
2556# This tag requires that the tag GENERATE_PERLMOD is set to YES.
2557
2558PERLMOD_LATEX = NO
2559
2560# If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
2561# formatted so it can be parsed by a human reader. This is useful if you want to
2562# understand what is going on. On the other hand, if this tag is set to NO, the
2563# size of the Perl module output will be much smaller and Perl will parse it
2564# just the same.
2565# The default value is: YES.
2566# This tag requires that the tag GENERATE_PERLMOD is set to YES.
2567
2568PERLMOD_PRETTY = YES
2569
2570# The names of the make variables in the generated doxyrules.make file are
2571# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
2572# so different doxyrules.make files included by the same Makefile don't
2573# overwrite each other's variables.
2574# This tag requires that the tag GENERATE_PERLMOD is set to YES.
2575
2576PERLMOD_MAKEVAR_PREFIX =
2577
2578#---------------------------------------------------------------------------
2579# Configuration options related to the preprocessor
2580#---------------------------------------------------------------------------
2581
2582# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
2583# C-preprocessor directives found in the sources and include files.
2584# The default value is: YES.
2585
2586ENABLE_PREPROCESSING = YES
2587
2588# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
2589# in the source code. If set to NO, only conditional compilation will be
2590# performed. Macro expansion can be done in a controlled way by setting
2591# EXPAND_ONLY_PREDEF to YES.
2592# The default value is: NO.
2593# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2594
2595MACRO_EXPANSION = YES
2596
2597# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
2598# the macro expansion is limited to the macros specified with the PREDEFINED and
2599# EXPAND_AS_DEFINED tags.
2600# The default value is: NO.
2601# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2602
2603EXPAND_ONLY_PREDEF = NO
2604
2605# If the SEARCH_INCLUDES tag is set to YES, the include files in the
2606# INCLUDE_PATH will be searched if a #include is found.
2607# The default value is: YES.
2608# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2609
2610SEARCH_INCLUDES = YES
2611
2612# The INCLUDE_PATH tag can be used to specify one or more directories that
2613# contain include files that are not input files but should be processed by the
2614# preprocessor.
2615# This tag requires that the tag SEARCH_INCLUDES is set to YES.
2616
2617INCLUDE_PATH =
2618
2619# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
2620# patterns (like *.h and *.hpp) to filter out the header-files in the
2621# directories. If left blank, the patterns specified with FILE_PATTERNS will be
2622# used.
2623# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2624
2625INCLUDE_FILE_PATTERNS =
2626
2627# The PREDEFINED tag can be used to specify one or more macro names that are
2628# defined before the preprocessor is started (similar to the -D option of e.g.
2629# gcc). The argument of the tag is a list of macros of the form: name or
2630# name=definition (no spaces). If the definition and the "=" are omitted, "=1"
2631# is assumed. To prevent a macro definition from being undefined via #undef or
2632# recursively expanded use the := operator instead of the = operator.
2633# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2634
2635PREDEFINED = GRPC_FINAL= GRPC_OVERIDE=
2636
2637# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
2638# tag can be used to specify a list of macro names that should be expanded. The
2639# macro definition that is found in the sources will be used. Use the PREDEFINED
2640# tag if you want to use a different macro definition that overrules the
2641# definition found in the source code.
2642# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2643
2644EXPAND_AS_DEFINED =
2645
2646# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
2647# remove all references to function-like macros that are alone on a line, have
2648# an all uppercase name, and do not end with a semicolon. Such function macros
2649# are typically used for boiler-plate code, and will confuse the parser if not
2650# removed.
2651# The default value is: YES.
2652# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2653
2654SKIP_FUNCTION_MACROS = YES
2655
2656#---------------------------------------------------------------------------
2657# Configuration options related to external references
2658#---------------------------------------------------------------------------
2659
2660# The TAGFILES tag can be used to specify one or more tag files. For each tag
2661# file the location of the external documentation should be added. The format of
2662# a tag file without this location is as follows:
2663# TAGFILES = file1 file2 ...
2664# Adding location for the tag files is done as follows:
2665# TAGFILES = file1=loc1 "file2 = loc2" ...
2666# where loc1 and loc2 can be relative or absolute paths or URLs. See the
2667# section "Linking to external documentation" for more information about the use
2668# of tag files.
2669# Note: Each tag file must have a unique name (where the name does NOT include
2670# the path). If a tag file is not located in the directory in which doxygen is
2671# run, you must also specify the path to the tagfile here.
2672
2673TAGFILES =
2674
2675# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
2676# tag file that is based on the input files it reads. See section "Linking to
2677# external documentation" for more information about the usage of tag files.
2678
2679GENERATE_TAGFILE =
2680
2681# If the ALLEXTERNALS tag is set to YES, all external class will be listed in
2682# the class index. If set to NO, only the inherited external classes will be
2683# listed.
2684# The default value is: NO.
2685
2686ALLEXTERNALS = NO
2687
2688# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
2689# in the modules index. If set to NO, only the current project's groups will be
2690# listed.
2691# The default value is: YES.
2692
2693EXTERNAL_GROUPS = YES
2694
2695# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
2696# the related pages index. If set to NO, only the current project's pages will
2697# be listed.
2698# The default value is: YES.
2699
2700EXTERNAL_PAGES = YES
2701
2702# The PERL_PATH should be the absolute path and name of the perl script
2703# interpreter (i.e. the result of 'which perl').
2704# The default file (with absolute path) is: /usr/bin/perl.
2705
2706PERL_PATH = /usr/bin/perl
2707
2708#---------------------------------------------------------------------------
2709# Configuration options related to the dot tool
2710#---------------------------------------------------------------------------
2711
2712# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
2713# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
2714# NO turns the diagrams off. Note that this option also works with HAVE_DOT
2715# disabled, but it is recommended to install and use dot, since it yields more
2716# powerful graphs.
2717# The default value is: YES.
2718
2719CLASS_DIAGRAMS = YES
2720
2721# You can define message sequence charts within doxygen comments using the \msc
2722# command. Doxygen will then run the mscgen tool (see:
2723# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
2724# documentation. The MSCGEN_PATH tag allows you to specify the directory where
2725# the mscgen tool resides. If left empty the tool is assumed to be found in the
2726# default search path.
2727
2728MSCGEN_PATH =
2729
2730# You can include diagrams made with dia in doxygen documentation. Doxygen will
2731# then run dia to produce the diagram and insert it in the documentation. The
2732# DIA_PATH tag allows you to specify the directory where the dia binary resides.
2733# If left empty dia is assumed to be found in the default search path.
2734
2735DIA_PATH =
2736
2737# If set to YES the inheritance and collaboration graphs will hide inheritance
2738# and usage relations if the target is undocumented or is not a class.
2739# The default value is: YES.
2740
2741HIDE_UNDOC_RELATIONS = YES
2742
2743# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2744# available from the path. This tool is part of Graphviz (see:
2745# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
2746# Bell Labs. The other options in this section have no effect if this option is
2747# set to NO
2748# The default value is: NO.
2749
2750HAVE_DOT = YES
2751
2752# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2753# to run in parallel. When set to 0 doxygen will base this on the number of
2754# processors available in the system. You can set it explicitly to a value
2755# larger than 0 to get control over the balance between CPU load and processing
2756# speed.
2757# Minimum value: 0, maximum value: 32, default value: 0.
2758# This tag requires that the tag HAVE_DOT is set to YES.
2759
2760DOT_NUM_THREADS = 0
2761
2762# When you want a differently looking font in the dot files that doxygen
2763# generates you can specify the font name using DOT_FONTNAME. You need to make
2764# sure dot is able to find the font, which can be done by putting it in a
2765# standard location or by setting the DOTFONTPATH environment variable or by
2766# setting DOT_FONTPATH to the directory containing the font.
2767# The default value is: Helvetica.
2768# This tag requires that the tag HAVE_DOT is set to YES.
2769
2770DOT_FONTNAME = Helvetica
2771
2772# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
2773# dot graphs.
2774# Minimum value: 4, maximum value: 24, default value: 10.
2775# This tag requires that the tag HAVE_DOT is set to YES.
2776
2777DOT_FONTSIZE = 10
2778
2779# By default doxygen will tell dot to use the default font as specified with
2780# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
2781# the path where dot can find it using this tag.
2782# This tag requires that the tag HAVE_DOT is set to YES.
2783
2784DOT_FONTPATH =
2785
2786# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2787# each documented class showing the direct and indirect inheritance relations.
2788# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
2789# The default value is: YES.
2790# This tag requires that the tag HAVE_DOT is set to YES.
2791
Craig Tiller68f4e0f2015-08-05 08:18:21 -07002792CLASS_GRAPH = NO
Craig Tiller6c4ae602015-05-28 08:41:41 -07002793
2794# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2795# graph for each documented class showing the direct and indirect implementation
2796# dependencies (inheritance, containment, and class references variables) of the
2797# class with other documented classes.
2798# The default value is: YES.
2799# This tag requires that the tag HAVE_DOT is set to YES.
2800
Craig Tiller68f4e0f2015-08-05 08:18:21 -07002801COLLABORATION_GRAPH = NO
Craig Tiller6c4ae602015-05-28 08:41:41 -07002802
2803# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2804# groups, showing the direct groups dependencies.
2805# The default value is: YES.
2806# This tag requires that the tag HAVE_DOT is set to YES.
2807
Craig Tiller68f4e0f2015-08-05 08:18:21 -07002808GROUP_GRAPHS = NO
Craig Tiller6c4ae602015-05-28 08:41:41 -07002809
2810# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
2811# collaboration diagrams in a style similar to the OMG's Unified Modeling
2812# Language.
2813# The default value is: NO.
2814# This tag requires that the tag HAVE_DOT is set to YES.
2815
2816UML_LOOK = NO
2817
2818# If the UML_LOOK tag is enabled, the fields and methods are shown inside the
2819# class node. If there are many fields or methods and many nodes the graph may
2820# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2821# number of items for each type to make the size more manageable. Set this to 0
2822# for no limit. Note that the threshold may be exceeded by 50% before the limit
2823# is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2824# but if the number exceeds 15, the total amount of fields shown is limited to
2825# 10.
2826# Minimum value: 0, maximum value: 100, default value: 10.
2827# This tag requires that the tag HAVE_DOT is set to YES.
2828
2829UML_LIMIT_NUM_FIELDS = 10
2830
2831# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2832# collaboration graphs will show the relations between templates and their
2833# instances.
2834# The default value is: NO.
2835# This tag requires that the tag HAVE_DOT is set to YES.
2836
2837TEMPLATE_RELATIONS = NO
2838
2839# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2840# YES then doxygen will generate a graph for each documented file showing the
2841# direct and indirect include dependencies of the file with other documented
2842# files.
2843# The default value is: YES.
2844# This tag requires that the tag HAVE_DOT is set to YES.
2845
Craig Tiller68f4e0f2015-08-05 08:18:21 -07002846INCLUDE_GRAPH = NO
Craig Tiller6c4ae602015-05-28 08:41:41 -07002847
2848# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
2849# set to YES then doxygen will generate a graph for each documented file showing
2850# the direct and indirect include dependencies of the file with other documented
2851# files.
2852# The default value is: YES.
2853# This tag requires that the tag HAVE_DOT is set to YES.
2854
Craig Tiller68f4e0f2015-08-05 08:18:21 -07002855INCLUDED_BY_GRAPH = NO
Craig Tiller6c4ae602015-05-28 08:41:41 -07002856
2857# If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2858# dependency graph for every global function or class method.
2859#
2860# Note that enabling this option will significantly increase the time of a run.
2861# So in most cases it will be better to enable call graphs for selected
2862# functions only using the \callgraph command.
2863# The default value is: NO.
2864# This tag requires that the tag HAVE_DOT is set to YES.
2865
2866CALL_GRAPH = NO
2867
2868# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2869# dependency graph for every global function or class method.
2870#
2871# Note that enabling this option will significantly increase the time of a run.
2872# So in most cases it will be better to enable caller graphs for selected
2873# functions only using the \callergraph command.
2874# The default value is: NO.
2875# This tag requires that the tag HAVE_DOT is set to YES.
2876
2877CALLER_GRAPH = NO
2878
2879# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2880# hierarchy of all classes instead of a textual one.
2881# The default value is: YES.
2882# This tag requires that the tag HAVE_DOT is set to YES.
2883
Craig Tiller68f4e0f2015-08-05 08:18:21 -07002884GRAPHICAL_HIERARCHY = NO
Craig Tiller6c4ae602015-05-28 08:41:41 -07002885
2886# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2887# dependencies a directory has on other directories in a graphical way. The
2888# dependency relations are determined by the #include relations between the
2889# files in the directories.
2890# The default value is: YES.
2891# This tag requires that the tag HAVE_DOT is set to YES.
2892
Craig Tiller68f4e0f2015-08-05 08:18:21 -07002893DIRECTORY_GRAPH = NO
Craig Tiller6c4ae602015-05-28 08:41:41 -07002894
2895# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2896# generated by dot.
2897# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2898# to make the SVG files visible in IE 9+ (other browsers do not have this
2899# requirement).
2900# Possible values are: png, jpg, gif and svg.
2901# The default value is: png.
2902# This tag requires that the tag HAVE_DOT is set to YES.
2903
2904DOT_IMAGE_FORMAT = png
2905
2906# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2907# enable generation of interactive SVG images that allow zooming and panning.
2908#
2909# Note that this requires a modern browser other than Internet Explorer. Tested
2910# and working are Firefox, Chrome, Safari, and Opera.
2911# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2912# the SVG files visible. Older versions of IE do not have SVG support.
2913# The default value is: NO.
2914# This tag requires that the tag HAVE_DOT is set to YES.
2915
2916INTERACTIVE_SVG = NO
2917
2918# The DOT_PATH tag can be used to specify the path where the dot tool can be
2919# found. If left blank, it is assumed the dot tool can be found in the path.
2920# This tag requires that the tag HAVE_DOT is set to YES.
2921
2922DOT_PATH =
2923
2924# The DOTFILE_DIRS tag can be used to specify one or more directories that
2925# contain dot files that are included in the documentation (see the \dotfile
2926# command).
2927# This tag requires that the tag HAVE_DOT is set to YES.
2928
2929DOTFILE_DIRS =
2930
2931# The MSCFILE_DIRS tag can be used to specify one or more directories that
2932# contain msc files that are included in the documentation (see the \mscfile
2933# command).
2934
2935MSCFILE_DIRS =
2936
2937# The DIAFILE_DIRS tag can be used to specify one or more directories that
2938# contain dia files that are included in the documentation (see the \diafile
2939# command).
2940
2941DIAFILE_DIRS =
2942
2943# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
2944# path where java can find the plantuml.jar file. If left blank, it is assumed
2945# PlantUML is not used or called during a preprocessing step. Doxygen will
2946# generate a warning when it encounters a \startuml command in this case and
2947# will not generate output for the diagram.
2948
2949PLANTUML_JAR_PATH =
2950
2951# When using plantuml, the specified paths are searched for files specified by
2952# the !include statement in a plantuml block.
2953
2954PLANTUML_INCLUDE_PATH =
2955
2956# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2957# that will be shown in the graph. If the number of nodes in a graph becomes
2958# larger than this value, doxygen will truncate the graph, which is visualized
2959# by representing a node as a red box. Note that doxygen if the number of direct
2960# children of the root node in a graph is already larger than
2961# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2962# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2963# Minimum value: 0, maximum value: 10000, default value: 50.
2964# This tag requires that the tag HAVE_DOT is set to YES.
2965
2966DOT_GRAPH_MAX_NODES = 50
2967
2968# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2969# generated by dot. A depth value of 3 means that only nodes reachable from the
2970# root by following a path via at most 3 edges will be shown. Nodes that lay
2971# further from the root node will be omitted. Note that setting this option to 1
2972# or 2 may greatly reduce the computation time needed for large code bases. Also
2973# note that the size of a graph can be further restricted by
2974# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
2975# Minimum value: 0, maximum value: 1000, default value: 0.
2976# This tag requires that the tag HAVE_DOT is set to YES.
2977
2978MAX_DOT_GRAPH_DEPTH = 0
2979
2980# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2981# background. This is disabled by default, because dot on Windows does not seem
2982# to support this out of the box.
2983#
2984# Warning: Depending on the platform used, enabling this option may lead to
2985# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2986# read).
2987# The default value is: NO.
2988# This tag requires that the tag HAVE_DOT is set to YES.
2989
2990DOT_TRANSPARENT = NO
2991
2992# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
2993# files in one run (i.e. multiple -o and -T options on the command line). This
2994# makes dot run faster, but since only newer versions of dot (>1.8.10) support
2995# this, this feature is disabled by default.
2996# The default value is: NO.
2997# This tag requires that the tag HAVE_DOT is set to YES.
2998
2999DOT_MULTI_TARGETS = NO
3000
3001# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
3002# explaining the meaning of the various boxes and arrows in the dot generated
3003# graphs.
3004# The default value is: YES.
3005# This tag requires that the tag HAVE_DOT is set to YES.
3006
3007GENERATE_LEGEND = YES
3008
3009# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
3010# files that are used to generate the various graphs.
3011# The default value is: YES.
3012# This tag requires that the tag HAVE_DOT is set to YES.
3013
3014DOT_CLEANUP = YES
3015