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