blob: 8dcd8cd42c5940d74abd3074fba282e08eacb730 [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
Julien Boeufe32075f2015-11-17 16:29:00 -080043PROJECT_NUMBER = 0.12.0.0
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 Tillereb327fb2015-06-23 16:51:38 -0700763INPUT = include/grpc/grpc_security.h \
764include/grpc/byte_buffer.h \
765include/grpc/byte_buffer_reader.h \
766include/grpc/compression.h \
767include/grpc/grpc.h \
768include/grpc/status.h \
769include/grpc/census.h \
Craig Tillereb327fb2015-06-23 16:51:38 -0700770src/core/security/auth_filters.h \
771src/core/security/base64.h \
772src/core/security/credentials.h \
Julien Boeuf87047d72015-08-21 14:30:33 -0700773src/core/security/handshake.h \
Craig Tillereb327fb2015-06-23 16:51:38 -0700774src/core/security/json_token.h \
Julien Boeuffeca1bf2015-06-22 16:46:20 +0200775src/core/security/jwt_verifier.h \
Craig Tillereb327fb2015-06-23 16:51:38 -0700776src/core/security/secure_endpoint.h \
Craig Tillereb327fb2015-06-23 16:51:38 -0700777src/core/security/security_connector.h \
778src/core/security/security_context.h \
779src/core/tsi/fake_transport_security.h \
780src/core/tsi/ssl_transport_security.h \
781src/core/tsi/transport_security.h \
782src/core/tsi/transport_security_interface.h \
Hongyu Chene09dc782015-08-21 11:28:33 -0700783src/core/census/grpc_filter.h \
Craig Tillereb327fb2015-06-23 16:51:38 -0700784src/core/channel/channel_args.h \
785src/core/channel/channel_stack.h \
Craig Tillereb327fb2015-06-23 16:51:38 -0700786src/core/channel/client_channel.h \
David Garcia Quintas7b1bd2c2015-10-05 18:22:10 -0700787src/core/channel/client_uchannel.h \
David Garcia Quintas8a187092015-07-01 14:52:44 -0700788src/core/channel/compress_filter.h \
Craig Tillereb327fb2015-06-23 16:51:38 -0700789src/core/channel/connected_channel.h \
790src/core/channel/context.h \
791src/core/channel/http_client_filter.h \
792src/core/channel/http_server_filter.h \
793src/core/channel/noop_filter.h \
Craig Tillerca1593a2015-11-02 14:08:33 -0800794src/core/channel/subchannel_call_holder.h \
Craig Tiller4b628112015-06-25 08:58:23 -0700795src/core/client_config/client_config.h \
Craig Tiller91624662015-06-25 16:31:02 -0700796src/core/client_config/connector.h \
yang-ga6124122015-11-05 22:36:20 -0800797src/core/client_config/initial_connect_string.h \
Craig Tiller4b628112015-06-25 08:58:23 -0700798src/core/client_config/lb_policies/pick_first.h \
David Garcia Quintas4fb049b2015-09-03 17:26:06 -0700799src/core/client_config/lb_policies/round_robin.h \
Craig Tiller4b628112015-06-25 08:58:23 -0700800src/core/client_config/lb_policy.h \
David Garcia Quintas5c4543d2015-09-03 15:49:56 -0700801src/core/client_config/lb_policy_factory.h \
802src/core/client_config/lb_policy_registry.h \
Craig Tiller4b628112015-06-25 08:58:23 -0700803src/core/client_config/resolver.h \
804src/core/client_config/resolver_factory.h \
805src/core/client_config/resolver_registry.h \
806src/core/client_config/resolvers/dns_resolver.h \
Craig Tiller698d00c2015-07-20 12:32:58 -0700807src/core/client_config/resolvers/sockaddr_resolver.h \
Craig Tiller4b628112015-06-25 08:58:23 -0700808src/core/client_config/subchannel.h \
809src/core/client_config/subchannel_factory.h \
Craig Tiller83f4d4e2015-07-29 18:14:41 -0700810src/core/client_config/subchannel_factory_decorators/add_channel_arg.h \
811src/core/client_config/subchannel_factory_decorators/merge_channel_args.h \
Craig Tiller4b628112015-06-25 08:58:23 -0700812src/core/client_config/uri_parser.h \
Craig Tillerebdef9d2015-11-19 17:09:49 -0800813src/core/compression/algorithm_metadata.h \
Craig Tillereb327fb2015-06-23 16:51:38 -0700814src/core/compression/message_compress.h \
815src/core/debug/trace.h \
Craig Tillerf53d9c82015-08-04 14:19:43 -0700816src/core/httpcli/format_request.h \
817src/core/httpcli/httpcli.h \
818src/core/httpcli/parser.h \
Craig Tiller298751c2015-09-22 09:41:05 -0700819src/core/iomgr/closure.h \
Craig Tillereb327fb2015-06-23 16:51:38 -0700820src/core/iomgr/endpoint.h \
821src/core/iomgr/endpoint_pair.h \
Craig Tiller298751c2015-09-22 09:41:05 -0700822src/core/iomgr/exec_ctx.h \
David Garcia Quintas4bc34632015-10-07 16:12:35 -0700823src/core/iomgr/executor.h \
Craig Tillereb327fb2015-06-23 16:51:38 -0700824src/core/iomgr/fd_posix.h \
825src/core/iomgr/iocp_windows.h \
826src/core/iomgr/iomgr.h \
827src/core/iomgr/iomgr_internal.h \
828src/core/iomgr/iomgr_posix.h \
829src/core/iomgr/pollset.h \
Craig Tillereb327fb2015-06-23 16:51:38 -0700830src/core/iomgr/pollset_posix.h \
831src/core/iomgr/pollset_set.h \
832src/core/iomgr/pollset_set_posix.h \
833src/core/iomgr/pollset_set_windows.h \
834src/core/iomgr/pollset_windows.h \
835src/core/iomgr/resolve_address.h \
836src/core/iomgr/sockaddr.h \
837src/core/iomgr/sockaddr_posix.h \
838src/core/iomgr/sockaddr_utils.h \
839src/core/iomgr/sockaddr_win32.h \
840src/core/iomgr/socket_utils_posix.h \
841src/core/iomgr/socket_windows.h \
842src/core/iomgr/tcp_client.h \
843src/core/iomgr/tcp_posix.h \
844src/core/iomgr/tcp_server.h \
845src/core/iomgr/tcp_windows.h \
846src/core/iomgr/time_averaged_stats.h \
David Garcia Quintasb65e4212015-10-14 12:00:21 -0700847src/core/iomgr/timer.h \
848src/core/iomgr/timer_heap.h \
849src/core/iomgr/timer_internal.h \
Robbie Shade69535292015-07-10 14:27:34 -0400850src/core/iomgr/udp_server.h \
Craig Tillereb327fb2015-06-23 16:51:38 -0700851src/core/iomgr/wakeup_fd_pipe.h \
852src/core/iomgr/wakeup_fd_posix.h \
Craig Tiller73b66062015-09-09 09:34:46 -0700853src/core/iomgr/workqueue.h \
854src/core/iomgr/workqueue_posix.h \
855src/core/iomgr/workqueue_windows.h \
Craig Tillereb327fb2015-06-23 16:51:38 -0700856src/core/json/json.h \
857src/core/json/json_common.h \
858src/core/json/json_reader.h \
859src/core/json/json_writer.h \
yang-g31ff8bc2015-08-25 14:09:06 -0700860src/core/statistics/census_interface.h \
861src/core/statistics/census_rpc_stats.h \
Masood Malekghassemi92298102015-08-20 18:50:17 -0700862src/core/surface/api_trace.h \
Craig Tillereb327fb2015-06-23 16:51:38 -0700863src/core/surface/call.h \
David Garcia Quintas0c331882015-10-08 14:51:54 -0700864src/core/surface/call_test_only.h \
Craig Tillereb327fb2015-06-23 16:51:38 -0700865src/core/surface/channel.h \
Craig Tillereb327fb2015-06-23 16:51:38 -0700866src/core/surface/completion_queue.h \
867src/core/surface/event_string.h \
868src/core/surface/init.h \
869src/core/surface/server.h \
870src/core/surface/surface_trace.h \
Craig Tillerca1593a2015-11-02 14:08:33 -0800871src/core/transport/byte_stream.h \
Craig Tillereb327fb2015-06-23 16:51:38 -0700872src/core/transport/chttp2/alpn.h \
873src/core/transport/chttp2/bin_encoder.h \
874src/core/transport/chttp2/frame.h \
875src/core/transport/chttp2/frame_data.h \
876src/core/transport/chttp2/frame_goaway.h \
877src/core/transport/chttp2/frame_ping.h \
878src/core/transport/chttp2/frame_rst_stream.h \
879src/core/transport/chttp2/frame_settings.h \
880src/core/transport/chttp2/frame_window_update.h \
Craig Tillerca1593a2015-11-02 14:08:33 -0800881src/core/transport/chttp2/hpack_encoder.h \
Craig Tillereb327fb2015-06-23 16:51:38 -0700882src/core/transport/chttp2/hpack_parser.h \
883src/core/transport/chttp2/hpack_table.h \
884src/core/transport/chttp2/http2_errors.h \
885src/core/transport/chttp2/huffsyms.h \
Craig Tiller6e8c7e82015-06-25 08:52:40 -0700886src/core/transport/chttp2/incoming_metadata.h \
887src/core/transport/chttp2/internal.h \
Craig Tillereb327fb2015-06-23 16:51:38 -0700888src/core/transport/chttp2/status_conversion.h \
Craig Tillereb327fb2015-06-23 16:51:38 -0700889src/core/transport/chttp2/stream_map.h \
890src/core/transport/chttp2/timeout_encoding.h \
891src/core/transport/chttp2/varint.h \
892src/core/transport/chttp2_transport.h \
Craig Tiller08a1cf82015-06-29 09:37:52 -0700893src/core/transport/connectivity_state.h \
Craig Tillereb327fb2015-06-23 16:51:38 -0700894src/core/transport/metadata.h \
Craig Tillerca1593a2015-11-02 14:08:33 -0800895src/core/transport/metadata_batch.h \
Craig Tiller2e7687c2015-11-18 14:56:46 -0800896src/core/transport/static_metadata.h \
Craig Tillereb327fb2015-06-23 16:51:38 -0700897src/core/transport/transport.h \
898src/core/transport/transport_impl.h \
Alistair Veitch1c09acc2015-08-31 16:57:32 -0700899src/core/census/aggregation.h \
Craig Tillereb327fb2015-06-23 16:51:38 -0700900src/core/census/context.h \
Alistair Veitch9a099822015-08-27 13:16:00 -0700901src/core/census/rpc_metric_id.h \
Craig Tillereb327fb2015-06-23 16:51:38 -0700902src/core/httpcli/httpcli_security_connector.c \
Craig Tillereb327fb2015-06-23 16:51:38 -0700903src/core/security/base64.c \
904src/core/security/client_auth_filter.c \
905src/core/security/credentials.c \
906src/core/security/credentials_metadata.c \
907src/core/security/credentials_posix.c \
908src/core/security/credentials_win32.c \
909src/core/security/google_default_credentials.c \
Julien Boeuf87047d72015-08-21 14:30:33 -0700910src/core/security/handshake.c \
Craig Tillereb327fb2015-06-23 16:51:38 -0700911src/core/security/json_token.c \
Julien Boeuffeca1bf2015-06-22 16:46:20 +0200912src/core/security/jwt_verifier.c \
Craig Tillereb327fb2015-06-23 16:51:38 -0700913src/core/security/secure_endpoint.c \
Craig Tillereb327fb2015-06-23 16:51:38 -0700914src/core/security/security_connector.c \
915src/core/security/security_context.c \
916src/core/security/server_auth_filter.c \
917src/core/security/server_secure_chttp2.c \
918src/core/surface/init_secure.c \
919src/core/surface/secure_channel_create.c \
920src/core/tsi/fake_transport_security.c \
921src/core/tsi/ssl_transport_security.c \
922src/core/tsi/transport_security.c \
923src/core/census/grpc_context.c \
Hongyu Chene09dc782015-08-21 11:28:33 -0700924src/core/census/grpc_filter.c \
Craig Tillereb327fb2015-06-23 16:51:38 -0700925src/core/channel/channel_args.c \
926src/core/channel/channel_stack.c \
Craig Tillereb327fb2015-06-23 16:51:38 -0700927src/core/channel/client_channel.c \
David Garcia Quintas7b1bd2c2015-10-05 18:22:10 -0700928src/core/channel/client_uchannel.c \
David Garcia Quintas8a187092015-07-01 14:52:44 -0700929src/core/channel/compress_filter.c \
Craig Tillereb327fb2015-06-23 16:51:38 -0700930src/core/channel/connected_channel.c \
931src/core/channel/http_client_filter.c \
932src/core/channel/http_server_filter.c \
933src/core/channel/noop_filter.c \
Craig Tillerca1593a2015-11-02 14:08:33 -0800934src/core/channel/subchannel_call_holder.c \
Craig Tiller4b628112015-06-25 08:58:23 -0700935src/core/client_config/client_config.c \
Craig Tiller91624662015-06-25 16:31:02 -0700936src/core/client_config/connector.c \
yang-ga6124122015-11-05 22:36:20 -0800937src/core/client_config/default_initial_connect_string.c \
938src/core/client_config/initial_connect_string.c \
Craig Tiller4b628112015-06-25 08:58:23 -0700939src/core/client_config/lb_policies/pick_first.c \
David Garcia Quintas4fb049b2015-09-03 17:26:06 -0700940src/core/client_config/lb_policies/round_robin.c \
Craig Tiller4b628112015-06-25 08:58:23 -0700941src/core/client_config/lb_policy.c \
David Garcia Quintas5c4543d2015-09-03 15:49:56 -0700942src/core/client_config/lb_policy_factory.c \
943src/core/client_config/lb_policy_registry.c \
Craig Tiller4b628112015-06-25 08:58:23 -0700944src/core/client_config/resolver.c \
945src/core/client_config/resolver_factory.c \
946src/core/client_config/resolver_registry.c \
947src/core/client_config/resolvers/dns_resolver.c \
Craig Tiller698d00c2015-07-20 12:32:58 -0700948src/core/client_config/resolvers/sockaddr_resolver.c \
Craig Tiller4b628112015-06-25 08:58:23 -0700949src/core/client_config/subchannel.c \
950src/core/client_config/subchannel_factory.c \
Craig Tiller83f4d4e2015-07-29 18:14:41 -0700951src/core/client_config/subchannel_factory_decorators/add_channel_arg.c \
952src/core/client_config/subchannel_factory_decorators/merge_channel_args.c \
Craig Tiller4b628112015-06-25 08:58:23 -0700953src/core/client_config/uri_parser.c \
Craig Tillereb327fb2015-06-23 16:51:38 -0700954src/core/compression/algorithm.c \
955src/core/compression/message_compress.c \
956src/core/debug/trace.c \
Craig Tillerf53d9c82015-08-04 14:19:43 -0700957src/core/httpcli/format_request.c \
958src/core/httpcli/httpcli.c \
959src/core/httpcli/parser.c \
Craig Tiller298751c2015-09-22 09:41:05 -0700960src/core/iomgr/closure.c \
Craig Tillereb327fb2015-06-23 16:51:38 -0700961src/core/iomgr/endpoint.c \
962src/core/iomgr/endpoint_pair_posix.c \
963src/core/iomgr/endpoint_pair_windows.c \
Craig Tiller8af4c332015-09-22 12:32:31 -0700964src/core/iomgr/exec_ctx.c \
David Garcia Quintas4bc34632015-10-07 16:12:35 -0700965src/core/iomgr/executor.c \
Craig Tillereb327fb2015-06-23 16:51:38 -0700966src/core/iomgr/fd_posix.c \
967src/core/iomgr/iocp_windows.c \
968src/core/iomgr/iomgr.c \
969src/core/iomgr/iomgr_posix.c \
970src/core/iomgr/iomgr_windows.c \
Craig Tillereb327fb2015-06-23 16:51:38 -0700971src/core/iomgr/pollset_multipoller_with_epoll.c \
972src/core/iomgr/pollset_multipoller_with_poll_posix.c \
973src/core/iomgr/pollset_posix.c \
974src/core/iomgr/pollset_set_posix.c \
975src/core/iomgr/pollset_set_windows.c \
976src/core/iomgr/pollset_windows.c \
977src/core/iomgr/resolve_address_posix.c \
978src/core/iomgr/resolve_address_windows.c \
979src/core/iomgr/sockaddr_utils.c \
980src/core/iomgr/socket_utils_common_posix.c \
981src/core/iomgr/socket_utils_linux.c \
982src/core/iomgr/socket_utils_posix.c \
983src/core/iomgr/socket_windows.c \
984src/core/iomgr/tcp_client_posix.c \
985src/core/iomgr/tcp_client_windows.c \
986src/core/iomgr/tcp_posix.c \
987src/core/iomgr/tcp_server_posix.c \
988src/core/iomgr/tcp_server_windows.c \
989src/core/iomgr/tcp_windows.c \
990src/core/iomgr/time_averaged_stats.c \
David Garcia Quintasb65e4212015-10-14 12:00:21 -0700991src/core/iomgr/timer.c \
992src/core/iomgr/timer_heap.c \
Robbie Shade69535292015-07-10 14:27:34 -0400993src/core/iomgr/udp_server.c \
Craig Tillereb327fb2015-06-23 16:51:38 -0700994src/core/iomgr/wakeup_fd_eventfd.c \
995src/core/iomgr/wakeup_fd_nospecial.c \
996src/core/iomgr/wakeup_fd_pipe.c \
997src/core/iomgr/wakeup_fd_posix.c \
Craig Tiller73b66062015-09-09 09:34:46 -0700998src/core/iomgr/workqueue_posix.c \
999src/core/iomgr/workqueue_windows.c \
Craig Tillereb327fb2015-06-23 16:51:38 -07001000src/core/json/json.c \
1001src/core/json/json_reader.c \
1002src/core/json/json_string.c \
1003src/core/json/json_writer.c \
Masood Malekghassemife1093c2015-08-19 19:15:24 -07001004src/core/surface/api_trace.c \
Craig Tillereb327fb2015-06-23 16:51:38 -07001005src/core/surface/byte_buffer.c \
Craig Tillereb327fb2015-06-23 16:51:38 -07001006src/core/surface/byte_buffer_reader.c \
1007src/core/surface/call.c \
1008src/core/surface/call_details.c \
1009src/core/surface/call_log_batch.c \
1010src/core/surface/channel.c \
Craig Tiller48cb07c2015-07-15 16:16:15 -07001011src/core/surface/channel_connectivity.c \
Craig Tillereb327fb2015-06-23 16:51:38 -07001012src/core/surface/channel_create.c \
Craig Tillereb327fb2015-06-23 16:51:38 -07001013src/core/surface/completion_queue.c \
1014src/core/surface/event_string.c \
1015src/core/surface/init.c \
1016src/core/surface/lame_client.c \
1017src/core/surface/metadata_array.c \
1018src/core/surface/server.c \
1019src/core/surface/server_chttp2.c \
1020src/core/surface/server_create.c \
Craig Tiller2e622bc2015-07-10 07:46:03 -07001021src/core/surface/version.c \
Craig Tillerca1593a2015-11-02 14:08:33 -08001022src/core/transport/byte_stream.c \
Craig Tillereb327fb2015-06-23 16:51:38 -07001023src/core/transport/chttp2/alpn.c \
1024src/core/transport/chttp2/bin_encoder.c \
1025src/core/transport/chttp2/frame_data.c \
1026src/core/transport/chttp2/frame_goaway.c \
1027src/core/transport/chttp2/frame_ping.c \
1028src/core/transport/chttp2/frame_rst_stream.c \
1029src/core/transport/chttp2/frame_settings.c \
1030src/core/transport/chttp2/frame_window_update.c \
Craig Tillerca1593a2015-11-02 14:08:33 -08001031src/core/transport/chttp2/hpack_encoder.c \
Craig Tillereb327fb2015-06-23 16:51:38 -07001032src/core/transport/chttp2/hpack_parser.c \
1033src/core/transport/chttp2/hpack_table.c \
1034src/core/transport/chttp2/huffsyms.c \
Craig Tiller6e8c7e82015-06-25 08:52:40 -07001035src/core/transport/chttp2/incoming_metadata.c \
1036src/core/transport/chttp2/parsing.c \
Craig Tillereb327fb2015-06-23 16:51:38 -07001037src/core/transport/chttp2/status_conversion.c \
Craig Tiller6e8c7e82015-06-25 08:52:40 -07001038src/core/transport/chttp2/stream_lists.c \
Craig Tillereb327fb2015-06-23 16:51:38 -07001039src/core/transport/chttp2/stream_map.c \
1040src/core/transport/chttp2/timeout_encoding.c \
1041src/core/transport/chttp2/varint.c \
Craig Tiller6e8c7e82015-06-25 08:52:40 -07001042src/core/transport/chttp2/writing.c \
Craig Tillereb327fb2015-06-23 16:51:38 -07001043src/core/transport/chttp2_transport.c \
Craig Tiller08a1cf82015-06-29 09:37:52 -07001044src/core/transport/connectivity_state.c \
Craig Tillereb327fb2015-06-23 16:51:38 -07001045src/core/transport/metadata.c \
Craig Tillerca1593a2015-11-02 14:08:33 -08001046src/core/transport/metadata_batch.c \
Craig Tiller2e7687c2015-11-18 14:56:46 -08001047src/core/transport/static_metadata.c \
Craig Tillereb327fb2015-06-23 16:51:38 -07001048src/core/transport/transport.c \
1049src/core/transport/transport_op_string.c \
1050src/core/census/context.c \
1051src/core/census/initialize.c \
Alistair Veitche6d0ad32015-08-13 09:59:48 -07001052src/core/census/operation.c \
Alistair Veitch0383d492015-07-26 15:29:00 -07001053src/core/census/tracing.c \
Craig Tillereb327fb2015-06-23 16:51:38 -07001054include/grpc/support/alloc.h \
1055include/grpc/support/atm.h \
1056include/grpc/support/atm_gcc_atomic.h \
1057include/grpc/support/atm_gcc_sync.h \
1058include/grpc/support/atm_win32.h \
Craig Tillerfba79f22015-11-23 11:06:55 -08001059include/grpc/support/avl.h \
Craig Tillereb327fb2015-06-23 16:51:38 -07001060include/grpc/support/cmdline.h \
1061include/grpc/support/cpu.h \
1062include/grpc/support/histogram.h \
1063include/grpc/support/host_port.h \
1064include/grpc/support/log.h \
1065include/grpc/support/log_win32.h \
1066include/grpc/support/port_platform.h \
1067include/grpc/support/slice.h \
1068include/grpc/support/slice_buffer.h \
1069include/grpc/support/string_util.h \
1070include/grpc/support/subprocess.h \
1071include/grpc/support/sync.h \
1072include/grpc/support/sync_generic.h \
1073include/grpc/support/sync_posix.h \
1074include/grpc/support/sync_win32.h \
1075include/grpc/support/thd.h \
1076include/grpc/support/time.h \
1077include/grpc/support/tls.h \
1078include/grpc/support/tls_gcc.h \
1079include/grpc/support/tls_msvc.h \
1080include/grpc/support/tls_pthread.h \
1081include/grpc/support/useful.h \
Craig Tiller0ba432d2015-10-09 16:57:11 -07001082src/core/profiling/timers.h \
vjpai9839d282015-09-24 17:55:18 -07001083src/core/support/block_annotate.h \
Craig Tillereb327fb2015-06-23 16:51:38 -07001084src/core/support/env.h \
1085src/core/support/file.h \
1086src/core/support/murmur_hash.h \
Vijay Pai005e3052015-07-10 15:18:45 -07001087src/core/support/stack_lockfree.h \
Craig Tillereb327fb2015-06-23 16:51:38 -07001088src/core/support/string.h \
1089src/core/support/string_win32.h \
1090src/core/support/thd_internal.h \
Hongyu Chena0f149e2015-08-24 16:27:19 -07001091src/core/support/time_precise.h \
Craig Tiller0ba432d2015-10-09 16:57:11 -07001092src/core/profiling/basic_timers.c \
1093src/core/profiling/stap_timers.c \
Craig Tillereb327fb2015-06-23 16:51:38 -07001094src/core/support/alloc.c \
Craig Tillerfba79f22015-11-23 11:06:55 -08001095src/core/support/avl.c \
Craig Tillereb327fb2015-06-23 16:51:38 -07001096src/core/support/cmdline.c \
1097src/core/support/cpu_iphone.c \
1098src/core/support/cpu_linux.c \
1099src/core/support/cpu_posix.c \
1100src/core/support/cpu_windows.c \
1101src/core/support/env_linux.c \
1102src/core/support/env_posix.c \
1103src/core/support/env_win32.c \
1104src/core/support/file.c \
1105src/core/support/file_posix.c \
1106src/core/support/file_win32.c \
1107src/core/support/histogram.c \
1108src/core/support/host_port.c \
1109src/core/support/log.c \
1110src/core/support/log_android.c \
1111src/core/support/log_linux.c \
1112src/core/support/log_posix.c \
1113src/core/support/log_win32.c \
1114src/core/support/murmur_hash.c \
1115src/core/support/slice.c \
1116src/core/support/slice_buffer.c \
Vijay Pai005e3052015-07-10 15:18:45 -07001117src/core/support/stack_lockfree.c \
Craig Tillereb327fb2015-06-23 16:51:38 -07001118src/core/support/string.c \
1119src/core/support/string_posix.c \
1120src/core/support/string_win32.c \
1121src/core/support/subprocess_posix.c \
1122src/core/support/sync.c \
1123src/core/support/sync_posix.c \
1124src/core/support/sync_win32.c \
1125src/core/support/thd.c \
1126src/core/support/thd_posix.c \
1127src/core/support/thd_win32.c \
1128src/core/support/time.c \
1129src/core/support/time_posix.c \
Craig Tiller504ed592015-10-08 07:38:43 -07001130src/core/support/time_precise.c \
Craig Tillereb327fb2015-06-23 16:51:38 -07001131src/core/support/time_win32.c \
1132src/core/support/tls_pthread.c
Craig Tiller6c4ae602015-05-28 08:41:41 -07001133
1134# This tag can be used to specify the character encoding of the source files
1135# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
1136# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
1137# documentation (see: http://www.gnu.org/software/libiconv) for the list of
1138# possible encodings.
1139# The default value is: UTF-8.
1140
1141INPUT_ENCODING = UTF-8
1142
1143# If the value of the INPUT tag contains directories, you can use the
1144# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
1145# *.h) to filter out the source-files in the directories. If left blank the
1146# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii,
1147# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,
1148# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,
1149# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
1150# *.qsf, *.as and *.js.
1151
1152FILE_PATTERNS =
1153
1154# The RECURSIVE tag can be used to specify whether or not subdirectories should
1155# be searched for input files as well.
1156# The default value is: NO.
1157
1158RECURSIVE = NO
1159
1160# The EXCLUDE tag can be used to specify files and/or directories that should be
1161# excluded from the INPUT source files. This way you can easily exclude a
1162# subdirectory from a directory tree whose root is specified with the INPUT tag.
1163#
1164# Note that relative paths are relative to the directory from which doxygen is
1165# run.
1166
1167EXCLUDE =
1168
1169# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
1170# directories that are symbolic links (a Unix file system feature) are excluded
1171# from the input.
1172# The default value is: NO.
1173
1174EXCLUDE_SYMLINKS = NO
1175
1176# If the value of the INPUT tag contains directories, you can use the
1177# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
1178# certain files from those directories.
1179#
1180# Note that the wildcards are matched against the file with absolute path, so to
1181# exclude all test directories for example use the pattern */test/*
1182
1183EXCLUDE_PATTERNS =
1184
1185# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
1186# (namespaces, classes, functions, etc.) that should be excluded from the
1187# output. The symbol name can be a fully qualified name, a word, or if the
1188# wildcard * is used, a substring. Examples: ANamespace, AClass,
1189# AClass::ANamespace, ANamespace::*Test
1190#
1191# Note that the wildcards are matched against the file with absolute path, so to
1192# exclude all test directories use the pattern */test/*
1193
1194EXCLUDE_SYMBOLS =
1195
1196# The EXAMPLE_PATH tag can be used to specify one or more files or directories
1197# that contain example code fragments that are included (see the \include
1198# command).
1199
1200EXAMPLE_PATH =
1201
1202# If the value of the EXAMPLE_PATH tag contains directories, you can use the
1203# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
1204# *.h) to filter out the source-files in the directories. If left blank all
1205# files are included.
1206
1207EXAMPLE_PATTERNS =
1208
1209# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
1210# searched for input files to be used with the \include or \dontinclude commands
1211# irrespective of the value of the RECURSIVE tag.
1212# The default value is: NO.
1213
1214EXAMPLE_RECURSIVE = NO
1215
1216# The IMAGE_PATH tag can be used to specify one or more files or directories
1217# that contain images that are to be included in the documentation (see the
1218# \image command).
1219
1220IMAGE_PATH =
1221
1222# The INPUT_FILTER tag can be used to specify a program that doxygen should
1223# invoke to filter for each input file. Doxygen will invoke the filter program
1224# by executing (via popen()) the command:
1225#
1226# <filter> <input-file>
1227#
1228# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
1229# name of an input file. Doxygen will then use the output that the filter
1230# program writes to standard output. If FILTER_PATTERNS is specified, this tag
1231# will be ignored.
1232#
1233# Note that the filter must not add or remove lines; it is applied before the
1234# code is scanned, but not when the output code is generated. If lines are added
1235# or removed, the anchors will not be placed correctly.
1236
1237INPUT_FILTER =
1238
1239# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
1240# basis. Doxygen will compare the file name with each pattern and apply the
1241# filter if there is a match. The filters are a list of the form: pattern=filter
1242# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
1243# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
1244# patterns match the file name, INPUT_FILTER is applied.
1245
1246FILTER_PATTERNS =
1247
1248# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
1249# INPUT_FILTER) will also be used to filter the input files that are used for
1250# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
1251# The default value is: NO.
1252
1253FILTER_SOURCE_FILES = NO
1254
1255# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
1256# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
1257# it is also possible to disable source filtering for a specific pattern using
1258# *.ext= (so without naming a filter).
1259# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
1260
1261FILTER_SOURCE_PATTERNS =
1262
1263# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
1264# is part of the input, its contents will be placed on the main page
1265# (index.html). This can be useful if you have a project on for instance GitHub
1266# and want to reuse the introduction page also for the doxygen output.
1267
1268USE_MDFILE_AS_MAINPAGE =
1269
1270#---------------------------------------------------------------------------
1271# Configuration options related to source browsing
1272#---------------------------------------------------------------------------
1273
1274# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
1275# generated. Documented entities will be cross-referenced with these sources.
1276#
1277# Note: To get rid of all source code in the generated output, make sure that
1278# also VERBATIM_HEADERS is set to NO.
1279# The default value is: NO.
1280
1281SOURCE_BROWSER = NO
1282
1283# Setting the INLINE_SOURCES tag to YES will include the body of functions,
1284# classes and enums directly into the documentation.
1285# The default value is: NO.
1286
1287INLINE_SOURCES = NO
1288
1289# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
1290# special comment blocks from generated source code fragments. Normal C, C++ and
1291# Fortran comments will always remain visible.
1292# The default value is: YES.
1293
1294STRIP_CODE_COMMENTS = YES
1295
1296# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
1297# function all documented functions referencing it will be listed.
1298# The default value is: NO.
1299
1300REFERENCED_BY_RELATION = NO
1301
1302# If the REFERENCES_RELATION tag is set to YES then for each documented function
1303# all documented entities called/used by that function will be listed.
1304# The default value is: NO.
1305
1306REFERENCES_RELATION = NO
1307
1308# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
1309# to YES then the hyperlinks from functions in REFERENCES_RELATION and
1310# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
1311# link to the documentation.
1312# The default value is: YES.
1313
1314REFERENCES_LINK_SOURCE = YES
1315
1316# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
1317# source code will show a tooltip with additional information such as prototype,
1318# brief description and links to the definition and documentation. Since this
1319# will make the HTML file larger and loading of large files a bit slower, you
1320# can opt to disable this feature.
1321# The default value is: YES.
1322# This tag requires that the tag SOURCE_BROWSER is set to YES.
1323
1324SOURCE_TOOLTIPS = YES
1325
1326# If the USE_HTAGS tag is set to YES then the references to source code will
1327# point to the HTML generated by the htags(1) tool instead of doxygen built-in
1328# source browser. The htags tool is part of GNU's global source tagging system
1329# (see http://www.gnu.org/software/global/global.html). You will need version
1330# 4.8.6 or higher.
1331#
1332# To use it do the following:
1333# - Install the latest version of global
1334# - Enable SOURCE_BROWSER and USE_HTAGS in the config file
1335# - Make sure the INPUT points to the root of the source tree
1336# - Run doxygen as normal
1337#
1338# Doxygen will invoke htags (and that will in turn invoke gtags), so these
1339# tools must be available from the command line (i.e. in the search path).
1340#
1341# The result: instead of the source browser generated by doxygen, the links to
1342# source code will now point to the output of htags.
1343# The default value is: NO.
1344# This tag requires that the tag SOURCE_BROWSER is set to YES.
1345
1346USE_HTAGS = NO
1347
1348# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
1349# verbatim copy of the header file for each class for which an include is
1350# specified. Set to NO to disable this.
1351# See also: Section \class.
1352# The default value is: YES.
1353
1354VERBATIM_HEADERS = YES
1355
1356#---------------------------------------------------------------------------
1357# Configuration options related to the alphabetical class index
1358#---------------------------------------------------------------------------
1359
1360# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1361# compounds will be generated. Enable this if the project contains a lot of
1362# classes, structs, unions or interfaces.
1363# The default value is: YES.
1364
1365ALPHABETICAL_INDEX = YES
1366
1367# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
1368# which the alphabetical index list will be split.
1369# Minimum value: 1, maximum value: 20, default value: 5.
1370# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1371
1372COLS_IN_ALPHA_INDEX = 5
1373
1374# In case all classes in a project start with a common prefix, all classes will
1375# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
1376# can be used to specify a prefix (or a list of prefixes) that should be ignored
1377# while generating the index headers.
1378# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1379
1380IGNORE_PREFIX =
1381
1382#---------------------------------------------------------------------------
1383# Configuration options related to the HTML output
1384#---------------------------------------------------------------------------
1385
1386# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
1387# The default value is: YES.
1388
1389GENERATE_HTML = YES
1390
1391# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1392# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1393# it.
1394# The default directory is: html.
1395# This tag requires that the tag GENERATE_HTML is set to YES.
1396
1397HTML_OUTPUT = html
1398
1399# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1400# generated HTML page (for example: .htm, .php, .asp).
1401# The default value is: .html.
1402# This tag requires that the tag GENERATE_HTML is set to YES.
1403
1404HTML_FILE_EXTENSION = .html
1405
1406# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1407# each generated HTML page. If the tag is left blank doxygen will generate a
1408# standard header.
1409#
1410# To get valid HTML the header file that includes any scripts and style sheets
1411# that doxygen needs, which is dependent on the configuration options used (e.g.
1412# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1413# default header using
1414# doxygen -w html new_header.html new_footer.html new_stylesheet.css
1415# YourConfigFile
1416# and then modify the file new_header.html. See also section "Doxygen usage"
1417# for information on how to generate the default header that doxygen normally
1418# uses.
1419# Note: The header is subject to change so you typically have to regenerate the
1420# default header when upgrading to a newer version of doxygen. For a description
1421# of the possible markers and block names see the documentation.
1422# This tag requires that the tag GENERATE_HTML is set to YES.
1423
1424HTML_HEADER =
1425
1426# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1427# generated HTML page. If the tag is left blank doxygen will generate a standard
1428# footer. See HTML_HEADER for more information on how to generate a default
1429# footer and what special commands can be used inside the footer. See also
1430# section "Doxygen usage" for information on how to generate the default footer
1431# that doxygen normally uses.
1432# This tag requires that the tag GENERATE_HTML is set to YES.
1433
1434HTML_FOOTER =
1435
1436# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1437# sheet that is used by each HTML page. It can be used to fine-tune the look of
1438# the HTML output. If left blank doxygen will generate a default style sheet.
1439# See also section "Doxygen usage" for information on how to generate the style
1440# sheet that doxygen normally uses.
1441# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1442# it is more robust and this tag (HTML_STYLESHEET) will in the future become
1443# obsolete.
1444# This tag requires that the tag GENERATE_HTML is set to YES.
1445
1446HTML_STYLESHEET =
1447
1448# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1449# cascading style sheets that are included after the standard style sheets
1450# created by doxygen. Using this option one can overrule certain style aspects.
1451# This is preferred over using HTML_STYLESHEET since it does not replace the
1452# standard style sheet and is therefore more robust against future updates.
1453# Doxygen will copy the style sheet files to the output directory.
1454# Note: The order of the extra style sheet files is of importance (e.g. the last
1455# style sheet in the list overrules the setting of the previous ones in the
1456# list). For an example see the documentation.
1457# This tag requires that the tag GENERATE_HTML is set to YES.
1458
1459HTML_EXTRA_STYLESHEET =
1460
1461# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1462# other source files which should be copied to the HTML output directory. Note
1463# that these files will be copied to the base HTML output directory. Use the
1464# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1465# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1466# files will be copied as-is; there are no commands or markers available.
1467# This tag requires that the tag GENERATE_HTML is set to YES.
1468
1469HTML_EXTRA_FILES =
1470
1471# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
1472# will adjust the colors in the style sheet and background images according to
1473# this color. Hue is specified as an angle on a colorwheel, see
1474# http://en.wikipedia.org/wiki/Hue for more information. For instance the value
1475# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
1476# purple, and 360 is red again.
1477# Minimum value: 0, maximum value: 359, default value: 220.
1478# This tag requires that the tag GENERATE_HTML is set to YES.
1479
1480HTML_COLORSTYLE_HUE = 220
1481
1482# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
1483# in the HTML output. For a value of 0 the output will use grayscales only. A
1484# value of 255 will produce the most vivid colors.
1485# Minimum value: 0, maximum value: 255, default value: 100.
1486# This tag requires that the tag GENERATE_HTML is set to YES.
1487
1488HTML_COLORSTYLE_SAT = 100
1489
1490# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1491# luminance component of the colors in the HTML output. Values below 100
1492# gradually make the output lighter, whereas values above 100 make the output
1493# darker. The value divided by 100 is the actual gamma applied, so 80 represents
1494# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1495# change the gamma.
1496# Minimum value: 40, maximum value: 240, default value: 80.
1497# This tag requires that the tag GENERATE_HTML is set to YES.
1498
1499HTML_COLORSTYLE_GAMMA = 80
1500
1501# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1502# page will contain the date and time when the page was generated. Setting this
1503# to NO can help when comparing the output of multiple runs.
1504# The default value is: YES.
1505# This tag requires that the tag GENERATE_HTML is set to YES.
1506
1507HTML_TIMESTAMP = YES
1508
1509# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1510# documentation will contain sections that can be hidden and shown after the
1511# page has loaded.
1512# The default value is: NO.
1513# This tag requires that the tag GENERATE_HTML is set to YES.
1514
1515HTML_DYNAMIC_SECTIONS = NO
1516
1517# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
1518# shown in the various tree structured indices initially; the user can expand
1519# and collapse entries dynamically later on. Doxygen will expand the tree to
1520# such a level that at most the specified number of entries are visible (unless
1521# a fully collapsed tree already exceeds this amount). So setting the number of
1522# entries 1 will produce a full collapsed tree by default. 0 is a special value
1523# representing an infinite number of entries and will result in a full expanded
1524# tree by default.
1525# Minimum value: 0, maximum value: 9999, default value: 100.
1526# This tag requires that the tag GENERATE_HTML is set to YES.
1527
1528HTML_INDEX_NUM_ENTRIES = 100
1529
1530# If the GENERATE_DOCSET tag is set to YES, additional index files will be
1531# generated that can be used as input for Apple's Xcode 3 integrated development
1532# environment (see: http://developer.apple.com/tools/xcode/), introduced with
1533# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
1534# Makefile in the HTML output directory. Running make will produce the docset in
1535# that directory and running make install will install the docset in
1536# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1537# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
1538# for more information.
1539# The default value is: NO.
1540# This tag requires that the tag GENERATE_HTML is set to YES.
1541
1542GENERATE_DOCSET = NO
1543
1544# This tag determines the name of the docset feed. A documentation feed provides
1545# an umbrella under which multiple documentation sets from a single provider
1546# (such as a company or product suite) can be grouped.
1547# The default value is: Doxygen generated docs.
1548# This tag requires that the tag GENERATE_DOCSET is set to YES.
1549
1550DOCSET_FEEDNAME = "Doxygen generated docs"
1551
1552# This tag specifies a string that should uniquely identify the documentation
1553# set bundle. This should be a reverse domain-name style string, e.g.
1554# com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1555# The default value is: org.doxygen.Project.
1556# This tag requires that the tag GENERATE_DOCSET is set to YES.
1557
1558DOCSET_BUNDLE_ID = org.doxygen.Project
1559
1560# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1561# the documentation publisher. This should be a reverse domain-name style
1562# string, e.g. com.mycompany.MyDocSet.documentation.
1563# The default value is: org.doxygen.Publisher.
1564# This tag requires that the tag GENERATE_DOCSET is set to YES.
1565
1566DOCSET_PUBLISHER_ID = org.doxygen.Publisher
1567
1568# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1569# The default value is: Publisher.
1570# This tag requires that the tag GENERATE_DOCSET is set to YES.
1571
1572DOCSET_PUBLISHER_NAME = Publisher
1573
1574# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1575# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1576# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1577# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
1578# Windows.
1579#
1580# The HTML Help Workshop contains a compiler that can convert all HTML output
1581# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1582# files are now used as the Windows 98 help format, and will replace the old
1583# Windows help format (.hlp) on all Windows platforms in the future. Compressed
1584# HTML files also contain an index, a table of contents, and you can search for
1585# words in the documentation. The HTML workshop also contains a viewer for
1586# compressed HTML files.
1587# The default value is: NO.
1588# This tag requires that the tag GENERATE_HTML is set to YES.
1589
1590GENERATE_HTMLHELP = NO
1591
1592# The CHM_FILE tag can be used to specify the file name of the resulting .chm
1593# file. You can add a path in front of the file if the result should not be
1594# written to the html output directory.
1595# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1596
1597CHM_FILE =
1598
1599# The HHC_LOCATION tag can be used to specify the location (absolute path
1600# including file name) of the HTML help compiler (hhc.exe). If non-empty,
1601# doxygen will try to run the HTML help compiler on the generated index.hhp.
1602# The file has to be specified with full path.
1603# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1604
1605HHC_LOCATION =
1606
1607# The GENERATE_CHI flag controls if a separate .chi index file is generated
1608# (YES) or that it should be included in the master .chm file (NO).
1609# The default value is: NO.
1610# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1611
1612GENERATE_CHI = NO
1613
1614# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
1615# and project file content.
1616# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1617
1618CHM_INDEX_ENCODING =
1619
1620# The BINARY_TOC flag controls whether a binary table of contents is generated
1621# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
1622# enables the Previous and Next buttons.
1623# The default value is: NO.
1624# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1625
1626BINARY_TOC = NO
1627
1628# The TOC_EXPAND flag can be set to YES to add extra items for group members to
1629# the table of contents of the HTML help documentation and to the tree view.
1630# The default value is: NO.
1631# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1632
1633TOC_EXPAND = NO
1634
1635# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1636# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1637# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1638# (.qch) of the generated HTML documentation.
1639# The default value is: NO.
1640# This tag requires that the tag GENERATE_HTML is set to YES.
1641
1642GENERATE_QHP = NO
1643
1644# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1645# the file name of the resulting .qch file. The path specified is relative to
1646# the HTML output folder.
1647# This tag requires that the tag GENERATE_QHP is set to YES.
1648
1649QCH_FILE =
1650
1651# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1652# Project output. For more information please see Qt Help Project / Namespace
1653# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
1654# The default value is: org.doxygen.Project.
1655# This tag requires that the tag GENERATE_QHP is set to YES.
1656
1657QHP_NAMESPACE = org.doxygen.Project
1658
1659# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1660# Help Project output. For more information please see Qt Help Project / Virtual
1661# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
1662# folders).
1663# The default value is: doc.
1664# This tag requires that the tag GENERATE_QHP is set to YES.
1665
1666QHP_VIRTUAL_FOLDER = doc
1667
1668# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1669# filter to add. For more information please see Qt Help Project / Custom
1670# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1671# filters).
1672# This tag requires that the tag GENERATE_QHP is set to YES.
1673
1674QHP_CUST_FILTER_NAME =
1675
1676# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
1677# custom filter to add. For more information please see Qt Help Project / Custom
1678# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1679# filters).
1680# This tag requires that the tag GENERATE_QHP is set to YES.
1681
1682QHP_CUST_FILTER_ATTRS =
1683
1684# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1685# project's filter section matches. Qt Help Project / Filter Attributes (see:
1686# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
1687# This tag requires that the tag GENERATE_QHP is set to YES.
1688
1689QHP_SECT_FILTER_ATTRS =
1690
1691# The QHG_LOCATION tag can be used to specify the location of Qt's
1692# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
1693# generated .qhp file.
1694# This tag requires that the tag GENERATE_QHP is set to YES.
1695
1696QHG_LOCATION =
1697
1698# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1699# generated, together with the HTML files, they form an Eclipse help plugin. To
1700# install this plugin and make it available under the help contents menu in
1701# Eclipse, the contents of the directory containing the HTML and XML files needs
1702# to be copied into the plugins directory of eclipse. The name of the directory
1703# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1704# After copying Eclipse needs to be restarted before the help appears.
1705# The default value is: NO.
1706# This tag requires that the tag GENERATE_HTML is set to YES.
1707
1708GENERATE_ECLIPSEHELP = NO
1709
1710# A unique identifier for the Eclipse help plugin. When installing the plugin
1711# the directory name containing the HTML and XML files should also have this
1712# name. Each documentation set should have its own identifier.
1713# The default value is: org.doxygen.Project.
1714# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1715
1716ECLIPSE_DOC_ID = org.doxygen.Project
1717
1718# If you want full control over the layout of the generated HTML pages it might
1719# be necessary to disable the index and replace it with your own. The
1720# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1721# of each HTML page. A value of NO enables the index and the value YES disables
1722# it. Since the tabs in the index contain the same information as the navigation
1723# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1724# The default value is: NO.
1725# This tag requires that the tag GENERATE_HTML is set to YES.
1726
1727DISABLE_INDEX = NO
1728
1729# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1730# structure should be generated to display hierarchical information. If the tag
1731# value is set to YES, a side panel will be generated containing a tree-like
1732# index structure (just like the one that is generated for HTML Help). For this
1733# to work a browser that supports JavaScript, DHTML, CSS and frames is required
1734# (i.e. any modern browser). Windows users are probably better off using the
1735# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
1736# further fine-tune the look of the index. As an example, the default style
1737# sheet generated by doxygen has an example that shows how to put an image at
1738# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
1739# the same information as the tab index, you could consider setting
1740# DISABLE_INDEX to YES when enabling this option.
1741# The default value is: NO.
1742# This tag requires that the tag GENERATE_HTML is set to YES.
1743
1744GENERATE_TREEVIEW = NO
1745
1746# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1747# doxygen will group on one line in the generated HTML documentation.
1748#
1749# Note that a value of 0 will completely suppress the enum values from appearing
1750# in the overview section.
1751# Minimum value: 0, maximum value: 20, default value: 4.
1752# This tag requires that the tag GENERATE_HTML is set to YES.
1753
1754ENUM_VALUES_PER_LINE = 4
1755
1756# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1757# to set the initial width (in pixels) of the frame in which the tree is shown.
1758# Minimum value: 0, maximum value: 1500, default value: 250.
1759# This tag requires that the tag GENERATE_HTML is set to YES.
1760
1761TREEVIEW_WIDTH = 250
1762
1763# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
1764# external symbols imported via tag files in a separate window.
1765# The default value is: NO.
1766# This tag requires that the tag GENERATE_HTML is set to YES.
1767
1768EXT_LINKS_IN_WINDOW = NO
1769
1770# Use this tag to change the font size of LaTeX formulas included as images in
1771# the HTML documentation. When you change the font size after a successful
1772# doxygen run you need to manually remove any form_*.png images from the HTML
1773# output directory to force them to be regenerated.
1774# Minimum value: 8, maximum value: 50, default value: 10.
1775# This tag requires that the tag GENERATE_HTML is set to YES.
1776
1777FORMULA_FONTSIZE = 10
1778
1779# Use the FORMULA_TRANPARENT tag to determine whether or not the images
1780# generated for formulas are transparent PNGs. Transparent PNGs are not
1781# supported properly for IE 6.0, but are supported on all modern browsers.
1782#
1783# Note that when changing this option you need to delete any form_*.png files in
1784# the HTML output directory before the changes have effect.
1785# The default value is: YES.
1786# This tag requires that the tag GENERATE_HTML is set to YES.
1787
1788FORMULA_TRANSPARENT = YES
1789
1790# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1791# http://www.mathjax.org) which uses client side Javascript for the rendering
1792# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
1793# installed or if you want to formulas look prettier in the HTML output. When
1794# enabled you may also need to install MathJax separately and configure the path
1795# to it using the MATHJAX_RELPATH option.
1796# The default value is: NO.
1797# This tag requires that the tag GENERATE_HTML is set to YES.
1798
1799USE_MATHJAX = NO
1800
1801# When MathJax is enabled you can set the default output format to be used for
1802# the MathJax output. See the MathJax site (see:
1803# http://docs.mathjax.org/en/latest/output.html) for more details.
1804# Possible values are: HTML-CSS (which is slower, but has the best
1805# compatibility), NativeMML (i.e. MathML) and SVG.
1806# The default value is: HTML-CSS.
1807# This tag requires that the tag USE_MATHJAX is set to YES.
1808
1809MATHJAX_FORMAT = HTML-CSS
1810
1811# When MathJax is enabled you need to specify the location relative to the HTML
1812# output directory using the MATHJAX_RELPATH option. The destination directory
1813# should contain the MathJax.js script. For instance, if the mathjax directory
1814# is located at the same level as the HTML output directory, then
1815# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1816# Content Delivery Network so you can quickly see the result without installing
1817# MathJax. However, it is strongly recommended to install a local copy of
1818# MathJax from http://www.mathjax.org before deployment.
1819# The default value is: http://cdn.mathjax.org/mathjax/latest.
1820# This tag requires that the tag USE_MATHJAX is set to YES.
1821
1822MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
1823
1824# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1825# extension names that should be enabled during MathJax rendering. For example
1826# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
1827# This tag requires that the tag USE_MATHJAX is set to YES.
1828
1829MATHJAX_EXTENSIONS =
1830
1831# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1832# of code that will be used on startup of the MathJax code. See the MathJax site
1833# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
1834# example see the documentation.
1835# This tag requires that the tag USE_MATHJAX is set to YES.
1836
1837MATHJAX_CODEFILE =
1838
1839# When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1840# the HTML output. The underlying search engine uses javascript and DHTML and
1841# should work on any modern browser. Note that when using HTML help
1842# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
1843# there is already a search function so this one should typically be disabled.
1844# For large projects the javascript based search engine can be slow, then
1845# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1846# search using the keyboard; to jump to the search box use <access key> + S
1847# (what the <access key> is depends on the OS and browser, but it is typically
1848# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
1849# key> to jump into the search results window, the results can be navigated
1850# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1851# the search. The filter options can be selected when the cursor is inside the
1852# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
1853# to select a filter and <Enter> or <escape> to activate or cancel the filter
1854# option.
1855# The default value is: YES.
1856# This tag requires that the tag GENERATE_HTML is set to YES.
1857
1858SEARCHENGINE = YES
1859
1860# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1861# implemented using a web server instead of a web client using Javascript. There
1862# are two flavors of web server based searching depending on the EXTERNAL_SEARCH
1863# setting. When disabled, doxygen will generate a PHP script for searching and
1864# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
1865# and searching needs to be provided by external tools. See the section
1866# "External Indexing and Searching" for details.
1867# The default value is: NO.
1868# This tag requires that the tag SEARCHENGINE is set to YES.
1869
1870SERVER_BASED_SEARCH = NO
1871
1872# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1873# script for searching. Instead the search results are written to an XML file
1874# which needs to be processed by an external indexer. Doxygen will invoke an
1875# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1876# search results.
1877#
1878# Doxygen ships with an example indexer (doxyindexer) and search engine
1879# (doxysearch.cgi) which are based on the open source search engine library
1880# Xapian (see: http://xapian.org/).
1881#
1882# See the section "External Indexing and Searching" for details.
1883# The default value is: NO.
1884# This tag requires that the tag SEARCHENGINE is set to YES.
1885
1886EXTERNAL_SEARCH = NO
1887
1888# The SEARCHENGINE_URL should point to a search engine hosted by a web server
1889# which will return the search results when EXTERNAL_SEARCH is enabled.
1890#
1891# Doxygen ships with an example indexer (doxyindexer) and search engine
1892# (doxysearch.cgi) which are based on the open source search engine library
1893# Xapian (see: http://xapian.org/). See the section "External Indexing and
1894# Searching" for details.
1895# This tag requires that the tag SEARCHENGINE is set to YES.
1896
1897SEARCHENGINE_URL =
1898
1899# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
1900# search data is written to a file for indexing by an external tool. With the
1901# SEARCHDATA_FILE tag the name of this file can be specified.
1902# The default file is: searchdata.xml.
1903# This tag requires that the tag SEARCHENGINE is set to YES.
1904
1905SEARCHDATA_FILE = searchdata.xml
1906
1907# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
1908# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1909# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1910# projects and redirect the results back to the right project.
1911# This tag requires that the tag SEARCHENGINE is set to YES.
1912
1913EXTERNAL_SEARCH_ID =
1914
1915# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1916# projects other than the one defined by this configuration file, but that are
1917# all added to the same external search index. Each project needs to have a
1918# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
1919# to a relative location where the documentation can be found. The format is:
1920# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
1921# This tag requires that the tag SEARCHENGINE is set to YES.
1922
1923EXTRA_SEARCH_MAPPINGS =
1924
1925#---------------------------------------------------------------------------
1926# Configuration options related to the LaTeX output
1927#---------------------------------------------------------------------------
1928
1929# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
1930# The default value is: YES.
1931
1932GENERATE_LATEX = NO
1933
1934# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1935# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1936# it.
1937# The default directory is: latex.
1938# This tag requires that the tag GENERATE_LATEX is set to YES.
1939
1940LATEX_OUTPUT = latex
1941
1942# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1943# invoked.
1944#
1945# Note that when enabling USE_PDFLATEX this option is only used for generating
1946# bitmaps for formulas in the HTML output, but not in the Makefile that is
1947# written to the output directory.
1948# The default file is: latex.
1949# This tag requires that the tag GENERATE_LATEX is set to YES.
1950
1951LATEX_CMD_NAME = latex
1952
1953# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
1954# index for LaTeX.
1955# The default file is: makeindex.
1956# This tag requires that the tag GENERATE_LATEX is set to YES.
1957
1958MAKEINDEX_CMD_NAME = makeindex
1959
1960# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
1961# documents. This may be useful for small projects and may help to save some
1962# trees in general.
1963# The default value is: NO.
1964# This tag requires that the tag GENERATE_LATEX is set to YES.
1965
1966COMPACT_LATEX = NO
1967
1968# The PAPER_TYPE tag can be used to set the paper type that is used by the
1969# printer.
1970# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
1971# 14 inches) and executive (7.25 x 10.5 inches).
1972# The default value is: a4.
1973# This tag requires that the tag GENERATE_LATEX is set to YES.
1974
1975PAPER_TYPE = a4
1976
1977# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
1978# that should be included in the LaTeX output. To get the times font for
1979# instance you can specify
1980# EXTRA_PACKAGES=times
1981# If left blank no extra packages will be included.
1982# This tag requires that the tag GENERATE_LATEX is set to YES.
1983
1984EXTRA_PACKAGES =
1985
1986# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
1987# generated LaTeX document. The header should contain everything until the first
1988# chapter. If it is left blank doxygen will generate a standard header. See
1989# section "Doxygen usage" for information on how to let doxygen write the
1990# default header to a separate file.
1991#
1992# Note: Only use a user-defined header if you know what you are doing! The
1993# following commands have a special meaning inside the header: $title,
1994# $datetime, $date, $doxygenversion, $projectname, $projectnumber,
1995# $projectbrief, $projectlogo. Doxygen will replace $title with the empty
1996# string, for the replacement values of the other commands the user is referred
1997# to HTML_HEADER.
1998# This tag requires that the tag GENERATE_LATEX is set to YES.
1999
2000LATEX_HEADER =
2001
2002# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
2003# generated LaTeX document. The footer should contain everything after the last
2004# chapter. If it is left blank doxygen will generate a standard footer. See
2005# LATEX_HEADER for more information on how to generate a default footer and what
2006# special commands can be used inside the footer.
2007#
2008# Note: Only use a user-defined footer if you know what you are doing!
2009# This tag requires that the tag GENERATE_LATEX is set to YES.
2010
2011LATEX_FOOTER =
2012
2013# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
2014# LaTeX style sheets that are included after the standard style sheets created
2015# by doxygen. Using this option one can overrule certain style aspects. Doxygen
2016# will copy the style sheet files to the output directory.
2017# Note: The order of the extra style sheet files is of importance (e.g. the last
2018# style sheet in the list overrules the setting of the previous ones in the
2019# list).
2020# This tag requires that the tag GENERATE_LATEX is set to YES.
2021
2022LATEX_EXTRA_STYLESHEET =
2023
2024# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
2025# other source files which should be copied to the LATEX_OUTPUT output
2026# directory. Note that the files will be copied as-is; there are no commands or
2027# markers available.
2028# This tag requires that the tag GENERATE_LATEX is set to YES.
2029
2030LATEX_EXTRA_FILES =
2031
2032# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
2033# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
2034# contain links (just like the HTML output) instead of page references. This
2035# makes the output suitable for online browsing using a PDF viewer.
2036# The default value is: YES.
2037# This tag requires that the tag GENERATE_LATEX is set to YES.
2038
2039PDF_HYPERLINKS = YES
2040
2041# If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
2042# the PDF file directly from the LaTeX files. Set this option to YES, to get a
2043# higher quality PDF documentation.
2044# The default value is: YES.
2045# This tag requires that the tag GENERATE_LATEX is set to YES.
2046
2047USE_PDFLATEX = YES
2048
2049# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
2050# command to the generated LaTeX files. This will instruct LaTeX to keep running
2051# if errors occur, instead of asking the user for help. This option is also used
2052# when generating formulas in HTML.
2053# The default value is: NO.
2054# This tag requires that the tag GENERATE_LATEX is set to YES.
2055
2056LATEX_BATCHMODE = NO
2057
2058# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
2059# index chapters (such as File Index, Compound Index, etc.) in the output.
2060# The default value is: NO.
2061# This tag requires that the tag GENERATE_LATEX is set to YES.
2062
2063LATEX_HIDE_INDICES = NO
2064
2065# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
2066# code with syntax highlighting in the LaTeX output.
2067#
2068# Note that which sources are shown also depends on other settings such as
2069# SOURCE_BROWSER.
2070# The default value is: NO.
2071# This tag requires that the tag GENERATE_LATEX is set to YES.
2072
2073LATEX_SOURCE_CODE = NO
2074
2075# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
2076# bibliography, e.g. plainnat, or ieeetr. See
2077# http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
2078# The default value is: plain.
2079# This tag requires that the tag GENERATE_LATEX is set to YES.
2080
2081LATEX_BIB_STYLE = plain
2082
2083#---------------------------------------------------------------------------
2084# Configuration options related to the RTF output
2085#---------------------------------------------------------------------------
2086
2087# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
2088# RTF output is optimized for Word 97 and may not look too pretty with other RTF
2089# readers/editors.
2090# The default value is: NO.
2091
2092GENERATE_RTF = NO
2093
2094# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
2095# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2096# it.
2097# The default directory is: rtf.
2098# This tag requires that the tag GENERATE_RTF is set to YES.
2099
2100RTF_OUTPUT = rtf
2101
2102# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
2103# documents. This may be useful for small projects and may help to save some
2104# trees in general.
2105# The default value is: NO.
2106# This tag requires that the tag GENERATE_RTF is set to YES.
2107
2108COMPACT_RTF = NO
2109
2110# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
2111# contain hyperlink fields. The RTF file will contain links (just like the HTML
2112# output) instead of page references. This makes the output suitable for online
2113# browsing using Word or some other Word compatible readers that support those
2114# fields.
2115#
2116# Note: WordPad (write) and others do not support links.
2117# The default value is: NO.
2118# This tag requires that the tag GENERATE_RTF is set to YES.
2119
2120RTF_HYPERLINKS = NO
2121
2122# Load stylesheet definitions from file. Syntax is similar to doxygen's config
2123# file, i.e. a series of assignments. You only have to provide replacements,
2124# missing definitions are set to their default value.
2125#
2126# See also section "Doxygen usage" for information on how to generate the
2127# default style sheet that doxygen normally uses.
2128# This tag requires that the tag GENERATE_RTF is set to YES.
2129
2130RTF_STYLESHEET_FILE =
2131
2132# Set optional variables used in the generation of an RTF document. Syntax is
2133# similar to doxygen's config file. A template extensions file can be generated
2134# using doxygen -e rtf extensionFile.
2135# This tag requires that the tag GENERATE_RTF is set to YES.
2136
2137RTF_EXTENSIONS_FILE =
2138
2139# If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
2140# with syntax highlighting in the RTF output.
2141#
2142# Note that which sources are shown also depends on other settings such as
2143# SOURCE_BROWSER.
2144# The default value is: NO.
2145# This tag requires that the tag GENERATE_RTF is set to YES.
2146
2147RTF_SOURCE_CODE = NO
2148
2149#---------------------------------------------------------------------------
2150# Configuration options related to the man page output
2151#---------------------------------------------------------------------------
2152
2153# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
2154# classes and files.
2155# The default value is: NO.
2156
2157GENERATE_MAN = NO
2158
2159# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
2160# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2161# it. A directory man3 will be created inside the directory specified by
2162# MAN_OUTPUT.
2163# The default directory is: man.
2164# This tag requires that the tag GENERATE_MAN is set to YES.
2165
2166MAN_OUTPUT = man
2167
2168# The MAN_EXTENSION tag determines the extension that is added to the generated
2169# man pages. In case the manual section does not start with a number, the number
2170# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
2171# optional.
2172# The default value is: .3.
2173# This tag requires that the tag GENERATE_MAN is set to YES.
2174
2175MAN_EXTENSION = .3
2176
2177# The MAN_SUBDIR tag determines the name of the directory created within
2178# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
2179# MAN_EXTENSION with the initial . removed.
2180# This tag requires that the tag GENERATE_MAN is set to YES.
2181
2182MAN_SUBDIR =
2183
2184# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
2185# will generate one additional man file for each entity documented in the real
2186# man page(s). These additional files only source the real man page, but without
2187# them the man command would be unable to find the correct page.
2188# The default value is: NO.
2189# This tag requires that the tag GENERATE_MAN is set to YES.
2190
2191MAN_LINKS = NO
2192
2193#---------------------------------------------------------------------------
2194# Configuration options related to the XML output
2195#---------------------------------------------------------------------------
2196
2197# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
2198# captures the structure of the code including all documentation.
2199# The default value is: NO.
2200
2201GENERATE_XML = NO
2202
2203# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
2204# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2205# it.
2206# The default directory is: xml.
2207# This tag requires that the tag GENERATE_XML is set to YES.
2208
2209XML_OUTPUT = xml
2210
2211# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
2212# listings (including syntax highlighting and cross-referencing information) to
2213# the XML output. Note that enabling this will significantly increase the size
2214# of the XML output.
2215# The default value is: YES.
2216# This tag requires that the tag GENERATE_XML is set to YES.
2217
2218XML_PROGRAMLISTING = YES
2219
2220#---------------------------------------------------------------------------
2221# Configuration options related to the DOCBOOK output
2222#---------------------------------------------------------------------------
2223
2224# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
2225# that can be used to generate PDF.
2226# The default value is: NO.
2227
2228GENERATE_DOCBOOK = NO
2229
2230# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
2231# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
2232# front of it.
2233# The default directory is: docbook.
2234# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
2235
2236DOCBOOK_OUTPUT = docbook
2237
2238# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
2239# program listings (including syntax highlighting and cross-referencing
2240# information) to the DOCBOOK output. Note that enabling this will significantly
2241# increase the size of the DOCBOOK output.
2242# The default value is: NO.
2243# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
2244
2245DOCBOOK_PROGRAMLISTING = NO
2246
2247#---------------------------------------------------------------------------
2248# Configuration options for the AutoGen Definitions output
2249#---------------------------------------------------------------------------
2250
2251# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
2252# AutoGen Definitions (see http://autogen.sf.net) file that captures the
2253# structure of the code including all documentation. Note that this feature is
2254# still experimental and incomplete at the moment.
2255# The default value is: NO.
2256
2257GENERATE_AUTOGEN_DEF = NO
2258
2259#---------------------------------------------------------------------------
2260# Configuration options related to the Perl module output
2261#---------------------------------------------------------------------------
2262
2263# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
2264# file that captures the structure of the code including all documentation.
2265#
2266# Note that this feature is still experimental and incomplete at the moment.
2267# The default value is: NO.
2268
2269GENERATE_PERLMOD = NO
2270
2271# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
2272# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
2273# output from the Perl module output.
2274# The default value is: NO.
2275# This tag requires that the tag GENERATE_PERLMOD is set to YES.
2276
2277PERLMOD_LATEX = NO
2278
2279# If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
2280# formatted so it can be parsed by a human reader. This is useful if you want to
2281# understand what is going on. On the other hand, if this tag is set to NO, the
2282# size of the Perl module output will be much smaller and Perl will parse it
2283# just the same.
2284# The default value is: YES.
2285# This tag requires that the tag GENERATE_PERLMOD is set to YES.
2286
2287PERLMOD_PRETTY = YES
2288
2289# The names of the make variables in the generated doxyrules.make file are
2290# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
2291# so different doxyrules.make files included by the same Makefile don't
2292# overwrite each other's variables.
2293# This tag requires that the tag GENERATE_PERLMOD is set to YES.
2294
2295PERLMOD_MAKEVAR_PREFIX =
2296
2297#---------------------------------------------------------------------------
2298# Configuration options related to the preprocessor
2299#---------------------------------------------------------------------------
2300
2301# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
2302# C-preprocessor directives found in the sources and include files.
2303# The default value is: YES.
2304
2305ENABLE_PREPROCESSING = YES
2306
2307# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
2308# in the source code. If set to NO, only conditional compilation will be
2309# performed. Macro expansion can be done in a controlled way by setting
2310# EXPAND_ONLY_PREDEF to YES.
2311# The default value is: NO.
2312# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2313
2314MACRO_EXPANSION = YES
2315
2316# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
2317# the macro expansion is limited to the macros specified with the PREDEFINED and
2318# EXPAND_AS_DEFINED tags.
2319# The default value is: NO.
2320# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2321
2322EXPAND_ONLY_PREDEF = NO
2323
2324# If the SEARCH_INCLUDES tag is set to YES, the include files in the
2325# INCLUDE_PATH will be searched if a #include is found.
2326# The default value is: YES.
2327# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2328
2329SEARCH_INCLUDES = YES
2330
2331# The INCLUDE_PATH tag can be used to specify one or more directories that
2332# contain include files that are not input files but should be processed by the
2333# preprocessor.
2334# This tag requires that the tag SEARCH_INCLUDES is set to YES.
2335
2336INCLUDE_PATH =
2337
2338# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
2339# patterns (like *.h and *.hpp) to filter out the header-files in the
2340# directories. If left blank, the patterns specified with FILE_PATTERNS will be
2341# used.
2342# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2343
2344INCLUDE_FILE_PATTERNS =
2345
2346# The PREDEFINED tag can be used to specify one or more macro names that are
2347# defined before the preprocessor is started (similar to the -D option of e.g.
2348# gcc). The argument of the tag is a list of macros of the form: name or
2349# name=definition (no spaces). If the definition and the "=" are omitted, "=1"
2350# is assumed. To prevent a macro definition from being undefined via #undef or
2351# recursively expanded use the := operator instead of the = operator.
2352# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2353
2354PREDEFINED = GRPC_FINAL= GRPC_OVERIDE=
2355
2356# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
2357# tag can be used to specify a list of macro names that should be expanded. The
2358# macro definition that is found in the sources will be used. Use the PREDEFINED
2359# tag if you want to use a different macro definition that overrules the
2360# definition found in the source code.
2361# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2362
2363EXPAND_AS_DEFINED =
2364
2365# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
2366# remove all references to function-like macros that are alone on a line, have
2367# an all uppercase name, and do not end with a semicolon. Such function macros
2368# are typically used for boiler-plate code, and will confuse the parser if not
2369# removed.
2370# The default value is: YES.
2371# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2372
2373SKIP_FUNCTION_MACROS = YES
2374
2375#---------------------------------------------------------------------------
2376# Configuration options related to external references
2377#---------------------------------------------------------------------------
2378
2379# The TAGFILES tag can be used to specify one or more tag files. For each tag
2380# file the location of the external documentation should be added. The format of
2381# a tag file without this location is as follows:
2382# TAGFILES = file1 file2 ...
2383# Adding location for the tag files is done as follows:
2384# TAGFILES = file1=loc1 "file2 = loc2" ...
2385# where loc1 and loc2 can be relative or absolute paths or URLs. See the
2386# section "Linking to external documentation" for more information about the use
2387# of tag files.
2388# Note: Each tag file must have a unique name (where the name does NOT include
2389# the path). If a tag file is not located in the directory in which doxygen is
2390# run, you must also specify the path to the tagfile here.
2391
2392TAGFILES =
2393
2394# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
2395# tag file that is based on the input files it reads. See section "Linking to
2396# external documentation" for more information about the usage of tag files.
2397
2398GENERATE_TAGFILE =
2399
2400# If the ALLEXTERNALS tag is set to YES, all external class will be listed in
2401# the class index. If set to NO, only the inherited external classes will be
2402# listed.
2403# The default value is: NO.
2404
2405ALLEXTERNALS = NO
2406
2407# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
2408# in the modules index. If set to NO, only the current project's groups will be
2409# listed.
2410# The default value is: YES.
2411
2412EXTERNAL_GROUPS = YES
2413
2414# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
2415# the related pages index. If set to NO, only the current project's pages will
2416# be listed.
2417# The default value is: YES.
2418
2419EXTERNAL_PAGES = YES
2420
2421# The PERL_PATH should be the absolute path and name of the perl script
2422# interpreter (i.e. the result of 'which perl').
2423# The default file (with absolute path) is: /usr/bin/perl.
2424
2425PERL_PATH = /usr/bin/perl
2426
2427#---------------------------------------------------------------------------
2428# Configuration options related to the dot tool
2429#---------------------------------------------------------------------------
2430
2431# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
2432# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
2433# NO turns the diagrams off. Note that this option also works with HAVE_DOT
2434# disabled, but it is recommended to install and use dot, since it yields more
2435# powerful graphs.
2436# The default value is: YES.
2437
2438CLASS_DIAGRAMS = YES
2439
2440# You can define message sequence charts within doxygen comments using the \msc
2441# command. Doxygen will then run the mscgen tool (see:
2442# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
2443# documentation. The MSCGEN_PATH tag allows you to specify the directory where
2444# the mscgen tool resides. If left empty the tool is assumed to be found in the
2445# default search path.
2446
2447MSCGEN_PATH =
2448
2449# You can include diagrams made with dia in doxygen documentation. Doxygen will
2450# then run dia to produce the diagram and insert it in the documentation. The
2451# DIA_PATH tag allows you to specify the directory where the dia binary resides.
2452# If left empty dia is assumed to be found in the default search path.
2453
2454DIA_PATH =
2455
2456# If set to YES the inheritance and collaboration graphs will hide inheritance
2457# and usage relations if the target is undocumented or is not a class.
2458# The default value is: YES.
2459
2460HIDE_UNDOC_RELATIONS = YES
2461
2462# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2463# available from the path. This tool is part of Graphviz (see:
2464# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
2465# Bell Labs. The other options in this section have no effect if this option is
2466# set to NO
2467# The default value is: NO.
2468
2469HAVE_DOT = YES
2470
2471# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2472# to run in parallel. When set to 0 doxygen will base this on the number of
2473# processors available in the system. You can set it explicitly to a value
2474# larger than 0 to get control over the balance between CPU load and processing
2475# speed.
2476# Minimum value: 0, maximum value: 32, default value: 0.
2477# This tag requires that the tag HAVE_DOT is set to YES.
2478
2479DOT_NUM_THREADS = 0
2480
2481# When you want a differently looking font in the dot files that doxygen
2482# generates you can specify the font name using DOT_FONTNAME. You need to make
2483# sure dot is able to find the font, which can be done by putting it in a
2484# standard location or by setting the DOTFONTPATH environment variable or by
2485# setting DOT_FONTPATH to the directory containing the font.
2486# The default value is: Helvetica.
2487# This tag requires that the tag HAVE_DOT is set to YES.
2488
2489DOT_FONTNAME = Helvetica
2490
2491# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
2492# dot graphs.
2493# Minimum value: 4, maximum value: 24, default value: 10.
2494# This tag requires that the tag HAVE_DOT is set to YES.
2495
2496DOT_FONTSIZE = 10
2497
2498# By default doxygen will tell dot to use the default font as specified with
2499# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
2500# the path where dot can find it using this tag.
2501# This tag requires that the tag HAVE_DOT is set to YES.
2502
2503DOT_FONTPATH =
2504
2505# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2506# each documented class showing the direct and indirect inheritance relations.
2507# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
2508# The default value is: YES.
2509# This tag requires that the tag HAVE_DOT is set to YES.
2510
Craig Tiller68f4e0f2015-08-05 08:18:21 -07002511CLASS_GRAPH = NO
Craig Tiller6c4ae602015-05-28 08:41:41 -07002512
2513# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2514# graph for each documented class showing the direct and indirect implementation
2515# dependencies (inheritance, containment, and class references variables) of the
2516# class with other documented classes.
2517# The default value is: YES.
2518# This tag requires that the tag HAVE_DOT is set to YES.
2519
Craig Tiller68f4e0f2015-08-05 08:18:21 -07002520COLLABORATION_GRAPH = NO
Craig Tiller6c4ae602015-05-28 08:41:41 -07002521
2522# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2523# groups, showing the direct groups dependencies.
2524# The default value is: YES.
2525# This tag requires that the tag HAVE_DOT is set to YES.
2526
Craig Tiller68f4e0f2015-08-05 08:18:21 -07002527GROUP_GRAPHS = NO
Craig Tiller6c4ae602015-05-28 08:41:41 -07002528
2529# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
2530# collaboration diagrams in a style similar to the OMG's Unified Modeling
2531# Language.
2532# The default value is: NO.
2533# This tag requires that the tag HAVE_DOT is set to YES.
2534
2535UML_LOOK = NO
2536
2537# If the UML_LOOK tag is enabled, the fields and methods are shown inside the
2538# class node. If there are many fields or methods and many nodes the graph may
2539# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2540# number of items for each type to make the size more manageable. Set this to 0
2541# for no limit. Note that the threshold may be exceeded by 50% before the limit
2542# is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2543# but if the number exceeds 15, the total amount of fields shown is limited to
2544# 10.
2545# Minimum value: 0, maximum value: 100, default value: 10.
2546# This tag requires that the tag HAVE_DOT is set to YES.
2547
2548UML_LIMIT_NUM_FIELDS = 10
2549
2550# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2551# collaboration graphs will show the relations between templates and their
2552# instances.
2553# The default value is: NO.
2554# This tag requires that the tag HAVE_DOT is set to YES.
2555
2556TEMPLATE_RELATIONS = NO
2557
2558# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2559# YES then doxygen will generate a graph for each documented file showing the
2560# direct and indirect include dependencies of the file with other documented
2561# files.
2562# The default value is: YES.
2563# This tag requires that the tag HAVE_DOT is set to YES.
2564
Craig Tiller68f4e0f2015-08-05 08:18:21 -07002565INCLUDE_GRAPH = NO
Craig Tiller6c4ae602015-05-28 08:41:41 -07002566
2567# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
2568# set to YES then doxygen will generate a graph for each documented file showing
2569# the direct and indirect include dependencies of the file with other documented
2570# files.
2571# The default value is: YES.
2572# This tag requires that the tag HAVE_DOT is set to YES.
2573
Craig Tiller68f4e0f2015-08-05 08:18:21 -07002574INCLUDED_BY_GRAPH = NO
Craig Tiller6c4ae602015-05-28 08:41:41 -07002575
2576# If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2577# dependency graph for every global function or class method.
2578#
2579# Note that enabling this option will significantly increase the time of a run.
2580# So in most cases it will be better to enable call graphs for selected
2581# functions only using the \callgraph command.
2582# The default value is: NO.
2583# This tag requires that the tag HAVE_DOT is set to YES.
2584
2585CALL_GRAPH = NO
2586
2587# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2588# dependency graph for every global function or class method.
2589#
2590# Note that enabling this option will significantly increase the time of a run.
2591# So in most cases it will be better to enable caller graphs for selected
2592# functions only using the \callergraph command.
2593# The default value is: NO.
2594# This tag requires that the tag HAVE_DOT is set to YES.
2595
2596CALLER_GRAPH = NO
2597
2598# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2599# hierarchy of all classes instead of a textual one.
2600# The default value is: YES.
2601# This tag requires that the tag HAVE_DOT is set to YES.
2602
Craig Tiller68f4e0f2015-08-05 08:18:21 -07002603GRAPHICAL_HIERARCHY = NO
Craig Tiller6c4ae602015-05-28 08:41:41 -07002604
2605# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2606# dependencies a directory has on other directories in a graphical way. The
2607# dependency relations are determined by the #include relations between the
2608# files in the directories.
2609# The default value is: YES.
2610# This tag requires that the tag HAVE_DOT is set to YES.
2611
Craig Tiller68f4e0f2015-08-05 08:18:21 -07002612DIRECTORY_GRAPH = NO
Craig Tiller6c4ae602015-05-28 08:41:41 -07002613
2614# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2615# generated by dot.
2616# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2617# to make the SVG files visible in IE 9+ (other browsers do not have this
2618# requirement).
2619# Possible values are: png, jpg, gif and svg.
2620# The default value is: png.
2621# This tag requires that the tag HAVE_DOT is set to YES.
2622
2623DOT_IMAGE_FORMAT = png
2624
2625# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2626# enable generation of interactive SVG images that allow zooming and panning.
2627#
2628# Note that this requires a modern browser other than Internet Explorer. Tested
2629# and working are Firefox, Chrome, Safari, and Opera.
2630# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2631# the SVG files visible. Older versions of IE do not have SVG support.
2632# The default value is: NO.
2633# This tag requires that the tag HAVE_DOT is set to YES.
2634
2635INTERACTIVE_SVG = NO
2636
2637# The DOT_PATH tag can be used to specify the path where the dot tool can be
2638# found. If left blank, it is assumed the dot tool can be found in the path.
2639# This tag requires that the tag HAVE_DOT is set to YES.
2640
2641DOT_PATH =
2642
2643# The DOTFILE_DIRS tag can be used to specify one or more directories that
2644# contain dot files that are included in the documentation (see the \dotfile
2645# command).
2646# This tag requires that the tag HAVE_DOT is set to YES.
2647
2648DOTFILE_DIRS =
2649
2650# The MSCFILE_DIRS tag can be used to specify one or more directories that
2651# contain msc files that are included in the documentation (see the \mscfile
2652# command).
2653
2654MSCFILE_DIRS =
2655
2656# The DIAFILE_DIRS tag can be used to specify one or more directories that
2657# contain dia files that are included in the documentation (see the \diafile
2658# command).
2659
2660DIAFILE_DIRS =
2661
2662# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
2663# path where java can find the plantuml.jar file. If left blank, it is assumed
2664# PlantUML is not used or called during a preprocessing step. Doxygen will
2665# generate a warning when it encounters a \startuml command in this case and
2666# will not generate output for the diagram.
2667
2668PLANTUML_JAR_PATH =
2669
2670# When using plantuml, the specified paths are searched for files specified by
2671# the !include statement in a plantuml block.
2672
2673PLANTUML_INCLUDE_PATH =
2674
2675# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2676# that will be shown in the graph. If the number of nodes in a graph becomes
2677# larger than this value, doxygen will truncate the graph, which is visualized
2678# by representing a node as a red box. Note that doxygen if the number of direct
2679# children of the root node in a graph is already larger than
2680# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2681# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2682# Minimum value: 0, maximum value: 10000, default value: 50.
2683# This tag requires that the tag HAVE_DOT is set to YES.
2684
2685DOT_GRAPH_MAX_NODES = 50
2686
2687# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2688# generated by dot. A depth value of 3 means that only nodes reachable from the
2689# root by following a path via at most 3 edges will be shown. Nodes that lay
2690# further from the root node will be omitted. Note that setting this option to 1
2691# or 2 may greatly reduce the computation time needed for large code bases. Also
2692# note that the size of a graph can be further restricted by
2693# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
2694# Minimum value: 0, maximum value: 1000, default value: 0.
2695# This tag requires that the tag HAVE_DOT is set to YES.
2696
2697MAX_DOT_GRAPH_DEPTH = 0
2698
2699# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2700# background. This is disabled by default, because dot on Windows does not seem
2701# to support this out of the box.
2702#
2703# Warning: Depending on the platform used, enabling this option may lead to
2704# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2705# read).
2706# The default value is: NO.
2707# This tag requires that the tag HAVE_DOT is set to YES.
2708
2709DOT_TRANSPARENT = NO
2710
2711# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
2712# files in one run (i.e. multiple -o and -T options on the command line). This
2713# makes dot run faster, but since only newer versions of dot (>1.8.10) support
2714# this, this feature is disabled by default.
2715# The default value is: NO.
2716# This tag requires that the tag HAVE_DOT is set to YES.
2717
2718DOT_MULTI_TARGETS = NO
2719
2720# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2721# explaining the meaning of the various boxes and arrows in the dot generated
2722# graphs.
2723# The default value is: YES.
2724# This tag requires that the tag HAVE_DOT is set to YES.
2725
2726GENERATE_LEGEND = YES
2727
2728# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
2729# files that are used to generate the various graphs.
2730# The default value is: YES.
2731# This tag requires that the tag HAVE_DOT is set to YES.
2732
2733DOT_CLEANUP = YES
2734