source: tspsg-svn/trunk/doxygen.conf @ 145

Last change on this file since 145 was 144, checked in by laleppa, 14 years ago

+ Added question about enabling automatic updates (will be asked only once).

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