9044ea667c6d326864f52421e30302f6e1a474a3
[platform/upstream/grpc.git] / tools / doxygen / Doxyfile.objc
1
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
29 DOXYFILE_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
37 PROJECT_NAME           = "GRPC Objective-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
43 PROJECT_NUMBER         = 1.37.0
44
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
49 PROJECT_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
56 PROJECT_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
63 OUTPUT_DIRECTORY       = doc/ref/objc
64
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
73 CREATE_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
81 ALLOW_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
96 OUTPUT_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
103 BRIEF_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
112 REPEAT_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
123 ABBREVIATE_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
130 ALWAYS_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
138 INLINE_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
145 FULL_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
157 STRIP_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
166 STRIP_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
173 SHORT_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
182 JAVADOC_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
190 QT_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
202 MULTILINE_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
208 INHERIT_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
215 SEPARATE_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
221 TAB_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
233 ALIASES                =
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
239 TCL_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
247 OPTIMIZE_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
255 OPTIMIZE_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
261 OPTIMIZE_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
267 OPTIMIZE_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
286 EXTENSION_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
296 MARKDOWN_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
304 AUTOLINK_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
314 BUILTIN_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
320 CPP_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
328 SIP_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
338 IDL_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
346 DISTRIBUTE_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
355 SUBGROUPING            = 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
366 INLINE_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
376 INLINE_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
387 TYPEDEF_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
400 LOOKUP_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
414 EXTRACT_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
420 EXTRACT_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
426 EXTRACT_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
432 EXTRACT_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
440 EXTRACT_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
448 EXTRACT_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
457 EXTRACT_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
465 HIDE_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
473 HIDE_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
480 HIDE_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
487 HIDE_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
494 INTERNAL_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
503 CASE_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
510 HIDE_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
517 HIDE_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
523 SHOW_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
530 SHOW_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
536 FORCE_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
542 INLINE_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
549 SORT_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
557 SORT_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
569 SORT_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
576 SORT_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
586 SORT_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
596 STRICT_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
602 GENERATE_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
608 GENERATE_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
614 GENERATE_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
621 GENERATE_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
627 ENABLED_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
638 MAX_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
645 SHOW_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
652 SHOW_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
659 SHOW_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
669 FILE_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
682 LAYOUT_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
692 CITE_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
703 QUIET                  = 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
712 WARNINGS               = 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
719 WARN_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
727 WARN_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
735 WARN_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
745 WARN_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
751 WARN_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
763 INPUT                  = doc/PROTOCOL-HTTP2.md \
764 doc/PROTOCOL-WEB.md \
765 doc/binary-logging.md \
766 doc/c-style-guide.md \
767 doc/command_line_tool.md \
768 doc/compression.md \
769 doc/compression_cookbook.md \
770 doc/connection-backoff-interop-test-description.md \
771 doc/connection-backoff.md \
772 doc/connectivity-semantics-and-api.md \
773 doc/cpp-style-guide.md \
774 doc/environment_variables.md \
775 doc/fail_fast.md \
776 doc/fork_support.md \
777 doc/g_stands_for.md \
778 doc/grpc_release_schedule.md \
779 doc/grpc_xds_features.md \
780 doc/health-checking.md \
781 doc/http-grpc-status-mapping.md \
782 doc/http2-interop-test-descriptions.md \
783 doc/internationalization.md \
784 doc/interop-test-descriptions.md \
785 doc/keepalive.md \
786 doc/load-balancing.md \
787 doc/naming.md \
788 doc/security_audit.md \
789 doc/server-reflection.md \
790 doc/server_reflection_tutorial.md \
791 doc/server_side_auth.md \
792 doc/service_config.md \
793 doc/ssl-performance.md \
794 doc/status_ordering.md \
795 doc/statuscodes.md \
796 doc/unit_testing.md \
797 doc/versioning.md \
798 doc/wait-for-ready.md \
799 doc/workarounds.md \
800 doc/xds-test-descriptions.md \
801 src/objective-c/GRPCClient/GRPCCall+ChannelArg.h \
802 src/objective-c/GRPCClient/GRPCCall+ChannelCredentials.h \
803 src/objective-c/GRPCClient/GRPCCall+Cronet.h \
804 src/objective-c/GRPCClient/GRPCCall+GID.h \
805 src/objective-c/GRPCClient/GRPCCall+Interceptor.h \
806 src/objective-c/GRPCClient/GRPCCall+OAuth2.h \
807 src/objective-c/GRPCClient/GRPCCall+Tests.h \
808 src/objective-c/GRPCClient/GRPCCall.h \
809 src/objective-c/GRPCClient/GRPCCallLegacy.h \
810 src/objective-c/GRPCClient/GRPCCallOptions.h \
811 src/objective-c/GRPCClient/GRPCDispatchable.h \
812 src/objective-c/GRPCClient/GRPCInterceptor.h \
813 src/objective-c/GRPCClient/GRPCTransport.h \
814 src/objective-c/GRPCClient/GRPCTypes.h \
815 src/objective-c/GRPCClient/README.md \
816 src/objective-c/GRPCClient/version.h \
817 src/objective-c/NetworkTransitionBehavior.md \
818 src/objective-c/ProtoRPC/ProtoMethod.h \
819 src/objective-c/ProtoRPC/ProtoRPC.h \
820 src/objective-c/ProtoRPC/ProtoRPCLegacy.h \
821 src/objective-c/ProtoRPC/ProtoService.h \
822 src/objective-c/ProtoRPC/ProtoServiceLegacy.h \
823 src/objective-c/README-CFSTREAM.md \
824 src/objective-c/README.md \
825 src/objective-c/RxLibrary/GRXBufferedPipe.h \
826 src/objective-c/RxLibrary/GRXConcurrentWriteable.h \
827 src/objective-c/RxLibrary/GRXForwardingWriter.h \
828 src/objective-c/RxLibrary/GRXImmediateSingleWriter.h \
829 src/objective-c/RxLibrary/GRXImmediateWriter.h \
830 src/objective-c/RxLibrary/GRXMappingWriter.h \
831 src/objective-c/RxLibrary/GRXWriteable.h \
832 src/objective-c/RxLibrary/GRXWriter+Immediate.h \
833 src/objective-c/RxLibrary/GRXWriter+Transformations.h \
834 src/objective-c/RxLibrary/GRXWriter.h \
835 src/objective-c/RxLibrary/NSEnumerator+GRXUtil.h \
836 src/objective-c/RxLibrary/README.md \
837 src/objective-c/examples/Sample/README.md \
838 src/objective-c/tests/Connectivity/README.md
839
840 # This tag can be used to specify the character encoding of the source files
841 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
842 # libiconv (or the iconv built into libc) for the transcoding. See the libiconv
843 # documentation (see: http://www.gnu.org/software/libiconv) for the list of
844 # possible encodings.
845 # The default value is: UTF-8.
846
847 INPUT_ENCODING         = UTF-8
848
849 # If the value of the INPUT tag contains directories, you can use the
850 # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
851 # *.h) to filter out the source-files in the directories. If left blank the
852 # following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii,
853 # *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,
854 # *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,
855 # *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
856 # *.qsf, *.as and *.js.
857
858 FILE_PATTERNS          =
859
860 # The RECURSIVE tag can be used to specify whether or not subdirectories should
861 # be searched for input files as well.
862 # The default value is: NO.
863
864 RECURSIVE              = NO
865
866 # The EXCLUDE tag can be used to specify files and/or directories that should be
867 # excluded from the INPUT source files. This way you can easily exclude a
868 # subdirectory from a directory tree whose root is specified with the INPUT tag.
869 #
870 # Note that relative paths are relative to the directory from which doxygen is
871 # run.
872
873 EXCLUDE                =
874
875 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
876 # directories that are symbolic links (a Unix file system feature) are excluded
877 # from the input.
878 # The default value is: NO.
879
880 EXCLUDE_SYMLINKS       = NO
881
882 # If the value of the INPUT tag contains directories, you can use the
883 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
884 # certain files from those directories.
885 #
886 # Note that the wildcards are matched against the file with absolute path, so to
887 # exclude all test directories for example use the pattern */test/*
888
889 EXCLUDE_PATTERNS       =
890
891 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
892 # (namespaces, classes, functions, etc.) that should be excluded from the
893 # output. The symbol name can be a fully qualified name, a word, or if the
894 # wildcard * is used, a substring. Examples: ANamespace, AClass,
895 # AClass::ANamespace, ANamespace::*Test
896 #
897 # Note that the wildcards are matched against the file with absolute path, so to
898 # exclude all test directories use the pattern */test/*
899
900 EXCLUDE_SYMBOLS        =
901
902 # The EXAMPLE_PATH tag can be used to specify one or more files or directories
903 # that contain example code fragments that are included (see the \include
904 # command).
905
906 EXAMPLE_PATH           =
907
908 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
909 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
910 # *.h) to filter out the source-files in the directories. If left blank all
911 # files are included.
912
913 EXAMPLE_PATTERNS       =
914
915 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
916 # searched for input files to be used with the \include or \dontinclude commands
917 # irrespective of the value of the RECURSIVE tag.
918 # The default value is: NO.
919
920 EXAMPLE_RECURSIVE      = NO
921
922 # The IMAGE_PATH tag can be used to specify one or more files or directories
923 # that contain images that are to be included in the documentation (see the
924 # \image command).
925
926 IMAGE_PATH             =
927
928 # The INPUT_FILTER tag can be used to specify a program that doxygen should
929 # invoke to filter for each input file. Doxygen will invoke the filter program
930 # by executing (via popen()) the command:
931 #
932 # <filter> <input-file>
933 #
934 # where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
935 # name of an input file. Doxygen will then use the output that the filter
936 # program writes to standard output. If FILTER_PATTERNS is specified, this tag
937 # will be ignored.
938 #
939 # Note that the filter must not add or remove lines; it is applied before the
940 # code is scanned, but not when the output code is generated. If lines are added
941 # or removed, the anchors will not be placed correctly.
942
943 INPUT_FILTER           =
944
945 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
946 # basis. Doxygen will compare the file name with each pattern and apply the
947 # filter if there is a match. The filters are a list of the form: pattern=filter
948 # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
949 # filters are used. If the FILTER_PATTERNS tag is empty or if none of the
950 # patterns match the file name, INPUT_FILTER is applied.
951
952 FILTER_PATTERNS        =
953
954 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
955 # INPUT_FILTER) will also be used to filter the input files that are used for
956 # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
957 # The default value is: NO.
958
959 FILTER_SOURCE_FILES    = NO
960
961 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
962 # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
963 # it is also possible to disable source filtering for a specific pattern using
964 # *.ext= (so without naming a filter).
965 # This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
966
967 FILTER_SOURCE_PATTERNS =
968
969 # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
970 # is part of the input, its contents will be placed on the main page
971 # (index.html). This can be useful if you have a project on for instance GitHub
972 # and want to reuse the introduction page also for the doxygen output.
973
974 USE_MDFILE_AS_MAINPAGE =
975
976 #---------------------------------------------------------------------------
977 # Configuration options related to source browsing
978 #---------------------------------------------------------------------------
979
980 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
981 # generated. Documented entities will be cross-referenced with these sources.
982 #
983 # Note: To get rid of all source code in the generated output, make sure that
984 # also VERBATIM_HEADERS is set to NO.
985 # The default value is: NO.
986
987 SOURCE_BROWSER         = NO
988
989 # Setting the INLINE_SOURCES tag to YES will include the body of functions,
990 # classes and enums directly into the documentation.
991 # The default value is: NO.
992
993 INLINE_SOURCES         = NO
994
995 # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
996 # special comment blocks from generated source code fragments. Normal C, C++ and
997 # Fortran comments will always remain visible.
998 # The default value is: YES.
999
1000 STRIP_CODE_COMMENTS    = YES
1001
1002 # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
1003 # function all documented functions referencing it will be listed.
1004 # The default value is: NO.
1005
1006 REFERENCED_BY_RELATION = NO
1007
1008 # If the REFERENCES_RELATION tag is set to YES then for each documented function
1009 # all documented entities called/used by that function will be listed.
1010 # The default value is: NO.
1011
1012 REFERENCES_RELATION    = NO
1013
1014 # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
1015 # to YES then the hyperlinks from functions in REFERENCES_RELATION and
1016 # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
1017 # link to the documentation.
1018 # The default value is: YES.
1019
1020 REFERENCES_LINK_SOURCE = YES
1021
1022 # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
1023 # source code will show a tooltip with additional information such as prototype,
1024 # brief description and links to the definition and documentation. Since this
1025 # will make the HTML file larger and loading of large files a bit slower, you
1026 # can opt to disable this feature.
1027 # The default value is: YES.
1028 # This tag requires that the tag SOURCE_BROWSER is set to YES.
1029
1030 SOURCE_TOOLTIPS        = YES
1031
1032 # If the USE_HTAGS tag is set to YES then the references to source code will
1033 # point to the HTML generated by the htags(1) tool instead of doxygen built-in
1034 # source browser. The htags tool is part of GNU's global source tagging system
1035 # (see http://www.gnu.org/software/global/global.html). You will need version
1036 # 4.8.6 or higher.
1037 #
1038 # To use it do the following:
1039 # - Install the latest version of global
1040 # - Enable SOURCE_BROWSER and USE_HTAGS in the config file
1041 # - Make sure the INPUT points to the root of the source tree
1042 # - Run doxygen as normal
1043 #
1044 # Doxygen will invoke htags (and that will in turn invoke gtags), so these
1045 # tools must be available from the command line (i.e. in the search path).
1046 #
1047 # The result: instead of the source browser generated by doxygen, the links to
1048 # source code will now point to the output of htags.
1049 # The default value is: NO.
1050 # This tag requires that the tag SOURCE_BROWSER is set to YES.
1051
1052 USE_HTAGS              = NO
1053
1054 # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
1055 # verbatim copy of the header file for each class for which an include is
1056 # specified. Set to NO to disable this.
1057 # See also: Section \class.
1058 # The default value is: YES.
1059
1060 VERBATIM_HEADERS       = YES
1061
1062 #---------------------------------------------------------------------------
1063 # Configuration options related to the alphabetical class index
1064 #---------------------------------------------------------------------------
1065
1066 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1067 # compounds will be generated. Enable this if the project contains a lot of
1068 # classes, structs, unions or interfaces.
1069 # The default value is: YES.
1070
1071 ALPHABETICAL_INDEX     = YES
1072
1073 # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
1074 # which the alphabetical index list will be split.
1075 # Minimum value: 1, maximum value: 20, default value: 5.
1076 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1077
1078 COLS_IN_ALPHA_INDEX    = 5
1079
1080 # In case all classes in a project start with a common prefix, all classes will
1081 # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
1082 # can be used to specify a prefix (or a list of prefixes) that should be ignored
1083 # while generating the index headers.
1084 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1085
1086 IGNORE_PREFIX          =
1087
1088 #---------------------------------------------------------------------------
1089 # Configuration options related to the HTML output
1090 #---------------------------------------------------------------------------
1091
1092 # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
1093 # The default value is: YES.
1094
1095 GENERATE_HTML          = YES
1096
1097 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1098 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1099 # it.
1100 # The default directory is: html.
1101 # This tag requires that the tag GENERATE_HTML is set to YES.
1102
1103 HTML_OUTPUT            = html
1104
1105 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1106 # generated HTML page (for example: .htm, .php, .asp).
1107 # The default value is: .html.
1108 # This tag requires that the tag GENERATE_HTML is set to YES.
1109
1110 HTML_FILE_EXTENSION    = .html
1111
1112 # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1113 # each generated HTML page. If the tag is left blank doxygen will generate a
1114 # standard header.
1115 #
1116 # To get valid HTML the header file that includes any scripts and style sheets
1117 # that doxygen needs, which is dependent on the configuration options used (e.g.
1118 # the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1119 # default header using
1120 # doxygen -w html new_header.html new_footer.html new_stylesheet.css
1121 # YourConfigFile
1122 # and then modify the file new_header.html. See also section "Doxygen usage"
1123 # for information on how to generate the default header that doxygen normally
1124 # uses.
1125 # Note: The header is subject to change so you typically have to regenerate the
1126 # default header when upgrading to a newer version of doxygen. For a description
1127 # of the possible markers and block names see the documentation.
1128 # This tag requires that the tag GENERATE_HTML is set to YES.
1129
1130 HTML_HEADER            =
1131
1132 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1133 # generated HTML page. If the tag is left blank doxygen will generate a standard
1134 # footer. See HTML_HEADER for more information on how to generate a default
1135 # footer and what special commands can be used inside the footer. See also
1136 # section "Doxygen usage" for information on how to generate the default footer
1137 # that doxygen normally uses.
1138 # This tag requires that the tag GENERATE_HTML is set to YES.
1139
1140 HTML_FOOTER            =
1141
1142 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1143 # sheet that is used by each HTML page. It can be used to fine-tune the look of
1144 # the HTML output. If left blank doxygen will generate a default style sheet.
1145 # See also section "Doxygen usage" for information on how to generate the style
1146 # sheet that doxygen normally uses.
1147 # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1148 # it is more robust and this tag (HTML_STYLESHEET) will in the future become
1149 # obsolete.
1150 # This tag requires that the tag GENERATE_HTML is set to YES.
1151
1152 HTML_STYLESHEET        =
1153
1154 # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1155 # cascading style sheets that are included after the standard style sheets
1156 # created by doxygen. Using this option one can overrule certain style aspects.
1157 # This is preferred over using HTML_STYLESHEET since it does not replace the
1158 # standard style sheet and is therefore more robust against future updates.
1159 # Doxygen will copy the style sheet files to the output directory.
1160 # Note: The order of the extra style sheet files is of importance (e.g. the last
1161 # style sheet in the list overrules the setting of the previous ones in the
1162 # list). For an example see the documentation.
1163 # This tag requires that the tag GENERATE_HTML is set to YES.
1164
1165 HTML_EXTRA_STYLESHEET  =
1166
1167 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1168 # other source files which should be copied to the HTML output directory. Note
1169 # that these files will be copied to the base HTML output directory. Use the
1170 # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1171 # files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1172 # files will be copied as-is; there are no commands or markers available.
1173 # This tag requires that the tag GENERATE_HTML is set to YES.
1174
1175 HTML_EXTRA_FILES       =
1176
1177 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
1178 # will adjust the colors in the style sheet and background images according to
1179 # this color. Hue is specified as an angle on a colorwheel, see
1180 # http://en.wikipedia.org/wiki/Hue for more information. For instance the value
1181 # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
1182 # purple, and 360 is red again.
1183 # Minimum value: 0, maximum value: 359, default value: 220.
1184 # This tag requires that the tag GENERATE_HTML is set to YES.
1185
1186 HTML_COLORSTYLE_HUE    = 220
1187
1188 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
1189 # in the HTML output. For a value of 0 the output will use grayscales only. A
1190 # value of 255 will produce the most vivid colors.
1191 # Minimum value: 0, maximum value: 255, default value: 100.
1192 # This tag requires that the tag GENERATE_HTML is set to YES.
1193
1194 HTML_COLORSTYLE_SAT    = 100
1195
1196 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1197 # luminance component of the colors in the HTML output. Values below 100
1198 # gradually make the output lighter, whereas values above 100 make the output
1199 # darker. The value divided by 100 is the actual gamma applied, so 80 represents
1200 # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1201 # change the gamma.
1202 # Minimum value: 40, maximum value: 240, default value: 80.
1203 # This tag requires that the tag GENERATE_HTML is set to YES.
1204
1205 HTML_COLORSTYLE_GAMMA  = 80
1206
1207 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1208 # page will contain the date and time when the page was generated. Setting this
1209 # to NO can help when comparing the output of multiple runs.
1210 # The default value is: YES.
1211 # This tag requires that the tag GENERATE_HTML is set to YES.
1212
1213 HTML_TIMESTAMP         = YES
1214
1215 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1216 # documentation will contain sections that can be hidden and shown after the
1217 # page has loaded.
1218 # The default value is: NO.
1219 # This tag requires that the tag GENERATE_HTML is set to YES.
1220
1221 HTML_DYNAMIC_SECTIONS  = NO
1222
1223 # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
1224 # shown in the various tree structured indices initially; the user can expand
1225 # and collapse entries dynamically later on. Doxygen will expand the tree to
1226 # such a level that at most the specified number of entries are visible (unless
1227 # a fully collapsed tree already exceeds this amount). So setting the number of
1228 # entries 1 will produce a full collapsed tree by default. 0 is a special value
1229 # representing an infinite number of entries and will result in a full expanded
1230 # tree by default.
1231 # Minimum value: 0, maximum value: 9999, default value: 100.
1232 # This tag requires that the tag GENERATE_HTML is set to YES.
1233
1234 HTML_INDEX_NUM_ENTRIES = 100
1235
1236 # If the GENERATE_DOCSET tag is set to YES, additional index files will be
1237 # generated that can be used as input for Apple's Xcode 3 integrated development
1238 # environment (see: http://developer.apple.com/tools/xcode/), introduced with
1239 # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
1240 # Makefile in the HTML output directory. Running make will produce the docset in
1241 # that directory and running make install will install the docset in
1242 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1243 # startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
1244 # for more information.
1245 # The default value is: NO.
1246 # This tag requires that the tag GENERATE_HTML is set to YES.
1247
1248 GENERATE_DOCSET        = NO
1249
1250 # This tag determines the name of the docset feed. A documentation feed provides
1251 # an umbrella under which multiple documentation sets from a single provider
1252 # (such as a company or product suite) can be grouped.
1253 # The default value is: Doxygen generated docs.
1254 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1255
1256 DOCSET_FEEDNAME        = "Doxygen generated docs"
1257
1258 # This tag specifies a string that should uniquely identify the documentation
1259 # set bundle. This should be a reverse domain-name style string, e.g.
1260 # com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1261 # The default value is: org.doxygen.Project.
1262 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1263
1264 DOCSET_BUNDLE_ID       = org.doxygen.Project
1265
1266 # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1267 # the documentation publisher. This should be a reverse domain-name style
1268 # string, e.g. com.mycompany.MyDocSet.documentation.
1269 # The default value is: org.doxygen.Publisher.
1270 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1271
1272 DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
1273
1274 # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1275 # The default value is: Publisher.
1276 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1277
1278 DOCSET_PUBLISHER_NAME  = Publisher
1279
1280 # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1281 # additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1282 # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1283 # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
1284 # Windows.
1285 #
1286 # The HTML Help Workshop contains a compiler that can convert all HTML output
1287 # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1288 # files are now used as the Windows 98 help format, and will replace the old
1289 # Windows help format (.hlp) on all Windows platforms in the future. Compressed
1290 # HTML files also contain an index, a table of contents, and you can search for
1291 # words in the documentation. The HTML workshop also contains a viewer for
1292 # compressed HTML files.
1293 # The default value is: NO.
1294 # This tag requires that the tag GENERATE_HTML is set to YES.
1295
1296 GENERATE_HTMLHELP      = NO
1297
1298 # The CHM_FILE tag can be used to specify the file name of the resulting .chm
1299 # file. You can add a path in front of the file if the result should not be
1300 # written to the html output directory.
1301 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1302
1303 CHM_FILE               =
1304
1305 # The HHC_LOCATION tag can be used to specify the location (absolute path
1306 # including file name) of the HTML help compiler (hhc.exe). If non-empty,
1307 # doxygen will try to run the HTML help compiler on the generated index.hhp.
1308 # The file has to be specified with full path.
1309 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1310
1311 HHC_LOCATION           =
1312
1313 # The GENERATE_CHI flag controls if a separate .chi index file is generated
1314 # (YES) or that it should be included in the master .chm file (NO).
1315 # The default value is: NO.
1316 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1317
1318 GENERATE_CHI           = NO
1319
1320 # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
1321 # and project file content.
1322 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1323
1324 CHM_INDEX_ENCODING     =
1325
1326 # The BINARY_TOC flag controls whether a binary table of contents is generated
1327 # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
1328 # enables the Previous and Next buttons.
1329 # The default value is: NO.
1330 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1331
1332 BINARY_TOC             = NO
1333
1334 # The TOC_EXPAND flag can be set to YES to add extra items for group members to
1335 # the table of contents of the HTML help documentation and to the tree view.
1336 # The default value is: NO.
1337 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1338
1339 TOC_EXPAND             = NO
1340
1341 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1342 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1343 # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1344 # (.qch) of the generated HTML documentation.
1345 # The default value is: NO.
1346 # This tag requires that the tag GENERATE_HTML is set to YES.
1347
1348 GENERATE_QHP           = NO
1349
1350 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1351 # the file name of the resulting .qch file. The path specified is relative to
1352 # the HTML output folder.
1353 # This tag requires that the tag GENERATE_QHP is set to YES.
1354
1355 QCH_FILE               =
1356
1357 # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1358 # Project output. For more information please see Qt Help Project / Namespace
1359 # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
1360 # The default value is: org.doxygen.Project.
1361 # This tag requires that the tag GENERATE_QHP is set to YES.
1362
1363 QHP_NAMESPACE          = org.doxygen.Project
1364
1365 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1366 # Help Project output. For more information please see Qt Help Project / Virtual
1367 # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
1368 # folders).
1369 # The default value is: doc.
1370 # This tag requires that the tag GENERATE_QHP is set to YES.
1371
1372 QHP_VIRTUAL_FOLDER     = doc
1373
1374 # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1375 # filter to add. For more information please see Qt Help Project / Custom
1376 # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1377 # filters).
1378 # This tag requires that the tag GENERATE_QHP is set to YES.
1379
1380 QHP_CUST_FILTER_NAME   =
1381
1382 # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
1383 # custom filter to add. For more information please see Qt Help Project / Custom
1384 # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1385 # filters).
1386 # This tag requires that the tag GENERATE_QHP is set to YES.
1387
1388 QHP_CUST_FILTER_ATTRS  =
1389
1390 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1391 # project's filter section matches. Qt Help Project / Filter Attributes (see:
1392 # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
1393 # This tag requires that the tag GENERATE_QHP is set to YES.
1394
1395 QHP_SECT_FILTER_ATTRS  =
1396
1397 # The QHG_LOCATION tag can be used to specify the location of Qt's
1398 # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
1399 # generated .qhp file.
1400 # This tag requires that the tag GENERATE_QHP is set to YES.
1401
1402 QHG_LOCATION           =
1403
1404 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1405 # generated, together with the HTML files, they form an Eclipse help plugin. To
1406 # install this plugin and make it available under the help contents menu in
1407 # Eclipse, the contents of the directory containing the HTML and XML files needs
1408 # to be copied into the plugins directory of eclipse. The name of the directory
1409 # within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1410 # After copying Eclipse needs to be restarted before the help appears.
1411 # The default value is: NO.
1412 # This tag requires that the tag GENERATE_HTML is set to YES.
1413
1414 GENERATE_ECLIPSEHELP   = NO
1415
1416 # A unique identifier for the Eclipse help plugin. When installing the plugin
1417 # the directory name containing the HTML and XML files should also have this
1418 # name. Each documentation set should have its own identifier.
1419 # The default value is: org.doxygen.Project.
1420 # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1421
1422 ECLIPSE_DOC_ID         = org.doxygen.Project
1423
1424 # If you want full control over the layout of the generated HTML pages it might
1425 # be necessary to disable the index and replace it with your own. The
1426 # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1427 # of each HTML page. A value of NO enables the index and the value YES disables
1428 # it. Since the tabs in the index contain the same information as the navigation
1429 # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1430 # The default value is: NO.
1431 # This tag requires that the tag GENERATE_HTML is set to YES.
1432
1433 DISABLE_INDEX          = NO
1434
1435 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1436 # structure should be generated to display hierarchical information. If the tag
1437 # value is set to YES, a side panel will be generated containing a tree-like
1438 # index structure (just like the one that is generated for HTML Help). For this
1439 # to work a browser that supports JavaScript, DHTML, CSS and frames is required
1440 # (i.e. any modern browser). Windows users are probably better off using the
1441 # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
1442 # further fine-tune the look of the index. As an example, the default style
1443 # sheet generated by doxygen has an example that shows how to put an image at
1444 # the root of the tree instead of the PROJECT_NAME. Since the tree basically has
1445 # the same information as the tab index, you could consider setting
1446 # DISABLE_INDEX to YES when enabling this option.
1447 # The default value is: NO.
1448 # This tag requires that the tag GENERATE_HTML is set to YES.
1449
1450 GENERATE_TREEVIEW      = NO
1451
1452 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1453 # doxygen will group on one line in the generated HTML documentation.
1454 #
1455 # Note that a value of 0 will completely suppress the enum values from appearing
1456 # in the overview section.
1457 # Minimum value: 0, maximum value: 20, default value: 4.
1458 # This tag requires that the tag GENERATE_HTML is set to YES.
1459
1460 ENUM_VALUES_PER_LINE   = 4
1461
1462 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1463 # to set the initial width (in pixels) of the frame in which the tree is shown.
1464 # Minimum value: 0, maximum value: 1500, default value: 250.
1465 # This tag requires that the tag GENERATE_HTML is set to YES.
1466
1467 TREEVIEW_WIDTH         = 250
1468
1469 # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
1470 # external symbols imported via tag files in a separate window.
1471 # The default value is: NO.
1472 # This tag requires that the tag GENERATE_HTML is set to YES.
1473
1474 EXT_LINKS_IN_WINDOW    = NO
1475
1476 # Use this tag to change the font size of LaTeX formulas included as images in
1477 # the HTML documentation. When you change the font size after a successful
1478 # doxygen run you need to manually remove any form_*.png images from the HTML
1479 # output directory to force them to be regenerated.
1480 # Minimum value: 8, maximum value: 50, default value: 10.
1481 # This tag requires that the tag GENERATE_HTML is set to YES.
1482
1483 FORMULA_FONTSIZE       = 10
1484
1485 # Use the FORMULA_TRANPARENT tag to determine whether or not the images
1486 # generated for formulas are transparent PNGs. Transparent PNGs are not
1487 # supported properly for IE 6.0, but are supported on all modern browsers.
1488 #
1489 # Note that when changing this option you need to delete any form_*.png files in
1490 # the HTML output directory before the changes have effect.
1491 # The default value is: YES.
1492 # This tag requires that the tag GENERATE_HTML is set to YES.
1493
1494 FORMULA_TRANSPARENT    = YES
1495
1496 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1497 # http://www.mathjax.org) which uses client side Javascript for the rendering
1498 # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
1499 # installed or if you want to formulas look prettier in the HTML output. When
1500 # enabled you may also need to install MathJax separately and configure the path
1501 # to it using the MATHJAX_RELPATH option.
1502 # The default value is: NO.
1503 # This tag requires that the tag GENERATE_HTML is set to YES.
1504
1505 USE_MATHJAX            = NO
1506
1507 # When MathJax is enabled you can set the default output format to be used for
1508 # the MathJax output. See the MathJax site (see:
1509 # http://docs.mathjax.org/en/latest/output.html) for more details.
1510 # Possible values are: HTML-CSS (which is slower, but has the best
1511 # compatibility), NativeMML (i.e. MathML) and SVG.
1512 # The default value is: HTML-CSS.
1513 # This tag requires that the tag USE_MATHJAX is set to YES.
1514
1515 MATHJAX_FORMAT         = HTML-CSS
1516
1517 # When MathJax is enabled you need to specify the location relative to the HTML
1518 # output directory using the MATHJAX_RELPATH option. The destination directory
1519 # should contain the MathJax.js script. For instance, if the mathjax directory
1520 # is located at the same level as the HTML output directory, then
1521 # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1522 # Content Delivery Network so you can quickly see the result without installing
1523 # MathJax. However, it is strongly recommended to install a local copy of
1524 # MathJax from http://www.mathjax.org before deployment.
1525 # The default value is: http://cdn.mathjax.org/mathjax/latest.
1526 # This tag requires that the tag USE_MATHJAX is set to YES.
1527
1528 MATHJAX_RELPATH        = http://cdn.mathjax.org/mathjax/latest
1529
1530 # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1531 # extension names that should be enabled during MathJax rendering. For example
1532 # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
1533 # This tag requires that the tag USE_MATHJAX is set to YES.
1534
1535 MATHJAX_EXTENSIONS     =
1536
1537 # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1538 # of code that will be used on startup of the MathJax code. See the MathJax site
1539 # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
1540 # example see the documentation.
1541 # This tag requires that the tag USE_MATHJAX is set to YES.
1542
1543 MATHJAX_CODEFILE       =
1544
1545 # When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1546 # the HTML output. The underlying search engine uses javascript and DHTML and
1547 # should work on any modern browser. Note that when using HTML help
1548 # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
1549 # there is already a search function so this one should typically be disabled.
1550 # For large projects the javascript based search engine can be slow, then
1551 # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1552 # search using the keyboard; to jump to the search box use <access key> + S
1553 # (what the <access key> is depends on the OS and browser, but it is typically
1554 # <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
1555 # key> to jump into the search results window, the results can be navigated
1556 # using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1557 # the search. The filter options can be selected when the cursor is inside the
1558 # search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
1559 # to select a filter and <Enter> or <escape> to activate or cancel the filter
1560 # option.
1561 # The default value is: YES.
1562 # This tag requires that the tag GENERATE_HTML is set to YES.
1563
1564 SEARCHENGINE           = YES
1565
1566 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1567 # implemented using a web server instead of a web client using Javascript. There
1568 # are two flavors of web server based searching depending on the EXTERNAL_SEARCH
1569 # setting. When disabled, doxygen will generate a PHP script for searching and
1570 # an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
1571 # and searching needs to be provided by external tools. See the section
1572 # "External Indexing and Searching" for details.
1573 # The default value is: NO.
1574 # This tag requires that the tag SEARCHENGINE is set to YES.
1575
1576 SERVER_BASED_SEARCH    = NO
1577
1578 # When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1579 # script for searching. Instead the search results are written to an XML file
1580 # which needs to be processed by an external indexer. Doxygen will invoke an
1581 # external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1582 # search results.
1583 #
1584 # Doxygen ships with an example indexer (doxyindexer) and search engine
1585 # (doxysearch.cgi) which are based on the open source search engine library
1586 # Xapian (see: http://xapian.org/).
1587 #
1588 # See the section "External Indexing and Searching" for details.
1589 # The default value is: NO.
1590 # This tag requires that the tag SEARCHENGINE is set to YES.
1591
1592 EXTERNAL_SEARCH        = NO
1593
1594 # The SEARCHENGINE_URL should point to a search engine hosted by a web server
1595 # which will return the search results when EXTERNAL_SEARCH is enabled.
1596 #
1597 # Doxygen ships with an example indexer (doxyindexer) and search engine
1598 # (doxysearch.cgi) which are based on the open source search engine library
1599 # Xapian (see: http://xapian.org/). See the section "External Indexing and
1600 # Searching" for details.
1601 # This tag requires that the tag SEARCHENGINE is set to YES.
1602
1603 SEARCHENGINE_URL       =
1604
1605 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
1606 # search data is written to a file for indexing by an external tool. With the
1607 # SEARCHDATA_FILE tag the name of this file can be specified.
1608 # The default file is: searchdata.xml.
1609 # This tag requires that the tag SEARCHENGINE is set to YES.
1610
1611 SEARCHDATA_FILE        = searchdata.xml
1612
1613 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
1614 # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1615 # useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1616 # projects and redirect the results back to the right project.
1617 # This tag requires that the tag SEARCHENGINE is set to YES.
1618
1619 EXTERNAL_SEARCH_ID     =
1620
1621 # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1622 # projects other than the one defined by this configuration file, but that are
1623 # all added to the same external search index. Each project needs to have a
1624 # unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
1625 # to a relative location where the documentation can be found. The format is:
1626 # EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
1627 # This tag requires that the tag SEARCHENGINE is set to YES.
1628
1629 EXTRA_SEARCH_MAPPINGS  =
1630
1631 #---------------------------------------------------------------------------
1632 # Configuration options related to the LaTeX output
1633 #---------------------------------------------------------------------------
1634
1635 # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
1636 # The default value is: YES.
1637
1638 GENERATE_LATEX         = NO
1639
1640 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1641 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1642 # it.
1643 # The default directory is: latex.
1644 # This tag requires that the tag GENERATE_LATEX is set to YES.
1645
1646 LATEX_OUTPUT           = latex
1647
1648 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1649 # invoked.
1650 #
1651 # Note that when enabling USE_PDFLATEX this option is only used for generating
1652 # bitmaps for formulas in the HTML output, but not in the Makefile that is
1653 # written to the output directory.
1654 # The default file is: latex.
1655 # This tag requires that the tag GENERATE_LATEX is set to YES.
1656
1657 LATEX_CMD_NAME         = latex
1658
1659 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
1660 # index for LaTeX.
1661 # The default file is: makeindex.
1662 # This tag requires that the tag GENERATE_LATEX is set to YES.
1663
1664 MAKEINDEX_CMD_NAME     = makeindex
1665
1666 # If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
1667 # documents. This may be useful for small projects and may help to save some
1668 # trees in general.
1669 # The default value is: NO.
1670 # This tag requires that the tag GENERATE_LATEX is set to YES.
1671
1672 COMPACT_LATEX          = NO
1673
1674 # The PAPER_TYPE tag can be used to set the paper type that is used by the
1675 # printer.
1676 # Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
1677 # 14 inches) and executive (7.25 x 10.5 inches).
1678 # The default value is: a4.
1679 # This tag requires that the tag GENERATE_LATEX is set to YES.
1680
1681 PAPER_TYPE             = a4
1682
1683 # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
1684 # that should be included in the LaTeX output. To get the times font for
1685 # instance you can specify
1686 # EXTRA_PACKAGES=times
1687 # If left blank no extra packages will be included.
1688 # This tag requires that the tag GENERATE_LATEX is set to YES.
1689
1690 EXTRA_PACKAGES         =
1691
1692 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
1693 # generated LaTeX document. The header should contain everything until the first
1694 # chapter. If it is left blank doxygen will generate a standard header. See
1695 # section "Doxygen usage" for information on how to let doxygen write the
1696 # default header to a separate file.
1697 #
1698 # Note: Only use a user-defined header if you know what you are doing! The
1699 # following commands have a special meaning inside the header: $title,
1700 # $datetime, $date, $doxygenversion, $projectname, $projectnumber,
1701 # $projectbrief, $projectlogo. Doxygen will replace $title with the empty
1702 # string, for the replacement values of the other commands the user is referred
1703 # to HTML_HEADER.
1704 # This tag requires that the tag GENERATE_LATEX is set to YES.
1705
1706 LATEX_HEADER           =
1707
1708 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
1709 # generated LaTeX document. The footer should contain everything after the last
1710 # chapter. If it is left blank doxygen will generate a standard footer. See
1711 # LATEX_HEADER for more information on how to generate a default footer and what
1712 # special commands can be used inside the footer.
1713 #
1714 # Note: Only use a user-defined footer if you know what you are doing!
1715 # This tag requires that the tag GENERATE_LATEX is set to YES.
1716
1717 LATEX_FOOTER           =
1718
1719 # The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1720 # LaTeX style sheets that are included after the standard style sheets created
1721 # by doxygen. Using this option one can overrule certain style aspects. Doxygen
1722 # will copy the style sheet files to the output directory.
1723 # Note: The order of the extra style sheet files is of importance (e.g. the last
1724 # style sheet in the list overrules the setting of the previous ones in the
1725 # list).
1726 # This tag requires that the tag GENERATE_LATEX is set to YES.
1727
1728 LATEX_EXTRA_STYLESHEET =
1729
1730 # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
1731 # other source files which should be copied to the LATEX_OUTPUT output
1732 # directory. Note that the files will be copied as-is; there are no commands or
1733 # markers available.
1734 # This tag requires that the tag GENERATE_LATEX is set to YES.
1735
1736 LATEX_EXTRA_FILES      =
1737
1738 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1739 # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
1740 # contain links (just like the HTML output) instead of page references. This
1741 # makes the output suitable for online browsing using a PDF viewer.
1742 # The default value is: YES.
1743 # This tag requires that the tag GENERATE_LATEX is set to YES.
1744
1745 PDF_HYPERLINKS         = YES
1746
1747 # If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1748 # the PDF file directly from the LaTeX files. Set this option to YES, to get a
1749 # higher quality PDF documentation.
1750 # The default value is: YES.
1751 # This tag requires that the tag GENERATE_LATEX is set to YES.
1752
1753 USE_PDFLATEX           = YES
1754
1755 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1756 # command to the generated LaTeX files. This will instruct LaTeX to keep running
1757 # if errors occur, instead of asking the user for help. This option is also used
1758 # when generating formulas in HTML.
1759 # The default value is: NO.
1760 # This tag requires that the tag GENERATE_LATEX is set to YES.
1761
1762 LATEX_BATCHMODE        = NO
1763
1764 # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1765 # index chapters (such as File Index, Compound Index, etc.) in the output.
1766 # The default value is: NO.
1767 # This tag requires that the tag GENERATE_LATEX is set to YES.
1768
1769 LATEX_HIDE_INDICES     = NO
1770
1771 # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
1772 # code with syntax highlighting in the LaTeX output.
1773 #
1774 # Note that which sources are shown also depends on other settings such as
1775 # SOURCE_BROWSER.
1776 # The default value is: NO.
1777 # This tag requires that the tag GENERATE_LATEX is set to YES.
1778
1779 LATEX_SOURCE_CODE      = NO
1780
1781 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1782 # bibliography, e.g. plainnat, or ieeetr. See
1783 # http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
1784 # The default value is: plain.
1785 # This tag requires that the tag GENERATE_LATEX is set to YES.
1786
1787 LATEX_BIB_STYLE        = plain
1788
1789 #---------------------------------------------------------------------------
1790 # Configuration options related to the RTF output
1791 #---------------------------------------------------------------------------
1792
1793 # If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
1794 # RTF output is optimized for Word 97 and may not look too pretty with other RTF
1795 # readers/editors.
1796 # The default value is: NO.
1797
1798 GENERATE_RTF           = NO
1799
1800 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
1801 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1802 # it.
1803 # The default directory is: rtf.
1804 # This tag requires that the tag GENERATE_RTF is set to YES.
1805
1806 RTF_OUTPUT             = rtf
1807
1808 # If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
1809 # documents. This may be useful for small projects and may help to save some
1810 # trees in general.
1811 # The default value is: NO.
1812 # This tag requires that the tag GENERATE_RTF is set to YES.
1813
1814 COMPACT_RTF            = NO
1815
1816 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
1817 # contain hyperlink fields. The RTF file will contain links (just like the HTML
1818 # output) instead of page references. This makes the output suitable for online
1819 # browsing using Word or some other Word compatible readers that support those
1820 # fields.
1821 #
1822 # Note: WordPad (write) and others do not support links.
1823 # The default value is: NO.
1824 # This tag requires that the tag GENERATE_RTF is set to YES.
1825
1826 RTF_HYPERLINKS         = NO
1827
1828 # Load stylesheet definitions from file. Syntax is similar to doxygen's config
1829 # file, i.e. a series of assignments. You only have to provide replacements,
1830 # missing definitions are set to their default value.
1831 #
1832 # See also section "Doxygen usage" for information on how to generate the
1833 # default style sheet that doxygen normally uses.
1834 # This tag requires that the tag GENERATE_RTF is set to YES.
1835
1836 RTF_STYLESHEET_FILE    =
1837
1838 # Set optional variables used in the generation of an RTF document. Syntax is
1839 # similar to doxygen's config file. A template extensions file can be generated
1840 # using doxygen -e rtf extensionFile.
1841 # This tag requires that the tag GENERATE_RTF is set to YES.
1842
1843 RTF_EXTENSIONS_FILE    =
1844
1845 # If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
1846 # with syntax highlighting in the RTF output.
1847 #
1848 # Note that which sources are shown also depends on other settings such as
1849 # SOURCE_BROWSER.
1850 # The default value is: NO.
1851 # This tag requires that the tag GENERATE_RTF is set to YES.
1852
1853 RTF_SOURCE_CODE        = NO
1854
1855 #---------------------------------------------------------------------------
1856 # Configuration options related to the man page output
1857 #---------------------------------------------------------------------------
1858
1859 # If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
1860 # classes and files.
1861 # The default value is: NO.
1862
1863 GENERATE_MAN           = NO
1864
1865 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
1866 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1867 # it. A directory man3 will be created inside the directory specified by
1868 # MAN_OUTPUT.
1869 # The default directory is: man.
1870 # This tag requires that the tag GENERATE_MAN is set to YES.
1871
1872 MAN_OUTPUT             = man
1873
1874 # The MAN_EXTENSION tag determines the extension that is added to the generated
1875 # man pages. In case the manual section does not start with a number, the number
1876 # 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
1877 # optional.
1878 # The default value is: .3.
1879 # This tag requires that the tag GENERATE_MAN is set to YES.
1880
1881 MAN_EXTENSION          = .3
1882
1883 # The MAN_SUBDIR tag determines the name of the directory created within
1884 # MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
1885 # MAN_EXTENSION with the initial . removed.
1886 # This tag requires that the tag GENERATE_MAN is set to YES.
1887
1888 MAN_SUBDIR             =
1889
1890 # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
1891 # will generate one additional man file for each entity documented in the real
1892 # man page(s). These additional files only source the real man page, but without
1893 # them the man command would be unable to find the correct page.
1894 # The default value is: NO.
1895 # This tag requires that the tag GENERATE_MAN is set to YES.
1896
1897 MAN_LINKS              = NO
1898
1899 #---------------------------------------------------------------------------
1900 # Configuration options related to the XML output
1901 #---------------------------------------------------------------------------
1902
1903 # If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
1904 # captures the structure of the code including all documentation.
1905 # The default value is: NO.
1906
1907 GENERATE_XML           = NO
1908
1909 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
1910 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1911 # it.
1912 # The default directory is: xml.
1913 # This tag requires that the tag GENERATE_XML is set to YES.
1914
1915 XML_OUTPUT             = xml
1916
1917 # If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
1918 # listings (including syntax highlighting and cross-referencing information) to
1919 # the XML output. Note that enabling this will significantly increase the size
1920 # of the XML output.
1921 # The default value is: YES.
1922 # This tag requires that the tag GENERATE_XML is set to YES.
1923
1924 XML_PROGRAMLISTING     = YES
1925
1926 #---------------------------------------------------------------------------
1927 # Configuration options related to the DOCBOOK output
1928 #---------------------------------------------------------------------------
1929
1930 # If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
1931 # that can be used to generate PDF.
1932 # The default value is: NO.
1933
1934 GENERATE_DOCBOOK       = NO
1935
1936 # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
1937 # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
1938 # front of it.
1939 # The default directory is: docbook.
1940 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1941
1942 DOCBOOK_OUTPUT         = docbook
1943
1944 # If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
1945 # program listings (including syntax highlighting and cross-referencing
1946 # information) to the DOCBOOK output. Note that enabling this will significantly
1947 # increase the size of the DOCBOOK output.
1948 # The default value is: NO.
1949 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1950
1951 DOCBOOK_PROGRAMLISTING = NO
1952
1953 #---------------------------------------------------------------------------
1954 # Configuration options for the AutoGen Definitions output
1955 #---------------------------------------------------------------------------
1956
1957 # If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
1958 # AutoGen Definitions (see http://autogen.sf.net) file that captures the
1959 # structure of the code including all documentation. Note that this feature is
1960 # still experimental and incomplete at the moment.
1961 # The default value is: NO.
1962
1963 GENERATE_AUTOGEN_DEF   = NO
1964
1965 #---------------------------------------------------------------------------
1966 # Configuration options related to the Perl module output
1967 #---------------------------------------------------------------------------
1968
1969 # If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
1970 # file that captures the structure of the code including all documentation.
1971 #
1972 # Note that this feature is still experimental and incomplete at the moment.
1973 # The default value is: NO.
1974
1975 GENERATE_PERLMOD       = NO
1976
1977 # If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
1978 # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
1979 # output from the Perl module output.
1980 # The default value is: NO.
1981 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1982
1983 PERLMOD_LATEX          = NO
1984
1985 # If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
1986 # formatted so it can be parsed by a human reader. This is useful if you want to
1987 # understand what is going on. On the other hand, if this tag is set to NO, the
1988 # size of the Perl module output will be much smaller and Perl will parse it
1989 # just the same.
1990 # The default value is: YES.
1991 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1992
1993 PERLMOD_PRETTY         = YES
1994
1995 # The names of the make variables in the generated doxyrules.make file are
1996 # prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
1997 # so different doxyrules.make files included by the same Makefile don't
1998 # overwrite each other's variables.
1999 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2000
2001 PERLMOD_MAKEVAR_PREFIX =
2002
2003 #---------------------------------------------------------------------------
2004 # Configuration options related to the preprocessor
2005 #---------------------------------------------------------------------------
2006
2007 # If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
2008 # C-preprocessor directives found in the sources and include files.
2009 # The default value is: YES.
2010
2011 ENABLE_PREPROCESSING   = YES
2012
2013 # If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
2014 # in the source code. If set to NO, only conditional compilation will be
2015 # performed. Macro expansion can be done in a controlled way by setting
2016 # EXPAND_ONLY_PREDEF to YES.
2017 # The default value is: NO.
2018 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2019
2020 MACRO_EXPANSION        = YES
2021
2022 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
2023 # the macro expansion is limited to the macros specified with the PREDEFINED and
2024 # EXPAND_AS_DEFINED tags.
2025 # The default value is: NO.
2026 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2027
2028 EXPAND_ONLY_PREDEF     = NO
2029
2030 # If the SEARCH_INCLUDES tag is set to YES, the include files in the
2031 # INCLUDE_PATH will be searched if a #include is found.
2032 # The default value is: YES.
2033 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2034
2035 SEARCH_INCLUDES        = YES
2036
2037 # The INCLUDE_PATH tag can be used to specify one or more directories that
2038 # contain include files that are not input files but should be processed by the
2039 # preprocessor.
2040 # This tag requires that the tag SEARCH_INCLUDES is set to YES.
2041
2042 INCLUDE_PATH           =
2043
2044 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
2045 # patterns (like *.h and *.hpp) to filter out the header-files in the
2046 # directories. If left blank, the patterns specified with FILE_PATTERNS will be
2047 # used.
2048 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2049
2050 INCLUDE_FILE_PATTERNS  =
2051
2052 # The PREDEFINED tag can be used to specify one or more macro names that are
2053 # defined before the preprocessor is started (similar to the -D option of e.g.
2054 # gcc). The argument of the tag is a list of macros of the form: name or
2055 # name=definition (no spaces). If the definition and the "=" are omitted, "=1"
2056 # is assumed. To prevent a macro definition from being undefined via #undef or
2057 # recursively expanded use the := operator instead of the = operator.
2058 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2059
2060 PREDEFINED             = GRPC_FINAL= GRPC_OVERIDE=
2061
2062 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
2063 # tag can be used to specify a list of macro names that should be expanded. The
2064 # macro definition that is found in the sources will be used. Use the PREDEFINED
2065 # tag if you want to use a different macro definition that overrules the
2066 # definition found in the source code.
2067 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2068
2069 EXPAND_AS_DEFINED      =
2070
2071 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
2072 # remove all references to function-like macros that are alone on a line, have
2073 # an all uppercase name, and do not end with a semicolon. Such function macros
2074 # are typically used for boiler-plate code, and will confuse the parser if not
2075 # removed.
2076 # The default value is: YES.
2077 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2078
2079 SKIP_FUNCTION_MACROS   = YES
2080
2081 #---------------------------------------------------------------------------
2082 # Configuration options related to external references
2083 #---------------------------------------------------------------------------
2084
2085 # The TAGFILES tag can be used to specify one or more tag files. For each tag
2086 # file the location of the external documentation should be added. The format of
2087 # a tag file without this location is as follows:
2088 # TAGFILES = file1 file2 ...
2089 # Adding location for the tag files is done as follows:
2090 # TAGFILES = file1=loc1 "file2 = loc2" ...
2091 # where loc1 and loc2 can be relative or absolute paths or URLs. See the
2092 # section "Linking to external documentation" for more information about the use
2093 # of tag files.
2094 # Note: Each tag file must have a unique name (where the name does NOT include
2095 # the path). If a tag file is not located in the directory in which doxygen is
2096 # run, you must also specify the path to the tagfile here.
2097
2098 TAGFILES               =
2099
2100 # When a file name is specified after GENERATE_TAGFILE, doxygen will create a
2101 # tag file that is based on the input files it reads. See section "Linking to
2102 # external documentation" for more information about the usage of tag files.
2103
2104 GENERATE_TAGFILE       =
2105
2106 # If the ALLEXTERNALS tag is set to YES, all external class will be listed in
2107 # the class index. If set to NO, only the inherited external classes will be
2108 # listed.
2109 # The default value is: NO.
2110
2111 ALLEXTERNALS           = NO
2112
2113 # If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
2114 # in the modules index. If set to NO, only the current project's groups will be
2115 # listed.
2116 # The default value is: YES.
2117
2118 EXTERNAL_GROUPS        = YES
2119
2120 # If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
2121 # the related pages index. If set to NO, only the current project's pages will
2122 # be listed.
2123 # The default value is: YES.
2124
2125 EXTERNAL_PAGES         = YES
2126
2127 # The PERL_PATH should be the absolute path and name of the perl script
2128 # interpreter (i.e. the result of 'which perl').
2129 # The default file (with absolute path) is: /usr/bin/perl.
2130
2131 PERL_PATH              = /usr/bin/perl
2132
2133 #---------------------------------------------------------------------------
2134 # Configuration options related to the dot tool
2135 #---------------------------------------------------------------------------
2136
2137 # If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
2138 # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
2139 # NO turns the diagrams off. Note that this option also works with HAVE_DOT
2140 # disabled, but it is recommended to install and use dot, since it yields more
2141 # powerful graphs.
2142 # The default value is: YES.
2143
2144 CLASS_DIAGRAMS         = YES
2145
2146 # You can define message sequence charts within doxygen comments using the \msc
2147 # command. Doxygen will then run the mscgen tool (see:
2148 # http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
2149 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
2150 # the mscgen tool resides. If left empty the tool is assumed to be found in the
2151 # default search path.
2152
2153 MSCGEN_PATH            =
2154
2155 # You can include diagrams made with dia in doxygen documentation. Doxygen will
2156 # then run dia to produce the diagram and insert it in the documentation. The
2157 # DIA_PATH tag allows you to specify the directory where the dia binary resides.
2158 # If left empty dia is assumed to be found in the default search path.
2159
2160 DIA_PATH               =
2161
2162 # If set to YES the inheritance and collaboration graphs will hide inheritance
2163 # and usage relations if the target is undocumented or is not a class.
2164 # The default value is: YES.
2165
2166 HIDE_UNDOC_RELATIONS   = YES
2167
2168 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2169 # available from the path. This tool is part of Graphviz (see:
2170 # http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
2171 # Bell Labs. The other options in this section have no effect if this option is
2172 # set to NO
2173 # The default value is: NO.
2174
2175 HAVE_DOT               = YES
2176
2177 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2178 # to run in parallel. When set to 0 doxygen will base this on the number of
2179 # processors available in the system. You can set it explicitly to a value
2180 # larger than 0 to get control over the balance between CPU load and processing
2181 # speed.
2182 # Minimum value: 0, maximum value: 32, default value: 0.
2183 # This tag requires that the tag HAVE_DOT is set to YES.
2184
2185 DOT_NUM_THREADS        = 0
2186
2187 # When you want a differently looking font in the dot files that doxygen
2188 # generates you can specify the font name using DOT_FONTNAME. You need to make
2189 # sure dot is able to find the font, which can be done by putting it in a
2190 # standard location or by setting the DOTFONTPATH environment variable or by
2191 # setting DOT_FONTPATH to the directory containing the font.
2192 # The default value is: Helvetica.
2193 # This tag requires that the tag HAVE_DOT is set to YES.
2194
2195 DOT_FONTNAME           = Helvetica
2196
2197 # The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
2198 # dot graphs.
2199 # Minimum value: 4, maximum value: 24, default value: 10.
2200 # This tag requires that the tag HAVE_DOT is set to YES.
2201
2202 DOT_FONTSIZE           = 10
2203
2204 # By default doxygen will tell dot to use the default font as specified with
2205 # DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
2206 # the path where dot can find it using this tag.
2207 # This tag requires that the tag HAVE_DOT is set to YES.
2208
2209 DOT_FONTPATH           =
2210
2211 # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2212 # each documented class showing the direct and indirect inheritance relations.
2213 # Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
2214 # The default value is: YES.
2215 # This tag requires that the tag HAVE_DOT is set to YES.
2216
2217 CLASS_GRAPH            = NO
2218
2219 # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2220 # graph for each documented class showing the direct and indirect implementation
2221 # dependencies (inheritance, containment, and class references variables) of the
2222 # class with other documented classes.
2223 # The default value is: YES.
2224 # This tag requires that the tag HAVE_DOT is set to YES.
2225
2226 COLLABORATION_GRAPH    = NO
2227
2228 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2229 # groups, showing the direct groups dependencies.
2230 # The default value is: YES.
2231 # This tag requires that the tag HAVE_DOT is set to YES.
2232
2233 GROUP_GRAPHS           = NO
2234
2235 # If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
2236 # collaboration diagrams in a style similar to the OMG's Unified Modeling
2237 # Language.
2238 # The default value is: NO.
2239 # This tag requires that the tag HAVE_DOT is set to YES.
2240
2241 UML_LOOK               = NO
2242
2243 # If the UML_LOOK tag is enabled, the fields and methods are shown inside the
2244 # class node. If there are many fields or methods and many nodes the graph may
2245 # become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2246 # number of items for each type to make the size more manageable. Set this to 0
2247 # for no limit. Note that the threshold may be exceeded by 50% before the limit
2248 # is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2249 # but if the number exceeds 15, the total amount of fields shown is limited to
2250 # 10.
2251 # Minimum value: 0, maximum value: 100, default value: 10.
2252 # This tag requires that the tag HAVE_DOT is set to YES.
2253
2254 UML_LIMIT_NUM_FIELDS   = 10
2255
2256 # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2257 # collaboration graphs will show the relations between templates and their
2258 # instances.
2259 # The default value is: NO.
2260 # This tag requires that the tag HAVE_DOT is set to YES.
2261
2262 TEMPLATE_RELATIONS     = NO
2263
2264 # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2265 # YES then doxygen will generate a graph for each documented file showing the
2266 # direct and indirect include dependencies of the file with other documented
2267 # files.
2268 # The default value is: YES.
2269 # This tag requires that the tag HAVE_DOT is set to YES.
2270
2271 INCLUDE_GRAPH          = NO
2272
2273 # If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
2274 # set to YES then doxygen will generate a graph for each documented file showing
2275 # the direct and indirect include dependencies of the file with other documented
2276 # files.
2277 # The default value is: YES.
2278 # This tag requires that the tag HAVE_DOT is set to YES.
2279
2280 INCLUDED_BY_GRAPH      = NO
2281
2282 # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2283 # dependency graph for every global function or class method.
2284 #
2285 # Note that enabling this option will significantly increase the time of a run.
2286 # So in most cases it will be better to enable call graphs for selected
2287 # functions only using the \callgraph command.
2288 # The default value is: NO.
2289 # This tag requires that the tag HAVE_DOT is set to YES.
2290
2291 CALL_GRAPH             = NO
2292
2293 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2294 # dependency graph for every global function or class method.
2295 #
2296 # Note that enabling this option will significantly increase the time of a run.
2297 # So in most cases it will be better to enable caller graphs for selected
2298 # functions only using the \callergraph command.
2299 # The default value is: NO.
2300 # This tag requires that the tag HAVE_DOT is set to YES.
2301
2302 CALLER_GRAPH           = NO
2303
2304 # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2305 # hierarchy of all classes instead of a textual one.
2306 # The default value is: YES.
2307 # This tag requires that the tag HAVE_DOT is set to YES.
2308
2309 GRAPHICAL_HIERARCHY    = NO
2310
2311 # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2312 # dependencies a directory has on other directories in a graphical way. The
2313 # dependency relations are determined by the #include relations between the
2314 # files in the directories.
2315 # The default value is: YES.
2316 # This tag requires that the tag HAVE_DOT is set to YES.
2317
2318 DIRECTORY_GRAPH        = NO
2319
2320 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2321 # generated by dot.
2322 # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2323 # to make the SVG files visible in IE 9+ (other browsers do not have this
2324 # requirement).
2325 # Possible values are: png, jpg, gif and svg.
2326 # The default value is: png.
2327 # This tag requires that the tag HAVE_DOT is set to YES.
2328
2329 DOT_IMAGE_FORMAT       = png
2330
2331 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2332 # enable generation of interactive SVG images that allow zooming and panning.
2333 #
2334 # Note that this requires a modern browser other than Internet Explorer. Tested
2335 # and working are Firefox, Chrome, Safari, and Opera.
2336 # Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2337 # the SVG files visible. Older versions of IE do not have SVG support.
2338 # The default value is: NO.
2339 # This tag requires that the tag HAVE_DOT is set to YES.
2340
2341 INTERACTIVE_SVG        = NO
2342
2343 # The DOT_PATH tag can be used to specify the path where the dot tool can be
2344 # found. If left blank, it is assumed the dot tool can be found in the path.
2345 # This tag requires that the tag HAVE_DOT is set to YES.
2346
2347 DOT_PATH               =
2348
2349 # The DOTFILE_DIRS tag can be used to specify one or more directories that
2350 # contain dot files that are included in the documentation (see the \dotfile
2351 # command).
2352 # This tag requires that the tag HAVE_DOT is set to YES.
2353
2354 DOTFILE_DIRS           =
2355
2356 # The MSCFILE_DIRS tag can be used to specify one or more directories that
2357 # contain msc files that are included in the documentation (see the \mscfile
2358 # command).
2359
2360 MSCFILE_DIRS           =
2361
2362 # The DIAFILE_DIRS tag can be used to specify one or more directories that
2363 # contain dia files that are included in the documentation (see the \diafile
2364 # command).
2365
2366 DIAFILE_DIRS           =
2367
2368 # When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
2369 # path where java can find the plantuml.jar file. If left blank, it is assumed
2370 # PlantUML is not used or called during a preprocessing step. Doxygen will
2371 # generate a warning when it encounters a \startuml command in this case and
2372 # will not generate output for the diagram.
2373
2374 PLANTUML_JAR_PATH      =
2375
2376 # When using plantuml, the specified paths are searched for files specified by
2377 # the !include statement in a plantuml block.
2378
2379 PLANTUML_INCLUDE_PATH  =
2380
2381 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2382 # that will be shown in the graph. If the number of nodes in a graph becomes
2383 # larger than this value, doxygen will truncate the graph, which is visualized
2384 # by representing a node as a red box. Note that doxygen if the number of direct
2385 # children of the root node in a graph is already larger than
2386 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2387 # the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2388 # Minimum value: 0, maximum value: 10000, default value: 50.
2389 # This tag requires that the tag HAVE_DOT is set to YES.
2390
2391 DOT_GRAPH_MAX_NODES    = 50
2392
2393 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2394 # generated by dot. A depth value of 3 means that only nodes reachable from the
2395 # root by following a path via at most 3 edges will be shown. Nodes that lay
2396 # further from the root node will be omitted. Note that setting this option to 1
2397 # or 2 may greatly reduce the computation time needed for large code bases. Also
2398 # note that the size of a graph can be further restricted by
2399 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
2400 # Minimum value: 0, maximum value: 1000, default value: 0.
2401 # This tag requires that the tag HAVE_DOT is set to YES.
2402
2403 MAX_DOT_GRAPH_DEPTH    = 0
2404
2405 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2406 # background. This is disabled by default, because dot on Windows does not seem
2407 # to support this out of the box.
2408 #
2409 # Warning: Depending on the platform used, enabling this option may lead to
2410 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2411 # read).
2412 # The default value is: NO.
2413 # This tag requires that the tag HAVE_DOT is set to YES.
2414
2415 DOT_TRANSPARENT        = NO
2416
2417 # Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
2418 # files in one run (i.e. multiple -o and -T options on the command line). This
2419 # makes dot run faster, but since only newer versions of dot (>1.8.10) support
2420 # this, this feature is disabled by default.
2421 # The default value is: NO.
2422 # This tag requires that the tag HAVE_DOT is set to YES.
2423
2424 DOT_MULTI_TARGETS      = NO
2425
2426 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2427 # explaining the meaning of the various boxes and arrows in the dot generated
2428 # graphs.
2429 # The default value is: YES.
2430 # This tag requires that the tag HAVE_DOT is set to YES.
2431
2432 GENERATE_LEGEND        = YES
2433
2434 # If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
2435 # files that are used to generate the various graphs.
2436 # The default value is: YES.
2437 # This tag requires that the tag HAVE_DOT is set to YES.
2438
2439 DOT_CLEANUP            = YES
2440