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

Side by Side Diff: crashpad.doxy

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

Powered by Google App Engine
This is Rietveld 408576698