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