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