comparison OrthancServer/Resources/Orthanc.doxygen @ 4044:d25f4c0fa160 framework

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