source: tspsg/Doxyfile @ 697a9dc08f

appveyorimgbotreadme
Last change on this file since 697a9dc08f was 703a0720ce, checked in by Oleksii Serdiuk, 12 years ago

Removed obsolete entries from Doxyfile.

By running 'doxygen -u'.

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