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