Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(512)

Side by Side Diff: doc/crashpad.doxy

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

Powered by Google App Engine
This is Rietveld 408576698