source: libcf++/trunk/doc/doxyfile@ 4

Last change on this file since 4 was 4, checked in by cheese, 9 years ago

#1 commit prototype

File size: 79.4 KB
Line 
1# Doxyfile 1.8.3.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 hash (#) is considered a comment and will be ignored
7# The format is:
8# TAG = value [value, ...]
9# For lists items can also be appended using:
10# TAG += value [value, ...]
11# Values that contain spaces should be placed between quotes (" ")
12
13#---------------------------------------------------------------------------
14# Project related configuration options
15#---------------------------------------------------------------------------
16
17# This tag specifies the encoding used for all characters in the config file
18# that follow. The default is UTF-8 which is also the encoding used for all
19# text before the first occurrence of this tag. Doxygen uses libiconv (or the
20# iconv built into libc) for the transcoding. See
21# http://www.gnu.org/software/libiconv for the list of possible encodings.
22
23DOXYFILE_ENCODING = UTF-8
24
25# The PROJECT_NAME tag is a single word (or sequence of words) that should
26# identify the project. Note that if you do not use Doxywizard you need
27# to put quotes around the project name if it contains spaces.
28
29PROJECT_NAME = "libcf++"
30
31# The PROJECT_NUMBER tag can be used to enter a project or revision number.
32# This could be handy for archiving the generated documentation or
33# if some version control system is used.
34
35PROJECT_NUMBER = 0.1dev
36
37# Using the PROJECT_BRIEF tag one can provide an optional one line description
38# for a project that appears at the top of each page and should give viewer
39# a quick idea about the purpose of the project. Keep the description short.
40
41#PROJECT_BRIEF =
42
43# With the PROJECT_LOGO tag one can specify an logo or icon that is
44# included in the documentation. The maximum height of the logo should not
45# exceed 55 pixels and the maximum width should not exceed 200 pixels.
46# Doxygen will copy the logo to the output directory.
47
48#PROJECT_LOGO =
49
50# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
51# base path where the generated documentation will be put.
52# If a relative path is entered, it will be relative to the location
53# where doxygen was started. If left blank the current directory will be used.
54
55OUTPUT_DIRECTORY = ../_doc/
56
57# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
58# 4096 sub-directories (in 2 levels) under the output directory of each output
59# format and will distribute the generated files over these directories.
60# Enabling this option can be useful when feeding doxygen a huge amount of
61# source files, where putting all generated files in the same directory would
62# otherwise cause performance problems for the file system.
63
64CREATE_SUBDIRS = YES
65
66# The OUTPUT_LANGUAGE tag is used to specify the language in which all
67# documentation generated by doxygen is written. Doxygen will use this
68# information to generate all constant output in the proper language.
69# The default language is English, other supported languages are:
70# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
71# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
72# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
73# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
74# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak,
75# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
76
77OUTPUT_LANGUAGE = Korean-en
78
79# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
80# include brief member descriptions after the members that are listed in
81# the file and class documentation (similar to JavaDoc).
82# Set to NO to disable this.
83
84BRIEF_MEMBER_DESC = YES
85
86# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
87# the brief description of a member or function before the detailed description.
88# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
89# brief descriptions will be completely suppressed.
90
91REPEAT_BRIEF = YES
92
93# This tag implements a quasi-intelligent brief description abbreviator
94# that is used to form the text in various listings. Each string
95# in this list, if found as the leading text of the brief description, will be
96# stripped from the text and the result after processing the whole list, is
97# used as the annotated text. Otherwise, the brief description is used as-is.
98# If left blank, the following values are used ("$name" is automatically
99# replaced with the name of the entity): "The $name class" "The $name widget"
100# "The $name file" "is" "provides" "specifies" "contains"
101# "represents" "a" "an" "the"
102
103ABBREVIATE_BRIEF = "The $name class" \
104 "The $name widget" \
105 "The $name file" \
106 is \
107 provides \
108 specifies \
109 contains \
110 represents \
111 a \
112 an \
113 the
114
115# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
116# Doxygen will generate a detailed section even if there is only a brief
117# description.
118
119ALWAYS_DETAILED_SEC = NO
120
121# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
122# inherited members of a class in the documentation of that class as if those
123# members were ordinary class members. Constructors, destructors and assignment
124# operators of the base classes will not be shown.
125
126INLINE_INHERITED_MEMB = NO
127
128# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
129# path before files name in the file list and in the header files. If set
130# to NO the shortest path that makes the file name unique will be used.
131
132FULL_PATH_NAMES = YES
133
134# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
135# can be used to strip a user-defined part of the path. Stripping is
136# only done if one of the specified strings matches the left-hand part of
137# the path. The tag can be used to show relative paths in the file list.
138# If left blank the directory from which doxygen is run is used as the
139# path to strip. Note that you specify absolute paths here, but also
140# relative paths, which will be relative from the directory where doxygen is
141# started.
142
143STRIP_FROM_PATH = ../include/cf \
144 ../src \
145 ../doc \
146
147# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
148# the path mentioned in the documentation of a class, which tells
149# the reader which header file to include in order to use a class.
150# If left blank only the name of the header file containing the class
151# definition is used. Otherwise one should specify the include paths that
152# are normally passed to the compiler using the -I flag.
153
154STRIP_FROM_INC_PATH =
155
156# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
157# (but less readable) file names. This can be useful if your file system
158# doesn't support long names like on DOS, Mac, or CD-ROM.
159
160SHORT_NAMES = YES
161
162# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
163# will interpret the first line (until the first dot) of a JavaDoc-style
164# comment as the brief description. If set to NO, the JavaDoc
165# comments will behave just like regular Qt-style comments
166# (thus requiring an explicit @brief command for a brief description.)
167
168JAVADOC_AUTOBRIEF = YES
169
170# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
171# interpret the first line (until the first dot) of a Qt-style
172# comment as the brief description. If set to NO, the comments
173# will behave just like regular Qt-style comments (thus requiring
174# an explicit \brief command for a brief description.)
175
176QT_AUTOBRIEF = NO
177
178# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
179# treat a multi-line C++ special comment block (i.e. a block of //! or ///
180# comments) as a brief description. This used to be the default behaviour.
181# The new default is to treat a multi-line C++ comment block as a detailed
182# description. Set this tag to YES if you prefer the old behaviour instead.
183
184MULTILINE_CPP_IS_BRIEF = NO
185
186# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
187# member inherits the documentation from any documented member that it
188# re-implements.
189
190INHERIT_DOCS = YES
191
192# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
193# a new page for each member. If set to NO, the documentation of a member will
194# be part of the file/class/namespace that contains it.
195
196SEPARATE_MEMBER_PAGES = NO
197
198# The TAB_SIZE tag can be used to set the number of spaces in a tab.
199# Doxygen uses this value to replace tabs by spaces in code fragments.
200
201TAB_SIZE = 4
202
203# This tag can be used to specify a number of aliases that acts
204# as commands in the documentation. An alias has the form "name=value".
205# For example adding "sideeffect=\par Side Effects:\n" will allow you to
206# put the command \sideeffect (or @sideeffect) in the documentation, which
207# will result in a user-defined paragraph with heading "Side Effects:".
208# You can put \n's in the value part of an alias to insert newlines.
209
210ALIASES =
211
212# This tag can be used to specify a number of word-keyword mappings (TCL only).
213# A mapping has the form "name=value". For example adding
214# "class=itcl::class" will allow you to use the command class in the
215# itcl::class meaning.
216
217#TCL_SUBST =
218
219# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
220# sources only. Doxygen will then generate output that is more tailored for C.
221# For instance, some of the names that are used will be different. The list
222# of all members will be omitted, etc.
223
224OPTIMIZE_OUTPUT_FOR_C = NO
225
226# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
227# sources only. Doxygen will then generate output that is more tailored for
228# Java. For instance, namespaces will be presented as packages, qualified
229# scopes will look different, etc.
230
231OPTIMIZE_OUTPUT_JAVA = NO
232
233# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
234# sources only. Doxygen will then generate output that is more tailored for
235# Fortran.
236
237OPTIMIZE_FOR_FORTRAN = NO
238
239# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
240# sources. Doxygen will then generate output that is tailored for
241# VHDL.
242
243OPTIMIZE_OUTPUT_VHDL = NO
244
245# Doxygen selects the parser to use depending on the extension of the files it
246# parses. With this tag you can assign which parser to use for a given
247# extension. Doxygen has a built-in mapping, but you can override or extend it
248# using this tag. The format is ext=language, where ext is a file extension,
249# and language is one of the parsers supported by doxygen: IDL, Java,
250# Javascript, CSharp, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL, C,
251# C++. For instance to make doxygen treat .inc files as Fortran files (default
252# is PHP), and .f files as C (default is Fortran), use: inc=Fortran f=C. Note
253# that for custom extensions you also need to set FILE_PATTERNS otherwise the
254# files are not read by doxygen.
255
256EXTENSION_MAPPING =
257
258# If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all
259# comments according to the Markdown format, which allows for more readable
260# documentation. See http://daringfireball.net/projects/markdown/ for details.
261# The output of markdown processing is further processed by doxygen, so you
262# can mix doxygen, HTML, and XML commands with Markdown formatting.
263# Disable only in case of backward compatibilities issues.
264
265#MARKDOWN_SUPPORT = YES
266
267# When enabled doxygen tries to link words that correspond to documented classes,
268# or namespaces to their corresponding documentation. Such a link can be
269# prevented in individual cases by by putting a % sign in front of the word or
270# globally by setting AUTOLINK_SUPPORT to NO.
271
272#AUTOLINK_SUPPORT = YES
273
274# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
275# to include (a tag file for) the STL sources as input, then you should
276# set this tag to YES in order to let doxygen match functions declarations and
277# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
278# func(std::string) {}). This also makes the inheritance and collaboration
279# diagrams that involve STL classes more complete and accurate.
280
281BUILTIN_STL_SUPPORT = NO
282
283# If you use Microsoft's C++/CLI language, you should set this option to YES to
284# enable parsing support.
285
286CPP_CLI_SUPPORT = NO
287
288# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
289# Doxygen will parse them like normal C++ but will assume all classes use public
290# instead of private inheritance when no explicit protection keyword is present.
291
292SIP_SUPPORT = NO
293
294# For Microsoft's IDL there are propget and propput attributes to indicate
295# getter and setter methods for a property. Setting this option to YES (the
296# default) will make doxygen replace the get and set methods by a property in
297# the documentation. This will only work if the methods are indeed getting or
298# setting a simple type. If this is not the case, or you want to show the
299# methods anyway, you should set this option to NO.
300
301IDL_PROPERTY_SUPPORT = YES
302
303# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
304# tag is set to YES, then doxygen will reuse the documentation of the first
305# member in the group (if any) for the other members of the group. By default
306# all members of a group must be documented explicitly.
307
308DISTRIBUTE_GROUP_DOC = NO
309
310# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
311# the same type (for instance a group of public functions) to be put as a
312# subgroup of that type (e.g. under the Public Functions section). Set it to
313# NO to prevent subgrouping. Alternatively, this can be done per class using
314# the \nosubgrouping command.
315
316SUBGROUPING = YES
317
318# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and
319# unions are shown inside the group in which they are included (e.g. using
320# @ingroup) instead of on a separate page (for HTML and Man pages) or
321# section (for LaTeX and RTF).
322
323#INLINE_GROUPED_CLASSES = NO
324
325# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and
326# unions with only public data fields will be shown inline in the documentation
327# of the scope in which they are defined (i.e. file, namespace, or group
328# documentation), provided this scope is documented. If set to NO (the default),
329# structs, classes, and unions are shown on a separate page (for HTML and Man
330# pages) or section (for LaTeX and RTF).
331
332#INLINE_SIMPLE_STRUCTS = NO
333
334# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
335# is documented as struct, union, or enum with the name of the typedef. So
336# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
337# with name TypeT. When disabled the typedef will appear as a member of a file,
338# namespace, or class. And the struct will be named TypeS. This can typically
339# be useful for C code in case the coding convention dictates that all compound
340# types are typedef'ed and only the typedef is referenced, never the tag name.
341
342TYPEDEF_HIDES_STRUCT = YES
343
344# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
345# determine which symbols to keep in memory and which to flush to disk.
346# When the cache is full, less often used symbols will be written to disk.
347# For small to medium size projects (<1000 input files) the default value is
348# probably good enough. For larger projects a too small cache size can cause
349# doxygen to be busy swapping symbols to and from disk most of the time
350# causing a significant performance penalty.
351# If the system has enough physical memory increasing the cache will improve the
352# performance by keeping more symbols in memory. Note that the value works on
353# a logarithmic scale so increasing the size by one will roughly double the
354# memory usage. The cache size is given by this formula:
355# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
356# corresponding to a cache size of 2^16 = 65536 symbols.
357
358#SYMBOL_CACHE_SIZE = 0
359
360# Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be
361# set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given
362# their name and scope. Since this can be an expensive process and often the
363# same symbol appear multiple times in the code, doxygen keeps a cache of
364# pre-resolved symbols. If the cache is too small doxygen will become slower.
365# If the cache is too large, memory is wasted. The cache size is given by this
366# formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0,
367# corresponding to a cache size of 2^16 = 65536 symbols.
368
369#LOOKUP_CACHE_SIZE = 0
370
371#---------------------------------------------------------------------------
372# Build related configuration options
373#---------------------------------------------------------------------------
374
375# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
376# documentation are documented, even if no documentation was available.
377# Private class members and static file members will be hidden unless
378# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
379
380EXTRACT_ALL = NO
381
382# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
383# will be included in the documentation.
384
385EXTRACT_PRIVATE = YES
386
387# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
388# scope will be included in the documentation.
389
390#EXTRACT_PACKAGE = NO
391
392# If the EXTRACT_STATIC tag is set to YES all static members of a file
393# will be included in the documentation.
394
395EXTRACT_STATIC = YES
396
397# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
398# defined locally in source files will be included in the documentation.
399# If set to NO only classes defined in header files are included.
400
401EXTRACT_LOCAL_CLASSES = NO
402
403# This flag is only useful for Objective-C code. When set to YES local
404# methods, which are defined in the implementation section but not in
405# the interface are included in the documentation.
406# If set to NO (the default) only methods in the interface are included.
407
408EXTRACT_LOCAL_METHODS = YES
409
410# If this flag is set to YES, the members of anonymous namespaces will be
411# extracted and appear in the documentation as a namespace called
412# 'anonymous_namespace{file}', where file will be replaced with the base
413# name of the file that contains the anonymous namespace. By default
414# anonymous namespaces are hidden.
415
416EXTRACT_ANON_NSPACES = NO
417
418# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
419# undocumented members of documented classes, files or namespaces.
420# If set to NO (the default) these members will be included in the
421# various overviews, but no documentation section is generated.
422# This option has no effect if EXTRACT_ALL is enabled.
423
424HIDE_UNDOC_MEMBERS = YES
425
426# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
427# undocumented classes that are normally visible in the class hierarchy.
428# If set to NO (the default) these classes will be included in the various
429# overviews. This option has no effect if EXTRACT_ALL is enabled.
430
431HIDE_UNDOC_CLASSES = YES
432
433# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
434# friend (class|struct|union) declarations.
435# If set to NO (the default) these declarations will be included in the
436# documentation.
437
438HIDE_FRIEND_COMPOUNDS = YES
439
440# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
441# documentation blocks found inside the body of a function.
442# If set to NO (the default) these blocks will be appended to the
443# function's detailed documentation block.
444
445HIDE_IN_BODY_DOCS = YES
446
447# The INTERNAL_DOCS tag determines if documentation
448# that is typed after a \internal command is included. If the tag is set
449# to NO (the default) then the documentation will be excluded.
450# Set it to YES to include the internal documentation.
451
452INTERNAL_DOCS = NO
453
454# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
455# file names in lower-case letters. If set to YES upper-case letters are also
456# allowed. This is useful if you have classes or files whose names only differ
457# in case and if your file system supports case sensitive file names. Windows
458# and Mac users are advised to set this option to NO.
459
460CASE_SENSE_NAMES = NO
461
462# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
463# will show members with their full class and namespace scopes in the
464# documentation. If set to YES the scope will be hidden.
465
466HIDE_SCOPE_NAMES = NO
467
468# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
469# will put a list of the files that are included by a file in the documentation
470# of that file.
471
472SHOW_INCLUDE_FILES = NO
473
474# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
475# will list include files with double quotes in the documentation
476# rather than with sharp brackets.
477
478FORCE_LOCAL_INCLUDES = NO
479
480# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
481# is inserted in the documentation for inline members.
482
483INLINE_INFO = YES
484
485# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
486# will sort the (detailed) documentation of file and class members
487# alphabetically by member name. If set to NO the members will appear in
488# declaration order.
489
490SORT_MEMBER_DOCS = YES
491
492# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
493# brief documentation of file, namespace and class members alphabetically
494# by member name. If set to NO (the default) the members will appear in
495# declaration order.
496
497SORT_BRIEF_DOCS = NO
498
499# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
500# will sort the (brief and detailed) documentation of class members so that
501# constructors and destructors are listed first. If set to NO (the default)
502# the constructors will appear in the respective orders defined by
503# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
504# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
505# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
506
507SORT_MEMBERS_CTORS_1ST = NO
508
509# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
510# hierarchy of group names into alphabetical order. If set to NO (the default)
511# the group names will appear in their defined order.
512
513SORT_GROUP_NAMES = NO
514
515# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
516# sorted by fully-qualified names, including namespaces. If set to
517# NO (the default), the class list will be sorted only by class name,
518# not including the namespace part.
519# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
520# Note: This option applies only to the class list, not to the
521# alphabetical list.
522
523SORT_BY_SCOPE_NAME = NO
524
525# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to
526# do proper type resolution of all parameters of a function it will reject a
527# match between the prototype and the implementation of a member function even
528# if there is only one candidate or it is obvious which candidate to choose
529# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen
530# will still accept a match between prototype and implementation in such cases.
531
532#STRICT_PROTO_MATCHING = NO
533
534# The GENERATE_TODOLIST tag can be used to enable (YES) or
535# disable (NO) the todo list. This list is created by putting \todo
536# commands in the documentation.
537
538GENERATE_TODOLIST = YES
539
540# The GENERATE_TESTLIST tag can be used to enable (YES) or
541# disable (NO) the test list. This list is created by putting \test
542# commands in the documentation.
543
544GENERATE_TESTLIST = YES
545
546# The GENERATE_BUGLIST tag can be used to enable (YES) or
547# disable (NO) the bug list. This list is created by putting \bug
548# commands in the documentation.
549
550GENERATE_BUGLIST = YES
551
552# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
553# disable (NO) the deprecated list. This list is created by putting
554# \deprecated commands in the documentation.
555
556GENERATE_DEPRECATEDLIST= YES
557
558# The ENABLED_SECTIONS tag can be used to enable conditional
559# documentation sections, marked by \if section-label ... \endif
560# and \cond section-label ... \endcond blocks.
561
562ENABLED_SECTIONS =
563
564# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
565# the initial value of a variable or macro consists of for it to appear in
566# the documentation. If the initializer consists of more lines than specified
567# here it will be hidden. Use a value of 0 to hide initializers completely.
568# The appearance of the initializer of individual variables and macros in the
569# documentation can be controlled using \showinitializer or \hideinitializer
570# command in the documentation regardless of this setting.
571
572MAX_INITIALIZER_LINES = 30
573
574# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
575# at the bottom of the documentation of classes and structs. If set to YES the
576# list will mention the files that were used to generate the documentation.
577
578SHOW_USED_FILES = NO
579
580# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
581# This will remove the Files entry from the Quick Index and from the
582# Folder Tree View (if specified). The default is YES.
583
584SHOW_FILES = NO
585
586# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
587# Namespaces page. This will remove the Namespaces entry from the Quick Index
588# and from the Folder Tree View (if specified). The default is YES.
589
590SHOW_NAMESPACES = YES
591
592# The FILE_VERSION_FILTER tag can be used to specify a program or script that
593# doxygen should invoke to get the current version for each file (typically from
594# the version control system). Doxygen will invoke the program by executing (via
595# popen()) the command <command> <input-file>, where <command> is the value of
596# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
597# provided by doxygen. Whatever the program writes to standard output
598# is used as the file version. See the manual for examples.
599
600FILE_VERSION_FILTER =
601
602# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
603# by doxygen. The layout file controls the global structure of the generated
604# output files in an output format independent way. To create the layout file
605# that represents doxygen's defaults, run doxygen with the -l option.
606# You can optionally specify a file name after the option, if omitted
607# DoxygenLayout.xml will be used as the name of the layout file.
608
609LAYOUT_FILE =
610
611# The CITE_BIB_FILES tag can be used to specify one or more bib files
612# containing the references data. This must be a list of .bib files. The
613# .bib extension is automatically appended if omitted. Using this command
614# requires the bibtex tool to be installed. See also
615# http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style
616# of the bibliography can be controlled using LATEX_BIB_STYLE. To use this
617# feature you need bibtex and perl available in the search path. Do not use
618# file names with spaces, bibtex cannot handle them.
619
620#CITE_BIB_FILES =
621
622#---------------------------------------------------------------------------
623# configuration options related to warning and progress messages
624#---------------------------------------------------------------------------
625
626# The QUIET tag can be used to turn on/off the messages that are generated
627# by doxygen. Possible values are YES and NO. If left blank NO is used.
628
629QUIET = YES
630
631# The WARNINGS tag can be used to turn on/off the warning messages that are
632# generated by doxygen. Possible values are YES and NO. If left blank
633# NO is used.
634
635WARNINGS = YES
636
637# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
638# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
639# automatically be disabled.
640
641WARN_IF_UNDOCUMENTED = YES
642
643# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
644# potential errors in the documentation, such as not documenting some
645# parameters in a documented function, or documenting parameters that
646# don't exist or using markup commands wrongly.
647
648WARN_IF_DOC_ERROR = YES
649
650# The WARN_NO_PARAMDOC option can be enabled to get warnings for
651# functions that are documented, but have no documentation for their parameters
652# or return value. If set to NO (the default) doxygen will only warn about
653# wrong or incomplete parameter documentation, but not about the absence of
654# documentation.
655
656WARN_NO_PARAMDOC = NO
657
658# The WARN_FORMAT tag determines the format of the warning messages that
659# doxygen can produce. The string should contain the $file, $line, and $text
660# tags, which will be replaced by the file and line number from which the
661# warning originated and the warning text. Optionally the format may contain
662# $version, which will be replaced by the version of the file (if it could
663# be obtained via FILE_VERSION_FILTER)
664
665WARN_FORMAT = "$file:$line: $text"
666
667# The WARN_LOGFILE tag can be used to specify a file to which warning
668# and error messages should be written. If left blank the output is written
669# to stderr.
670
671WARN_LOGFILE =
672
673#---------------------------------------------------------------------------
674# configuration options related to the input files
675#---------------------------------------------------------------------------
676
677# The INPUT tag can be used to specify the files and/or directories that contain
678# documented source files. You may enter file names like "myfile.cpp" or
679# directories like "/usr/src/myproject". Separate the files or directories
680# with spaces.
681
682INPUT = ../include/cf \
683 ../src \
684 ../doc \
685
686# This tag can be used to specify the character encoding of the source files
687# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
688# also the default input encoding. Doxygen uses libiconv (or the iconv built
689# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
690# the list of possible encodings.
691
692INPUT_ENCODING = UTF-8
693
694# If the value of the INPUT tag contains directories, you can use the
695# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
696# and *.h) to filter out the source-files in the directories. If left
697# blank the following patterns are tested:
698# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh
699# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
700# *.f90 *.f *.for *.vhd *.vhdl
701
702FILE_PATTERNS = *.h \
703 *.hpp \
704 *.cpp \
705 *.dox \
706
707# The RECURSIVE tag can be used to turn specify whether or not subdirectories
708# should be searched for input files as well. Possible values are YES and NO.
709# If left blank NO is used.
710
711RECURSIVE = YES
712
713# The EXCLUDE tag can be used to specify files and/or directories that should be
714# excluded from the INPUT source files. This way you can easily exclude a
715# subdirectory from a directory tree whose root is specified with the INPUT tag.
716# Note that relative paths are relative to the directory from which doxygen is
717# run.
718
719EXCLUDE =
720
721# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
722# directories that are symbolic links (a Unix file system feature) are excluded
723# from the input.
724
725EXCLUDE_SYMLINKS = NO
726
727# If the value of the INPUT tag contains directories, you can use the
728# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
729# certain files from those directories. Note that the wildcards are matched
730# against the file with absolute path, so to exclude all test directories
731# for example use the pattern */test/*
732
733EXCLUDE_PATTERNS =
734
735# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
736# (namespaces, classes, functions, etc.) that should be excluded from the
737# output. The symbol name can be a fully qualified name, a word, or if the
738# wildcard * is used, a substring. Examples: ANamespace, AClass,
739# AClass::ANamespace, ANamespace::*Test
740
741EXCLUDE_SYMBOLS =
742
743# The EXAMPLE_PATH tag can be used to specify one or more files or
744# directories that contain example code fragments that are included (see
745# the \include command).
746
747EXAMPLE_PATH = ../example
748
749# If the value of the EXAMPLE_PATH tag contains directories, you can use the
750# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
751# and *.h) to filter out the source-files in the directories. If left
752# blank all files are included.
753
754EXAMPLE_PATTERNS = *
755
756# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
757# searched for input files to be used with the \include or \dontinclude
758# commands irrespective of the value of the RECURSIVE tag.
759# Possible values are YES and NO. If left blank NO is used.
760
761EXAMPLE_RECURSIVE = NO
762
763# The IMAGE_PATH tag can be used to specify one or more files or
764# directories that contain image that are included in the documentation (see
765# the \image command).
766
767IMAGE_PATH =
768
769# The INPUT_FILTER tag can be used to specify a program that doxygen should
770# invoke to filter for each input file. Doxygen will invoke the filter program
771# by executing (via popen()) the command <filter> <input-file>, where <filter>
772# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
773# input file. Doxygen will then use the output that the filter program writes
774# to standard output. If FILTER_PATTERNS is specified, this tag will be
775# ignored.
776
777INPUT_FILTER =
778
779# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
780# basis. Doxygen will compare the file name with each pattern and apply the
781# filter if there is a match. The filters are a list of the form:
782# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
783# info on how filters are used. If FILTER_PATTERNS is empty or if
784# non of the patterns match the file name, INPUT_FILTER is applied.
785
786FILTER_PATTERNS =
787
788# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
789# INPUT_FILTER) will be used to filter the input files when producing source
790# files to browse (i.e. when SOURCE_BROWSER is set to YES).
791
792FILTER_SOURCE_FILES = NO
793
794# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
795# pattern. A pattern will override the setting for FILTER_PATTERN (if any)
796# and it is also possible to disable source filtering for a specific pattern
797# using *.ext= (so without naming a filter). This option only has effect when
798# FILTER_SOURCE_FILES is enabled.
799
800#FILTER_SOURCE_PATTERNS =
801
802# If the USE_MD_FILE_AS_MAINPAGE tag refers to the name of a markdown file that
803# is part of the input, its contents will be placed on the main page (index.html).
804# This can be useful if you have a project on for instance GitHub and want reuse
805# the introduction page also for the doxygen output.
806
807#USE_MDFILE_AS_MAINPAGE =
808
809#---------------------------------------------------------------------------
810# configuration options related to source browsing
811#---------------------------------------------------------------------------
812
813# If the SOURCE_BROWSER tag is set to YES then a list of source files will
814# be generated. Documented entities will be cross-referenced with these sources.
815# Note: To get rid of all source code in the generated output, make sure also
816# VERBATIM_HEADERS is set to NO.
817
818SOURCE_BROWSER = NO
819
820# Setting the INLINE_SOURCES tag to YES will include the body
821# of functions and classes directly in the documentation.
822
823INLINE_SOURCES = NO
824
825# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
826# doxygen to hide any special comment blocks from generated source code
827# fragments. Normal C, C++ and Fortran comments will always remain visible.
828
829STRIP_CODE_COMMENTS = YES
830
831# If the REFERENCED_BY_RELATION tag is set to YES
832# then for each documented function all documented
833# functions referencing it will be listed.
834
835REFERENCED_BY_RELATION = NO
836
837# If the REFERENCES_RELATION tag is set to YES
838# then for each documented function all documented entities
839# called/used by that function will be listed.
840
841REFERENCES_RELATION = NO
842
843# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
844# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
845# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
846# link to the source code. Otherwise they will link to the documentation.
847
848REFERENCES_LINK_SOURCE = YES
849
850# If the USE_HTAGS tag is set to YES then the references to source code
851# will point to the HTML generated by the htags(1) tool instead of doxygen
852# built-in source browser. The htags tool is part of GNU's global source
853# tagging system (see http://www.gnu.org/software/global/global.html). You
854# will need version 4.8.6 or higher.
855
856USE_HTAGS = NO
857
858# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
859# will generate a verbatim copy of the header file for each class for
860# which an include is specified. Set to NO to disable this.
861
862VERBATIM_HEADERS = YES
863
864#---------------------------------------------------------------------------
865# configuration options related to the alphabetical class index
866#---------------------------------------------------------------------------
867
868# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
869# of all compounds will be generated. Enable this if the project
870# contains a lot of classes, structs, unions or interfaces.
871
872ALPHABETICAL_INDEX = YES
873
874# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
875# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
876# in which this list will be split (can be a number in the range [1..20])
877
878COLS_IN_ALPHA_INDEX = 5
879
880# In case all classes in a project start with a common prefix, all
881# classes will be put under the same header in the alphabetical index.
882# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
883# should be ignored while generating the index headers.
884
885IGNORE_PREFIX =
886
887#---------------------------------------------------------------------------
888# configuration options related to the HTML output
889#---------------------------------------------------------------------------
890
891# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
892# generate HTML output.
893
894GENERATE_HTML = YES
895
896# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
897# If a relative path is entered the value of OUTPUT_DIRECTORY will be
898# put in front of it. If left blank `html' will be used as the default path.
899
900HTML_OUTPUT = html
901
902# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
903# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
904# doxygen will generate files with .html extension.
905
906HTML_FILE_EXTENSION = .html
907
908# The HTML_HEADER tag can be used to specify a personal HTML header for
909# each generated HTML page. If it is left blank doxygen will generate a
910# standard header. Note that when using a custom header you are responsible
911# for the proper inclusion of any scripts and style sheets that doxygen
912# needs, which is dependent on the configuration options used.
913# It is advised to generate a default header using "doxygen -w html
914# header.html footer.html stylesheet.css YourConfigFile" and then modify
915# that header. Note that the header is subject to change so you typically
916# have to redo this when upgrading to a newer version of doxygen or when
917# changing the value of configuration settings such as GENERATE_TREEVIEW!
918
919HTML_HEADER =
920
921# The HTML_FOOTER tag can be used to specify a personal HTML footer for
922# each generated HTML page. If it is left blank doxygen will generate a
923# standard footer.
924
925HTML_FOOTER =
926
927# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
928# style sheet that is used by each HTML page. It can be used to
929# fine-tune the look of the HTML output. If left blank doxygen will
930# generate a default style sheet. Note that it is recommended to use
931# HTML_EXTRA_STYLESHEET instead of this one, as it is more robust and this
932# tag will in the future become obsolete.
933
934HTML_STYLESHEET =
935
936# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional
937# user-defined cascading style sheet that is included after the standard
938# style sheets created by doxygen. Using this option one can overrule
939# certain style aspects. This is preferred over using HTML_STYLESHEET
940# since it does not replace the standard style sheet and is therefor more
941# robust against future updates. Doxygen will copy the style sheet file to
942# the output directory.
943
944#HTML_EXTRA_STYLESHEET =
945
946# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
947# other source files which should be copied to the HTML output directory. Note
948# that these files will be copied to the base HTML output directory. Use the
949# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
950# files. In the HTML_STYLESHEET file, use the file name only. Also note that
951# the files will be copied as-is; there are no commands or markers available.
952
953#HTML_EXTRA_FILES =
954
955# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
956# Doxygen will adjust the colors in the style sheet and background images
957# according to this color. Hue is specified as an angle on a colorwheel,
958# see http://en.wikipedia.org/wiki/Hue for more information.
959# For instance the value 0 represents red, 60 is yellow, 120 is green,
960# 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
961# The allowed range is 0 to 359.
962
963HTML_COLORSTYLE_HUE = 220
964
965# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
966# the colors in the HTML output. For a value of 0 the output will use
967# grayscales only. A value of 255 will produce the most vivid colors.
968
969HTML_COLORSTYLE_SAT = 100
970
971# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
972# the luminance component of the colors in the HTML output. Values below
973# 100 gradually make the output lighter, whereas values above 100 make
974# the output darker. The value divided by 100 is the actual gamma applied,
975# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
976# and 100 does not change the gamma.
977
978HTML_COLORSTYLE_GAMMA = 80
979
980# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
981# page will contain the date and time when the page was generated. Setting
982# this to NO can help when comparing the output of multiple runs.
983
984HTML_TIMESTAMP = YES
985
986# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
987# documentation will contain sections that can be hidden and shown after the
988# page has loaded.
989
990HTML_DYNAMIC_SECTIONS = NO
991
992# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of
993# entries shown in the various tree structured indices initially; the user
994# can expand and collapse entries dynamically later on. Doxygen will expand
995# the tree to such a level that at most the specified number of entries are
996# visible (unless a fully collapsed tree already exceeds this amount).
997# So setting the number of entries 1 will produce a full collapsed tree by
998# default. 0 is a special value representing an infinite number of entries
999# and will result in a full expanded tree by default.
1000
1001#HTML_INDEX_NUM_ENTRIES = 100
1002
1003# If the GENERATE_DOCSET tag is set to YES, additional index files
1004# will be generated that can be used as input for Apple's Xcode 3
1005# integrated development environment, introduced with OSX 10.5 (Leopard).
1006# To create a documentation set, doxygen will generate a Makefile in the
1007# HTML output directory. Running make will produce the docset in that
1008# directory and running "make install" will install the docset in
1009# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
1010# it at startup.
1011# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
1012# for more information.
1013
1014GENERATE_DOCSET = NO
1015
1016# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
1017# feed. A documentation feed provides an umbrella under which multiple
1018# documentation sets from a single provider (such as a company or product suite)
1019# can be grouped.
1020
1021DOCSET_FEEDNAME = "Doxygen generated docs"
1022
1023# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
1024# should uniquely identify the documentation set bundle. This should be a
1025# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
1026# will append .docset to the name.
1027
1028DOCSET_BUNDLE_ID = org.doxygen.Project
1029
1030# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely
1031# identify the documentation publisher. This should be a reverse domain-name
1032# style string, e.g. com.mycompany.MyDocSet.documentation.
1033
1034DOCSET_PUBLISHER_ID = org.doxygen.Publisher
1035
1036# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
1037
1038DOCSET_PUBLISHER_NAME = Publisher
1039
1040# If the GENERATE_HTMLHELP tag is set to YES, additional index files
1041# will be generated that can be used as input for tools like the
1042# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
1043# of the generated HTML documentation.
1044
1045GENERATE_HTMLHELP = NO
1046
1047# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
1048# be used to specify the file name of the resulting .chm file. You
1049# can add a path in front of the file if the result should not be
1050# written to the html output directory.
1051
1052CHM_FILE =
1053
1054# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
1055# be used to specify the location (absolute path including file name) of
1056# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
1057# the HTML help compiler on the generated index.hhp.
1058
1059HHC_LOCATION =
1060
1061# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
1062# controls if a separate .chi index file is generated (YES) or that
1063# it should be included in the master .chm file (NO).
1064
1065GENERATE_CHI = NO
1066
1067# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
1068# is used to encode HtmlHelp index (hhk), content (hhc) and project file
1069# content.
1070
1071CHM_INDEX_ENCODING =
1072
1073# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
1074# controls whether a binary table of contents is generated (YES) or a
1075# normal table of contents (NO) in the .chm file.
1076
1077BINARY_TOC = NO
1078
1079# The TOC_EXPAND flag can be set to YES to add extra items for group members
1080# to the contents of the HTML help documentation and to the tree view.
1081
1082TOC_EXPAND = NO
1083
1084# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1085# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
1086# that can be used as input for Qt's qhelpgenerator to generate a
1087# Qt Compressed Help (.qch) of the generated HTML documentation.
1088
1089GENERATE_QHP = NO
1090
1091# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
1092# be used to specify the file name of the resulting .qch file.
1093# The path specified is relative to the HTML output folder.
1094
1095QCH_FILE =
1096
1097# The QHP_NAMESPACE tag specifies the namespace to use when generating
1098# Qt Help Project output. For more information please see
1099# http://doc.trolltech.com/qthelpproject.html#namespace
1100
1101QHP_NAMESPACE = org.doxygen.Project
1102
1103# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
1104# Qt Help Project output. For more information please see
1105# http://doc.trolltech.com/qthelpproject.html#virtual-folders
1106
1107QHP_VIRTUAL_FOLDER = doc
1108
1109# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
1110# add. For more information please see
1111# http://doc.trolltech.com/qthelpproject.html#custom-filters
1112
1113QHP_CUST_FILTER_NAME =
1114
1115# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
1116# custom filter to add. For more information please see
1117# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
1118# Qt Help Project / Custom Filters</a>.
1119
1120QHP_CUST_FILTER_ATTRS =
1121
1122# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1123# project's
1124# filter section matches.
1125# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
1126# Qt Help Project / Filter Attributes</a>.
1127
1128QHP_SECT_FILTER_ATTRS =
1129
1130# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
1131# be used to specify the location of Qt's qhelpgenerator.
1132# If non-empty doxygen will try to run qhelpgenerator on the generated
1133# .qhp file.
1134
1135QHG_LOCATION =
1136
1137# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
1138# will be generated, which together with the HTML files, form an Eclipse help
1139# plugin. To install this plugin and make it available under the help contents
1140# menu in Eclipse, the contents of the directory containing the HTML and XML
1141# files needs to be copied into the plugins directory of eclipse. The name of
1142# the directory within the plugins directory should be the same as
1143# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
1144# the help appears.
1145
1146GENERATE_ECLIPSEHELP = NO
1147
1148# A unique identifier for the eclipse help plugin. When installing the plugin
1149# the directory name containing the HTML and XML files should also have
1150# this name.
1151
1152ECLIPSE_DOC_ID = org.doxygen.Project
1153
1154# The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs)
1155# at top of each HTML page. The value NO (the default) enables the index and
1156# the value YES disables it. Since the tabs have the same information as the
1157# navigation tree you can set this option to NO if you already set
1158# GENERATE_TREEVIEW to YES.
1159
1160DISABLE_INDEX = NO
1161
1162# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1163# structure should be generated to display hierarchical information.
1164# If the tag value is set to YES, a side panel will be generated
1165# containing a tree-like index structure (just like the one that
1166# is generated for HTML Help). For this to work a browser that supports
1167# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
1168# Windows users are probably better off using the HTML help feature.
1169# Since the tree basically has the same information as the tab index you
1170# could consider to set DISABLE_INDEX to NO when enabling this option.
1171
1172GENERATE_TREEVIEW = YES
1173
1174# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
1175# (range [0,1..20]) that doxygen will group on one line in the generated HTML
1176# documentation. Note that a value of 0 will completely suppress the enum
1177# values from appearing in the overview section.
1178
1179ENUM_VALUES_PER_LINE = 4
1180
1181# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
1182# used to set the initial width (in pixels) of the frame in which the tree
1183# is shown.
1184
1185TREEVIEW_WIDTH = 250
1186
1187# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
1188# links to external symbols imported via tag files in a separate window.
1189
1190EXT_LINKS_IN_WINDOW = NO
1191
1192# Use this tag to change the font size of Latex formulas included
1193# as images in the HTML documentation. The default is 10. Note that
1194# when you change the font size after a successful doxygen run you need
1195# to manually remove any form_*.png images from the HTML output directory
1196# to force them to be regenerated.
1197
1198FORMULA_FONTSIZE = 10
1199
1200# Use the FORMULA_TRANPARENT tag to determine whether or not the images
1201# generated for formulas are transparent PNGs. Transparent PNGs are
1202# not supported properly for IE 6.0, but are supported on all modern browsers.
1203# Note that when changing this option you need to delete any form_*.png files
1204# in the HTML output before the changes have effect.
1205
1206FORMULA_TRANSPARENT = YES
1207
1208# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax
1209# (see http://www.mathjax.org) which uses client side Javascript for the
1210# rendering instead of using prerendered bitmaps. Use this if you do not
1211# have LaTeX installed or if you want to formulas look prettier in the HTML
1212# output. When enabled you may also need to install MathJax separately and
1213# configure the path to it using the MATHJAX_RELPATH option.
1214
1215#USE_MATHJAX = NO
1216
1217# When MathJax is enabled you can set the default output format to be used for
1218# thA MathJax output. Supported types are HTML-CSS, NativeMML (i.e. MathML) and
1219# SVG. The default value is HTML-CSS, which is slower, but has the best
1220# compatibility.
1221
1222#MATHJAX_FORMAT = HTML-CSS
1223
1224# When MathJax is enabled you need to specify the location relative to the
1225# HTML output directory using the MATHJAX_RELPATH option. The destination
1226# directory should contain the MathJax.js script. For instance, if the mathjax
1227# directory is located at the same level as the HTML output directory, then
1228# MATHJAX_RELPATH should be ../mathjax. The default value points to
1229# the MathJax Content Delivery Network so you can quickly see the result without
1230# installing MathJax. However, it is strongly recommended to install a local
1231# copy of MathJax from http://www.mathjax.org before deployment.
1232
1233#MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
1234
1235# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension
1236# names that should be enabled during MathJax rendering.
1237
1238#MATHJAX_EXTENSIONS =
1239
1240# When the SEARCHENGINE tag is enabled doxygen will generate a search box
1241# for the HTML output. The underlying search engine uses javascript
1242# and DHTML and should work on any modern browser. Note that when using
1243# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
1244# (GENERATE_DOCSET) there is already a search function so this one should
1245# typically be disabled. For large projects the javascript based search engine
1246# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
1247
1248SEARCHENGINE = YES
1249
1250# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1251# implemented using a web server instead of a web client using Javascript.
1252# There are two flavours of web server based search depending on the
1253# EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for
1254# searching and an index file used by the script. When EXTERNAL_SEARCH is
1255# enabled the indexing and searching needs to be provided by external tools.
1256# See the manual for details.
1257
1258SERVER_BASED_SEARCH = NO
1259
1260# When EXTERNAL_SEARCH is enabled doxygen will no longer generate the PHP
1261# script for searching. Instead the search results are written to an XML file
1262# which needs to be processed by an external indexer. Doxygen will invoke an
1263# external search engine pointed to by the SEARCHENGINE_URL option to obtain
1264# the search results. Doxygen ships with an example indexer (doxyindexer) and
1265# search engine (doxysearch.cgi) which are based on the open source search engine
1266# library Xapian. See the manual for configuration details.
1267
1268#EXTERNAL_SEARCH = NO
1269
1270# The SEARCHENGINE_URL should point to a search engine hosted by a web server
1271# which will returned the search results when EXTERNAL_SEARCH is enabled.
1272# Doxygen ships with an example search engine (doxysearch) which is based on
1273# the open source search engine library Xapian. See the manual for configuration
1274# details.
1275
1276#SEARCHENGINE_URL =
1277
1278# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
1279# search data is written to a file for indexing by an external tool. With the
1280# SEARCHDATA_FILE tag the name of this file can be specified.
1281
1282#SEARCHDATA_FILE = searchdata.xml
1283
1284# When SERVER_BASED_SEARCH AND EXTERNAL_SEARCH are both enabled the
1285# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1286# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1287# projects and redirect the results back to the right project.
1288
1289#EXTERNAL_SEARCH_ID =
1290
1291# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1292# projects other than the one defined by this configuration file, but that are
1293# all added to the same external search index. Each project needs to have a
1294# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id
1295# of to a relative location where the documentation can be found.
1296# The format is: EXTRA_SEARCH_MAPPINGS = id1=loc1 id2=loc2 ...
1297
1298#EXTRA_SEARCH_MAPPINGS =
1299
1300#---------------------------------------------------------------------------
1301# configuration options related to the LaTeX output
1302#---------------------------------------------------------------------------
1303
1304# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
1305# generate Latex output.
1306
1307GENERATE_LATEX = NO
1308
1309# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1310# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1311# put in front of it. If left blank `latex' will be used as the default path.
1312
1313LATEX_OUTPUT = latex
1314
1315# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1316# invoked. If left blank `latex' will be used as the default command name.
1317# Note that when enabling USE_PDFLATEX this option is only used for
1318# generating bitmaps for formulas in the HTML output, but not in the
1319# Makefile that is written to the output directory.
1320
1321LATEX_CMD_NAME = latex
1322
1323# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1324# generate index for LaTeX. If left blank `makeindex' will be used as the
1325# default command name.
1326
1327MAKEINDEX_CMD_NAME = makeindex
1328
1329# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1330# LaTeX documents. This may be useful for small projects and may help to
1331# save some trees in general.
1332
1333COMPACT_LATEX = NO
1334
1335# The PAPER_TYPE tag can be used to set the paper type that is used
1336# by the printer. Possible values are: a4, letter, legal and
1337# executive. If left blank a4wide will be used.
1338
1339PAPER_TYPE = a4
1340
1341# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1342# packages that should be included in the LaTeX output.
1343
1344EXTRA_PACKAGES =
1345
1346# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1347# the generated latex document. The header should contain everything until
1348# the first chapter. If it is left blank doxygen will generate a
1349# standard header. Notice: only use this tag if you know what you are doing!
1350
1351LATEX_HEADER =
1352
1353# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for
1354# the generated latex document. The footer should contain everything after
1355# the last chapter. If it is left blank doxygen will generate a
1356# standard footer. Notice: only use this tag if you know what you are doing!
1357
1358#LATEX_FOOTER =
1359
1360# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1361# is prepared for conversion to pdf (using ps2pdf). The pdf file will
1362# contain links (just like the HTML output) instead of page references
1363# This makes the output suitable for online browsing using a pdf viewer.
1364
1365PDF_HYPERLINKS = YES
1366
1367# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1368# plain latex in the generated Makefile. Set this option to YES to get a
1369# higher quality PDF documentation.
1370
1371USE_PDFLATEX = YES
1372
1373# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1374# command to the generated LaTeX files. This will instruct LaTeX to keep
1375# running if errors occur, instead of asking the user for help.
1376# This option is also used when generating formulas in HTML.
1377
1378LATEX_BATCHMODE = NO
1379
1380# If LATEX_HIDE_INDICES is set to YES then doxygen will not
1381# include the index chapters (such as File Index, Compound Index, etc.)
1382# in the output.
1383
1384LATEX_HIDE_INDICES = NO
1385
1386# If LATEX_SOURCE_CODE is set to YES then doxygen will include
1387# source code with syntax highlighting in the LaTeX output.
1388# Note that which sources are shown also depends on other settings
1389# such as SOURCE_BROWSER.
1390
1391LATEX_SOURCE_CODE = NO
1392
1393# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1394# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See
1395# http://en.wikipedia.org/wiki/BibTeX for more info.
1396
1397#LATEX_BIB_STYLE = plain
1398
1399#---------------------------------------------------------------------------
1400# configuration options related to the RTF output
1401#---------------------------------------------------------------------------
1402
1403# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1404# The RTF output is optimized for Word 97 and may not look very pretty with
1405# other RTF readers or editors.
1406
1407GENERATE_RTF = NO
1408
1409# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1410# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1411# put in front of it. If left blank `rtf' will be used as the default path.
1412
1413RTF_OUTPUT = rtf
1414
1415# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1416# RTF documents. This may be useful for small projects and may help to
1417# save some trees in general.
1418
1419COMPACT_RTF = NO
1420
1421# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1422# will contain hyperlink fields. The RTF file will
1423# contain links (just like the HTML output) instead of page references.
1424# This makes the output suitable for online browsing using WORD or other
1425# programs which support those fields.
1426# Note: wordpad (write) and others do not support links.
1427
1428RTF_HYPERLINKS = NO
1429
1430# Load style sheet definitions from file. Syntax is similar to doxygen's
1431# config file, i.e. a series of assignments. You only have to provide
1432# replacements, missing definitions are set to their default value.
1433
1434RTF_STYLESHEET_FILE =
1435
1436# Set optional variables used in the generation of an rtf document.
1437# Syntax is similar to doxygen's config file.
1438
1439RTF_EXTENSIONS_FILE =
1440
1441#---------------------------------------------------------------------------
1442# configuration options related to the man page output
1443#---------------------------------------------------------------------------
1444
1445# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1446# generate man pages
1447
1448GENERATE_MAN = NO
1449
1450# The MAN_OUTPUT tag is used to specify where the man pages will be put.
1451# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1452# put in front of it. If left blank `man' will be used as the default path.
1453
1454MAN_OUTPUT = man
1455
1456# The MAN_EXTENSION tag determines the extension that is added to
1457# the generated man pages (default is the subroutine's section .3)
1458
1459MAN_EXTENSION = .3
1460
1461# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1462# then it will generate one additional man file for each entity
1463# documented in the real man page(s). These additional files
1464# only source the real man page, but without them the man command
1465# would be unable to find the correct page. The default is NO.
1466
1467MAN_LINKS = NO
1468
1469#---------------------------------------------------------------------------
1470# configuration options related to the XML output
1471#---------------------------------------------------------------------------
1472
1473# If the GENERATE_XML tag is set to YES Doxygen will
1474# generate an XML file that captures the structure of
1475# the code including all documentation.
1476
1477GENERATE_XML = NO
1478
1479# The XML_OUTPUT tag is used to specify where the XML pages will be put.
1480# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1481# put in front of it. If left blank `xml' will be used as the default path.
1482
1483XML_OUTPUT = xml
1484
1485# The XML_SCHEMA tag can be used to specify an XML schema,
1486# which can be used by a validating XML parser to check the
1487# syntax of the XML files.
1488
1489XML_SCHEMA =
1490
1491# The XML_DTD tag can be used to specify an XML DTD,
1492# which can be used by a validating XML parser to check the
1493# syntax of the XML files.
1494
1495XML_DTD =
1496
1497# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1498# dump the program listings (including syntax highlighting
1499# and cross-referencing information) to the XML output. Note that
1500# enabling this will significantly increase the size of the XML output.
1501
1502XML_PROGRAMLISTING = YES
1503
1504#---------------------------------------------------------------------------
1505# configuration options for the AutoGen Definitions output
1506#---------------------------------------------------------------------------
1507
1508# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1509# generate an AutoGen Definitions (see autogen.sf.net) file
1510# that captures the structure of the code including all
1511# documentation. Note that this feature is still experimental
1512# and incomplete at the moment.
1513
1514GENERATE_AUTOGEN_DEF = NO
1515
1516#---------------------------------------------------------------------------
1517# configuration options related to the Perl module output
1518#---------------------------------------------------------------------------
1519
1520# If the GENERATE_PERLMOD tag is set to YES Doxygen will
1521# generate a Perl module file that captures the structure of
1522# the code including all documentation. Note that this
1523# feature is still experimental and incomplete at the
1524# moment.
1525
1526GENERATE_PERLMOD = NO
1527
1528# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1529# the necessary Makefile rules, Perl scripts and LaTeX code to be able
1530# to generate PDF and DVI output from the Perl module output.
1531
1532PERLMOD_LATEX = NO
1533
1534# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1535# nicely formatted so it can be parsed by a human reader. This is useful
1536# if you want to understand what is going on. On the other hand, if this
1537# tag is set to NO the size of the Perl module output will be much smaller
1538# and Perl will parse it just the same.
1539
1540PERLMOD_PRETTY = YES
1541
1542# The names of the make variables in the generated doxyrules.make file
1543# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1544# This is useful so different doxyrules.make files included by the same
1545# Makefile don't overwrite each other's variables.
1546
1547PERLMOD_MAKEVAR_PREFIX =
1548
1549#---------------------------------------------------------------------------
1550# Configuration options related to the preprocessor
1551#---------------------------------------------------------------------------
1552
1553# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1554# evaluate all C-preprocessor directives found in the sources and include
1555# files.
1556
1557ENABLE_PREPROCESSING = YES
1558
1559# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1560# names in the source code. If set to NO (the default) only conditional
1561# compilation will be performed. Macro expansion can be done in a controlled
1562# way by setting EXPAND_ONLY_PREDEF to YES.
1563
1564MACRO_EXPANSION = NO
1565
1566# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1567# then the macro expansion is limited to the macros specified with the
1568# PREDEFINED and EXPAND_AS_DEFINED tags.
1569
1570EXPAND_ONLY_PREDEF = NO
1571
1572# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1573# pointed to by INCLUDE_PATH will be searched when a #include is found.
1574
1575SEARCH_INCLUDES = YES
1576
1577# The INCLUDE_PATH tag can be used to specify one or more directories that
1578# contain include files that are not input files but should be processed by
1579# the preprocessor.
1580
1581INCLUDE_PATH =
1582
1583# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1584# patterns (like *.h and *.hpp) to filter out the header-files in the
1585# directories. If left blank, the patterns specified with FILE_PATTERNS will
1586# be used.
1587
1588INCLUDE_FILE_PATTERNS =
1589
1590# The PREDEFINED tag can be used to specify one or more macro names that
1591# are defined before the preprocessor is started (similar to the -D option of
1592# gcc). The argument of the tag is a list of macros of the form: name
1593# or name=definition (no spaces). If the definition and the = are
1594# omitted =1 is assumed. To prevent a macro definition from being
1595# undefined via #undef or recursively expanded use the := operator
1596# instead of the = operator.
1597
1598PREDEFINED = _DEBUG
1599
1600# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1601# this tag can be used to specify a list of macro names that should be expanded.
1602# The macro definition that is found in the sources will be used.
1603# Use the PREDEFINED tag if you want to use a different macro definition that
1604# overrules the definition found in the source code.
1605
1606EXPAND_AS_DEFINED =
1607
1608# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1609# doxygen's preprocessor will remove all references to function-like macros
1610# that are alone on a line, have an all uppercase name, and do not end with a
1611# semicolon, because these will confuse the parser if not removed.
1612
1613SKIP_FUNCTION_MACROS = YES
1614
1615#---------------------------------------------------------------------------
1616# Configuration::additions related to external references
1617#---------------------------------------------------------------------------
1618
1619# The TAGFILES option can be used to specify one or more tagfiles. For each
1620# tag file the location of the external documentation should be added. The
1621# format of a tag file without this location is as follows:
1622# TAGFILES = file1 file2 ...
1623# Adding location for the tag files is done as follows:
1624# TAGFILES = file1=loc1 "file2 = loc2" ...
1625# where "loc1" and "loc2" can be relative or absolute paths
1626# or URLs. Note that each tag file must have a unique name (where the name does
1627# NOT include the path). If a tag file is not located in the directory in which
1628# doxygen is run, you must also specify the path to the tagfile here.
1629
1630TAGFILES =
1631
1632# When a file name is specified after GENERATE_TAGFILE, doxygen will create
1633# a tag file that is based on the input files it reads.
1634
1635GENERATE_TAGFILE =
1636
1637# If the ALLEXTERNALS tag is set to YES all external classes will be listed
1638# in the class index. If set to NO only the inherited external classes
1639# will be listed.
1640
1641ALLEXTERNALS = NO
1642
1643# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1644# in the modules index. If set to NO, only the current project's groups will
1645# be listed.
1646
1647EXTERNAL_GROUPS = YES
1648
1649# The PERL_PATH should be the absolute path and name of the perl script
1650# interpreter (i.e. the result of `which perl').
1651
1652PERL_PATH = /usr/bin/perl
1653
1654#---------------------------------------------------------------------------
1655# Configuration options related to the dot tool
1656#---------------------------------------------------------------------------
1657
1658# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1659# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1660# or super classes. Setting the tag to NO turns the diagrams off. Note that
1661# this option also works with HAVE_DOT disabled, but it is recommended to
1662# install and use dot, since it yields more powerful graphs.
1663
1664CLASS_DIAGRAMS = YES
1665
1666# You can define message sequence charts within doxygen comments using the \msc
1667# command. Doxygen will then run the mscgen tool (see
1668# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1669# documentation. The MSCGEN_PATH tag allows you to specify the directory where
1670# the mscgen tool resides. If left empty the tool is assumed to be found in the
1671# default search path.
1672
1673MSCGEN_PATH =
1674
1675# If set to YES, the inheritance and collaboration graphs will hide
1676# inheritance and usage relations if the target is undocumented
1677# or is not a class.
1678
1679HIDE_UNDOC_RELATIONS = YES
1680
1681# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1682# available from the path. This tool is part of Graphviz, a graph visualization
1683# toolkit from AT&T and Lucent Bell Labs. The other options in this section
1684# have no effect if this option is set to NO (the default)
1685
1686HAVE_DOT = NO
1687
1688# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
1689# allowed to run in parallel. When set to 0 (the default) doxygen will
1690# base this on the number of processors available in the system. You can set it
1691# explicitly to a value larger than 0 to get control over the balance
1692# between CPU load and processing speed.
1693
1694DOT_NUM_THREADS = 0
1695
1696# By default doxygen will use the Helvetica font for all dot files that
1697# doxygen generates. When you want a differently looking font you can specify
1698# the font name using DOT_FONTNAME. You need to make sure dot is able to find
1699# the font, which can be done by putting it in a standard location or by setting
1700# the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the
1701# directory containing the font.
1702
1703DOT_FONTNAME = Helvetica
1704
1705# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1706# The default size is 10pt.
1707
1708DOT_FONTSIZE = 10
1709
1710# By default doxygen will tell dot to use the Helvetica font.
1711# If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to
1712# set the path where dot can find it.
1713
1714DOT_FONTPATH =
1715
1716# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1717# will generate a graph for each documented class showing the direct and
1718# indirect inheritance relations. Setting this tag to YES will force the
1719# CLASS_DIAGRAMS tag to NO.
1720
1721CLASS_GRAPH = YES
1722
1723# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1724# will generate a graph for each documented class showing the direct and
1725# indirect implementation dependencies (inheritance, containment, and
1726# class references variables) of the class with other documented classes.
1727
1728COLLABORATION_GRAPH = YES
1729
1730# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1731# will generate a graph for groups, showing the direct groups dependencies
1732
1733GROUP_GRAPHS = YES
1734
1735# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1736# collaboration diagrams in a style similar to the OMG's Unified Modeling
1737# Language.
1738
1739UML_LOOK = NO
1740
1741# If the UML_LOOK tag is enabled, the fields and methods are shown inside
1742# the class node. If there are many fields or methods and many nodes the
1743# graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS
1744# threshold limits the number of items for each type to make the size more
1745# managable. Set this to 0 for no limit. Note that the threshold may be
1746# exceeded by 50% before the limit is enforced.
1747
1748#UML_LIMIT_NUM_FIELDS = 10
1749
1750# If set to YES, the inheritance and collaboration graphs will show the
1751# relations between templates and their instances.
1752
1753TEMPLATE_RELATIONS = YES
1754
1755# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1756# tags are set to YES then doxygen will generate a graph for each documented
1757# file showing the direct and indirect include dependencies of the file with
1758# other documented files.
1759
1760INCLUDE_GRAPH = YES
1761
1762# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1763# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1764# documented header file showing the documented files that directly or
1765# indirectly include this file.
1766
1767INCLUDED_BY_GRAPH = YES
1768
1769# If the CALL_GRAPH and HAVE_DOT options are set to YES then
1770# doxygen will generate a call dependency graph for every global function
1771# or class method. Note that enabling this option will significantly increase
1772# the time of a run. So in most cases it will be better to enable call graphs
1773# for selected functions only using the \callgraph command.
1774
1775CALL_GRAPH = NO
1776
1777# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1778# doxygen will generate a caller dependency graph for every global function
1779# or class method. Note that enabling this option will significantly increase
1780# the time of a run. So in most cases it will be better to enable caller
1781# graphs for selected functions only using the \callergraph command.
1782
1783CALLER_GRAPH = NO
1784
1785# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1786# will generate a graphical hierarchy of all classes instead of a textual one.
1787
1788GRAPHICAL_HIERARCHY = YES
1789
1790# If the DIRECTORY_GRAPH and HAVE_DOT tags are set to YES
1791# then doxygen will show the dependencies a directory has on other directories
1792# in a graphical way. The dependency relations are determined by the #include
1793# relations between the files in the directories.
1794
1795DIRECTORY_GRAPH = YES
1796
1797# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1798# generated by dot. Possible values are svg, png, jpg, or gif.
1799# If left blank png will be used. If you choose svg you need to set
1800# HTML_FILE_EXTENSION to xhtml in order to make the SVG files
1801# visible in IE 9+ (other browsers do not have this requirement).
1802
1803DOT_IMAGE_FORMAT = png
1804
1805# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
1806# enable generation of interactive SVG images that allow zooming and panning.
1807# Note that this requires a modern browser other than Internet Explorer.
1808# Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you
1809# need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files
1810# visible. Older versions of IE do not have SVG support.
1811
1812#INTERACTIVE_SVG = NO
1813
1814# The tag DOT_PATH can be used to specify the path where the dot tool can be
1815# found. If left blank, it is assumed the dot tool can be found in the path.
1816
1817DOT_PATH =
1818
1819# The DOTFILE_DIRS tag can be used to specify one or more directories that
1820# contain dot files that are included in the documentation (see the
1821# \dotfile command).
1822
1823DOTFILE_DIRS =
1824
1825# The MSCFILE_DIRS tag can be used to specify one or more directories that
1826# contain msc files that are included in the documentation (see the
1827# \mscfile command).
1828
1829#MSCFILE_DIRS =
1830
1831# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1832# nodes that will be shown in the graph. If the number of nodes in a graph
1833# becomes larger than this value, doxygen will truncate the graph, which is
1834# visualized by representing a node as a red box. Note that doxygen if the
1835# number of direct children of the root node in a graph is already larger than
1836# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1837# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1838
1839DOT_GRAPH_MAX_NODES = 50
1840
1841# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1842# graphs generated by dot. A depth value of 3 means that only nodes reachable
1843# from the root by following a path via at most 3 edges will be shown. Nodes
1844# that lay further from the root node will be omitted. Note that setting this
1845# option to 1 or 2 may greatly reduce the computation time needed for large
1846# code bases. Also note that the size of a graph can be further restricted by
1847# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1848
1849MAX_DOT_GRAPH_DEPTH = 0
1850
1851# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1852# background. This is disabled by default, because dot on Windows does not
1853# seem to support this out of the box. Warning: Depending on the platform used,
1854# enabling this option may lead to badly anti-aliased labels on the edges of
1855# a graph (i.e. they become hard to read).
1856
1857DOT_TRANSPARENT = NO
1858
1859# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1860# files in one run (i.e. multiple -o and -T options on the command line). This
1861# makes dot run faster, but since only newer versions of dot (>1.8.10)
1862# support this, this feature is disabled by default.
1863
1864DOT_MULTI_TARGETS = NO
1865
1866# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1867# generate a legend page explaining the meaning of the various boxes and
1868# arrows in the dot generated graphs.
1869
1870GENERATE_LEGEND = YES
1871
1872# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1873# remove the intermediate dot files that are used to generate
1874# the various graphs.
1875
1876DOT_CLEANUP = YES
Note: See TracBrowser for help on using the repository browser.