source: tspsg/doxygen.conf @ 3487003f06

0.1.4.170-beta2-bb10appveyorimgbotreadme
Last change on this file since 3487003f06 was 3487003f06, checked in by Oleksii Serdiuk, 13 years ago

Made some documentation-related updates. Also, updated Qt tagfile from 4.6 to 4.7.

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