source: trunk/adm/Doxyfile_ircaam @ 89

Last change on this file since 89 was 85, checked in by pinsard, 14 years ago

better representation of variable parts in filenames

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