source: trunk/FACT++/Doxyfile @ 10656

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