doc/doxygen.conf
author Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
Thu, 17 Apr 2008 15:40:25 -0700
changeset 2971 75780f899be3
parent 2969 9d05d2a95dfa
child 4063 803720fc9f31
permissions -rw-r--r--
output the initial value of the attributes
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
1812
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
     1
# Doxyfile 1.5.4
55
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
     2
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
     3
# This file describes the settings to be used by the documentation system
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
     4
# doxygen (www.doxygen.org) for a project
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
     5
#
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
     6
# All text after a hash (#) is considered a comment and will be ignored
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
     7
# The format is:
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
     8
#       TAG = value [value, ...]
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
     9
# For lists items can also be appended using:
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    10
#       TAG += value [value, ...]
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    11
# Values that contain spaces should be placed between quotes (" ")
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    12
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    13
#---------------------------------------------------------------------------
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    14
# Project related configuration options
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    15
#---------------------------------------------------------------------------
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    16
1812
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
    17
# This tag specifies the encoding used for all characters in the config file that 
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
    18
# follow. The default is UTF-8 which is also the encoding used for all text before 
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
    19
# the first occurrence of this tag. Doxygen uses libiconv (or the iconv built into 
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
    20
# libc) for the transcoding. See http://www.gnu.org/software/libiconv for the list of 
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
    21
# possible encodings.
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
    22
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
    23
DOXYFILE_ENCODING      = UTF-8
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
    24
55
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    25
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    26
# by quotes) that should identify the project.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    27
1812
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
    28
PROJECT_NAME           = "NS-3 "
55
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    29
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    30
# The PROJECT_NUMBER tag can be used to enter a project or revision number. 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    31
# This could be handy for archiving the generated documentation or 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    32
# if some version control system is used.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    33
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    34
PROJECT_NUMBER         = 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    35
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    36
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    37
# base path where the generated documentation will be put. 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    38
# If a relative path is entered, it will be relative to the location 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    39
# where doxygen was started. If left blank the current directory will be used.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    40
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    41
OUTPUT_DIRECTORY       = doc
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    42
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    43
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    44
# 4096 sub-directories (in 2 levels) under the output directory of each output 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    45
# format and will distribute the generated files over these directories. 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    46
# Enabling this option can be useful when feeding doxygen a huge amount of 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    47
# source files, where putting all generated files in the same directory would 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    48
# otherwise cause performance problems for the file system.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    49
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    50
CREATE_SUBDIRS         = NO
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    51
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    52
# The OUTPUT_LANGUAGE tag is used to specify the language in which all 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    53
# documentation generated by doxygen is written. Doxygen will use this 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    54
# information to generate all constant output in the proper language. 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    55
# The default language is English, other supported languages are: 
1812
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
    56
# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, 
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
    57
# Croatian, Czech, Danish, Dutch, Finnish, French, German, Greek, Hungarian, 
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
    58
# Italian, Japanese, Japanese-en (Japanese with English messages), Korean, 
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
    59
# Korean-en, Lithuanian, Norwegian, Polish, Portuguese, Romanian, Russian, 
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
    60
# Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
55
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    61
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    62
OUTPUT_LANGUAGE        = English
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    63
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    64
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    65
# include brief member descriptions after the members that are listed in 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    66
# the file and class documentation (similar to JavaDoc). 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    67
# Set to NO to disable this.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    68
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    69
BRIEF_MEMBER_DESC      = YES
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    70
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    71
# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    72
# the brief description of a member or function before the detailed description. 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    73
# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    74
# brief descriptions will be completely suppressed.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    75
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    76
REPEAT_BRIEF           = YES
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    77
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    78
# This tag implements a quasi-intelligent brief description abbreviator 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    79
# that is used to form the text in various listings. Each string 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    80
# in this list, if found as the leading text of the brief description, will be 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    81
# stripped from the text and the result after processing the whole list, is 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    82
# used as the annotated text. Otherwise, the brief description is used as-is. 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    83
# If left blank, the following values are used ("$name" is automatically 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    84
# replaced with the name of the entity): "The $name class" "The $name widget" 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    85
# "The $name file" "is" "provides" "specifies" "contains" 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    86
# "represents" "a" "an" "the"
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    87
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    88
ABBREVIATE_BRIEF       = 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    89
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    90
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    91
# Doxygen will generate a detailed section even if there is only a brief 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    92
# description.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    93
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    94
ALWAYS_DETAILED_SEC    = NO
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    95
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    96
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    97
# inherited members of a class in the documentation of that class as if those 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    98
# members were ordinary class members. Constructors, destructors and assignment 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    99
# operators of the base classes will not be shown.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   100
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   101
INLINE_INHERITED_MEMB  = NO
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   102
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   103
# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   104
# path before files name in the file list and in the header files. If set 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   105
# to NO the shortest path that makes the file name unique will be used.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   106
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   107
FULL_PATH_NAMES        = YES
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   108
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   109
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   110
# can be used to strip a user-defined part of the path. Stripping is 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   111
# only done if one of the specified strings matches the left-hand part of 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   112
# the path. The tag can be used to show relative paths in the file list. 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   113
# If left blank the directory from which doxygen is run is used as the 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   114
# path to strip.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   115
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   116
STRIP_FROM_PATH        = 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   117
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   118
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   119
# the path mentioned in the documentation of a class, which tells 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   120
# the reader which header file to include in order to use a class. 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   121
# If left blank only the name of the header file containing the class 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   122
# definition is used. Otherwise one should specify the include paths that 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   123
# are normally passed to the compiler using the -I flag.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   124
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   125
STRIP_FROM_INC_PATH    = 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   126
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   127
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   128
# (but less readable) file names. This can be useful is your file systems 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   129
# doesn't support long names like on DOS, Mac, or CD-ROM.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   130
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   131
SHORT_NAMES            = NO
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   132
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   133
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   134
# will interpret the first line (until the first dot) of a JavaDoc-style 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   135
# comment as the brief description. If set to NO, the JavaDoc 
1812
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   136
# comments will behave just like regular Qt-style comments 
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   137
# (thus requiring an explicit @brief command for a brief description.)
55
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   138
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   139
JAVADOC_AUTOBRIEF      = NO
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   140
1812
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   141
# If the QT_AUTOBRIEF tag is set to YES then Doxygen will 
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   142
# interpret the first line (until the first dot) of a Qt-style 
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   143
# comment as the brief description. If set to NO, the comments 
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   144
# will behave just like regular Qt-style comments (thus requiring 
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   145
# an explicit \brief command for a brief description.)
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   146
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   147
QT_AUTOBRIEF           = NO
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   148
55
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   149
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   150
# treat a multi-line C++ special comment block (i.e. a block of //! or /// 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   151
# comments) as a brief description. This used to be the default behaviour. 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   152
# The new default is to treat a multi-line C++ comment block as a detailed 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   153
# description. Set this tag to YES if you prefer the old behaviour instead.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   154
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   155
MULTILINE_CPP_IS_BRIEF = NO
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   156
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   157
# If the DETAILS_AT_TOP tag is set to YES then Doxygen 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   158
# will output the detailed description near the top, like JavaDoc.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   159
# If set to NO, the detailed description appears after the member 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   160
# documentation.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   161
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   162
DETAILS_AT_TOP         = NO
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   163
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   164
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   165
# member inherits the documentation from any documented member that it 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   166
# re-implements.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   167
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   168
INHERIT_DOCS           = YES
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   169
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   170
# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   171
# a new page for each member. If set to NO, the documentation of a member will 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   172
# be part of the file/class/namespace that contains it.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   173
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   174
SEPARATE_MEMBER_PAGES  = NO
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   175
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   176
# The TAB_SIZE tag can be used to set the number of spaces in a tab. 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   177
# Doxygen uses this value to replace tabs by spaces in code fragments.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   178
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   179
TAB_SIZE               = 4
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   180
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   181
# This tag can be used to specify a number of aliases that acts 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   182
# as commands in the documentation. An alias has the form "name=value". 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   183
# For example adding "sideeffect=\par Side Effects:\n" will allow you to 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   184
# put the command \sideeffect (or @sideeffect) in the documentation, which 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   185
# will result in a user-defined paragraph with heading "Side Effects:". 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   186
# You can put \n's in the value part of an alias to insert newlines.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   187
2596
01685e2f0add kill valueref dox macro.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2217
diff changeset
   188
ALIASES                = 
55
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   189
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   190
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   191
# sources only. Doxygen will then generate output that is more tailored for C. 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   192
# For instance, some of the names that are used will be different. The list 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   193
# of all members will be omitted, etc.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   194
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   195
OPTIMIZE_OUTPUT_FOR_C  = NO
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   196
1812
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   197
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java 
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   198
# sources only. Doxygen will then generate output that is more tailored for Java. 
55
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   199
# For instance, namespaces will be presented as packages, qualified scopes 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   200
# will look different, etc.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   201
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   202
OPTIMIZE_OUTPUT_JAVA   = NO
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   203
1812
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   204
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to 
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   205
# include (a tag file for) the STL sources as input, then you should 
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   206
# set this tag to YES in order to let doxygen match functions declarations and 
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   207
# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. 
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   208
# func(std::string) {}). This also make the inheritance and collaboration 
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   209
# diagrams that involve STL classes more complete and accurate.
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   210
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   211
BUILTIN_STL_SUPPORT    = NO
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   212
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   213
# If you use Microsoft's C++/CLI language, you should set this option to YES to
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   214
# enable parsing support.
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   215
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   216
CPP_CLI_SUPPORT        = NO
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   217
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   218
# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. 
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   219
# Doxygen will parse them like normal C++ but will assume all classes use public 
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   220
# instead of private inheritance when no explicit protection keyword is present.
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   221
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   222
SIP_SUPPORT            = NO
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   223
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   224
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   225
# tag is set to YES, then doxygen will reuse the documentation of the first 
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   226
# member in the group (if any) for the other members of the group. By default 
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   227
# all members of a group must be documented explicitly.
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   228
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   229
DISTRIBUTE_GROUP_DOC   = NO
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   230
55
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   231
# Set the SUBGROUPING tag to YES (the default) to allow class member groups of 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   232
# the same type (for instance a group of public functions) to be put as a 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   233
# subgroup of that type (e.g. under the Public Functions section). Set it to 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   234
# NO to prevent subgrouping. Alternatively, this can be done per class using 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   235
# the \nosubgrouping command.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   236
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   237
SUBGROUPING            = YES
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   238
1812
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   239
# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct (or union) is 
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   240
# documented as struct with the name of the typedef. So 
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   241
# typedef struct TypeS {} TypeT, will appear in the documentation as a struct 
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   242
# with name TypeT. When disabled the typedef will appear as a member of a file, 
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   243
# namespace, or class. And the struct will be named TypeS. This can typically 
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   244
# be useful for C code where the coding convention is that all structs are 
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   245
# typedef'ed and only the typedef is referenced never the struct's name.
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   246
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   247
TYPEDEF_HIDES_STRUCT   = NO
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   248
55
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   249
#---------------------------------------------------------------------------
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   250
# Build related configuration options
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   251
#---------------------------------------------------------------------------
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   252
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   253
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   254
# documentation are documented, even if no documentation was available. 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   255
# Private class members and static file members will be hidden unless 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   256
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   257
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   258
EXTRACT_ALL            = NO
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   259
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   260
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   261
# will be included in the documentation.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   262
113
3c09b55983d9 tweak doxygen output
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 64
diff changeset
   263
EXTRACT_PRIVATE        = YES
55
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   264
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   265
# If the EXTRACT_STATIC tag is set to YES all static members of a file 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   266
# will be included in the documentation.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   267
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   268
EXTRACT_STATIC         = NO
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   269
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   270
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   271
# defined locally in source files will be included in the documentation. 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   272
# If set to NO only classes defined in header files are included.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   273
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   274
EXTRACT_LOCAL_CLASSES  = NO
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   275
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   276
# This flag is only useful for Objective-C code. When set to YES local 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   277
# methods, which are defined in the implementation section but not in 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   278
# the interface are included in the documentation. 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   279
# If set to NO (the default) only methods in the interface are included.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   280
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   281
EXTRACT_LOCAL_METHODS  = NO
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   282
1812
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   283
# If this flag is set to YES, the members of anonymous namespaces will be extracted 
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   284
# and appear in the documentation as a namespace called 'anonymous_namespace{file}', 
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   285
# where file will be replaced with the base name of the file that contains the anonymous 
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   286
# namespace. By default anonymous namespace are hidden.
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   287
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   288
EXTRACT_ANON_NSPACES   = NO
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   289
55
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   290
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   291
# undocumented members of documented classes, files or namespaces. 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   292
# If set to NO (the default) these members will be included in the 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   293
# various overviews, but no documentation section is generated. 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   294
# This option has no effect if EXTRACT_ALL is enabled.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   295
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   296
HIDE_UNDOC_MEMBERS     = YES
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   297
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   298
# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   299
# undocumented classes that are normally visible in the class hierarchy. 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   300
# If set to NO (the default) these classes will be included in the various 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   301
# overviews. This option has no effect if EXTRACT_ALL is enabled.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   302
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   303
HIDE_UNDOC_CLASSES     = YES
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   304
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   305
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   306
# friend (class|struct|union) declarations. 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   307
# If set to NO (the default) these declarations will be included in the 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   308
# documentation.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   309
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   310
HIDE_FRIEND_COMPOUNDS  = NO
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   311
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   312
# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   313
# documentation blocks found inside the body of a function. 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   314
# If set to NO (the default) these blocks will be appended to the 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   315
# function's detailed documentation block.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   316
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   317
HIDE_IN_BODY_DOCS      = NO
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   318
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   319
# The INTERNAL_DOCS tag determines if documentation 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   320
# that is typed after a \internal command is included. If the tag is set 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   321
# to NO (the default) then the documentation will be excluded. 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   322
# Set it to YES to include the internal documentation.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   323
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   324
INTERNAL_DOCS          = NO
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   325
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   326
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   327
# file names in lower-case letters. If set to YES upper-case letters are also 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   328
# allowed. This is useful if you have classes or files whose names only differ 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   329
# in case and if your file system supports case sensitive file names. Windows 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   330
# and Mac users are advised to set this option to NO.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   331
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   332
CASE_SENSE_NAMES       = NO
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   333
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   334
# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   335
# will show members with their full class and namespace scopes in the 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   336
# documentation. If set to YES the scope will be hidden.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   337
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   338
HIDE_SCOPE_NAMES       = NO
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   339
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   340
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   341
# will put a list of the files that are included by a file in the documentation 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   342
# of that file.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   343
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   344
SHOW_INCLUDE_FILES     = YES
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   345
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   346
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   347
# is inserted in the documentation for inline members.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   348
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   349
INLINE_INFO            = YES
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   350
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   351
# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   352
# will sort the (detailed) documentation of file and class members 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   353
# alphabetically by member name. If set to NO the members will appear in 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   354
# declaration order.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   355
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   356
SORT_MEMBER_DOCS       = YES
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   357
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   358
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   359
# brief documentation of file, namespace and class members alphabetically 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   360
# by member name. If set to NO (the default) the members will appear in 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   361
# declaration order.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   362
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   363
SORT_BRIEF_DOCS        = NO
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   364
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   365
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   366
# sorted by fully-qualified names, including namespaces. If set to 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   367
# NO (the default), the class list will be sorted only by class name, 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   368
# not including the namespace part. 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   369
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   370
# Note: This option applies only to the class list, not to the 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   371
# alphabetical list.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   372
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   373
SORT_BY_SCOPE_NAME     = NO
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   374
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   375
# The GENERATE_TODOLIST tag can be used to enable (YES) or 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   376
# disable (NO) the todo list. This list is created by putting \todo 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   377
# commands in the documentation.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   378
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   379
GENERATE_TODOLIST      = YES
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   380
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   381
# The GENERATE_TESTLIST tag can be used to enable (YES) or 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   382
# disable (NO) the test list. This list is created by putting \test 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   383
# commands in the documentation.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   384
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   385
GENERATE_TESTLIST      = YES
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   386
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   387
# The GENERATE_BUGLIST tag can be used to enable (YES) or 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   388
# disable (NO) the bug list. This list is created by putting \bug 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   389
# commands in the documentation.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   390
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   391
GENERATE_BUGLIST       = YES
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   392
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   393
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   394
# disable (NO) the deprecated list. This list is created by putting 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   395
# \deprecated commands in the documentation.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   396
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   397
GENERATE_DEPRECATEDLIST= YES
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   398
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   399
# The ENABLED_SECTIONS tag can be used to enable conditional 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   400
# documentation sections, marked by \if sectionname ... \endif.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   401
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   402
ENABLED_SECTIONS       = 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   403
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   404
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   405
# the initial value of a variable or define consists of for it to appear in 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   406
# the documentation. If the initializer consists of more lines than specified 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   407
# here it will be hidden. Use a value of 0 to hide initializers completely. 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   408
# The appearance of the initializer of individual variables and defines in the 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   409
# documentation can be controlled using \showinitializer or \hideinitializer 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   410
# command in the documentation regardless of this setting.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   411
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   412
MAX_INITIALIZER_LINES  = 30
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   413
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   414
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   415
# at the bottom of the documentation of classes and structs. If set to YES the 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   416
# list will mention the files that were used to generate the documentation.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   417
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   418
SHOW_USED_FILES        = YES
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   419
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   420
# If the sources in your project are distributed over multiple directories 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   421
# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy 
1812
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   422
# in the documentation. The default is NO.
55
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   423
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   424
SHOW_DIRECTORIES       = NO
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   425
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   426
# The FILE_VERSION_FILTER tag can be used to specify a program or script that 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   427
# doxygen should invoke to get the current version for each file (typically from the 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   428
# version control system). Doxygen will invoke the program by executing (via 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   429
# popen()) the command <command> <input-file>, where <command> is the value of 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   430
# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file 
1812
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   431
# provided by doxygen. Whatever the program writes to standard output 
55
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   432
# is used as the file version. See the manual for examples.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   433
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   434
FILE_VERSION_FILTER    = 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   435
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   436
#---------------------------------------------------------------------------
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   437
# configuration options related to warning and progress messages
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   438
#---------------------------------------------------------------------------
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   439
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   440
# The QUIET tag can be used to turn on/off the messages that are generated 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   441
# by doxygen. Possible values are YES and NO. If left blank NO is used.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   442
1540
fd4e69513199 Now run doxygen again before the build, but the doc/trace-source-list.h is generated during waf check; make doxygen less verbose, and give a warning when doc/trace-source-list.h is missing.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 1411
diff changeset
   443
QUIET                  = YES
55
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   444
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   445
# The WARNINGS tag can be used to turn on/off the warning messages that are 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   446
# generated by doxygen. Possible values are YES and NO. If left blank 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   447
# NO is used.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   448
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   449
WARNINGS               = YES
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   450
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   451
# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   452
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   453
# automatically be disabled.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   454
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   455
WARN_IF_UNDOCUMENTED   = YES
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   456
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   457
# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   458
# potential errors in the documentation, such as not documenting some 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   459
# parameters in a documented function, or documenting parameters that 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   460
# don't exist or using markup commands wrongly.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   461
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   462
WARN_IF_DOC_ERROR      = YES
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   463
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   464
# This WARN_NO_PARAMDOC option can be abled to get warnings for 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   465
# functions that are documented, but have no documentation for their parameters 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   466
# or return value. If set to NO (the default) doxygen will only warn about 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   467
# wrong or incomplete parameter documentation, but not about the absence of 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   468
# documentation.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   469
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   470
WARN_NO_PARAMDOC       = NO
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   471
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   472
# The WARN_FORMAT tag determines the format of the warning messages that 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   473
# doxygen can produce. The string should contain the $file, $line, and $text 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   474
# tags, which will be replaced by the file and line number from which the 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   475
# warning originated and the warning text. Optionally the format may contain 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   476
# $version, which will be replaced by the version of the file (if it could 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   477
# be obtained via FILE_VERSION_FILTER)
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   478
1812
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   479
WARN_FORMAT            = "$file:$line: $text "
55
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   480
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   481
# The WARN_LOGFILE tag can be used to specify a file to which warning 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   482
# and error messages should be written. If left blank the output is written 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   483
# to stderr.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   484
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   485
WARN_LOGFILE           = 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   486
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   487
#---------------------------------------------------------------------------
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   488
# configuration options related to the input files
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   489
#---------------------------------------------------------------------------
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   490
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   491
# The INPUT tag can be used to specify the files and/or directories that contain 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   492
# documented source files. You may enter file names like "myfile.cpp" or 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   493
# directories like "/usr/src/myproject". Separate the files or directories 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   494
# with spaces.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   495
2217
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents: 2201
diff changeset
   496
INPUT                  = doc/modules \
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents: 2201
diff changeset
   497
                         doc/main.h \
1855
ee15fef0cb62 print-trace-sources.cc -> print-introspected-doxygen.cc
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1852
diff changeset
   498
                         doc/introspected-doxygen.h \
2217
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents: 2201
diff changeset
   499
                         doc/howtos/ \ 
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents: 2201
diff changeset
   500
                         src
1812
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   501
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   502
# This tag can be used to specify the character encoding of the source files that 
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   503
# doxygen parses. Internally doxygen uses the UTF-8 encoding, which is also the default 
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   504
# input encoding. Doxygen uses libiconv (or the iconv built into libc) for the transcoding. 
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   505
# See http://www.gnu.org/software/libiconv for the list of possible encodings.
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   506
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   507
INPUT_ENCODING         = UTF-8
55
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   508
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   509
# If the value of the INPUT tag contains directories, you can use the 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   510
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   511
# and *.h) to filter out the source-files in the directories. If left 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   512
# blank the following patterns are tested: 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   513
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx 
1812
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   514
# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
55
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   515
1812
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   516
FILE_PATTERNS          = *.h \
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   517
                         *.tcc
55
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   518
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   519
# The RECURSIVE tag can be used to turn specify whether or not subdirectories 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   520
# should be searched for input files as well. Possible values are YES and NO. 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   521
# If left blank NO is used.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   522
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   523
RECURSIVE              = YES
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   524
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   525
# The EXCLUDE tag can be used to specify files and/or directories that should 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   526
# excluded from the INPUT source files. This way you can easily exclude a 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   527
# subdirectory from a directory tree whose root is specified with the INPUT tag.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   528
1812
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   529
EXCLUDE                = src/routing/olsr/olsr-state.h \
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   530
                         src/routing/olsr/repositories.h \
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   531
                         src/routing/olsr/routing-table.h \
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   532
                         src/simulator/high-precision.h \
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   533
                         src/simulator/high-precision-128.h \
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   534
                         src/simulator/high-precision-double.h
55
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   535
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   536
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   537
# directories that are symbolic links (a Unix filesystem feature) are excluded 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   538
# from the input.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   539
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   540
EXCLUDE_SYMLINKS       = NO
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   541
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   542
# If the value of the INPUT tag contains directories, you can use the 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   543
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   544
# certain files from those directories. Note that the wildcards are matched 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   545
# against the file with absolute path, so to exclude all test directories 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   546
# for example use the pattern */test/*
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   547
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   548
EXCLUDE_PATTERNS       = 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   549
1812
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   550
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   551
# (namespaces, classes, functions, etc.) that should be excluded from the output. 
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   552
# The symbol name can be a fully qualified name, a word, or if the wildcard * is used, 
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   553
# a substring. Examples: ANamespace, AClass, AClass::ANamespace, ANamespace::*Test
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   554
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   555
EXCLUDE_SYMBOLS        = 
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   556
55
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   557
# The EXAMPLE_PATH tag can be used to specify one or more files or 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   558
# directories that contain example code fragments that are included (see 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   559
# the \include command).
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   560
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   561
EXAMPLE_PATH           = samples
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   562
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   563
# If the value of the EXAMPLE_PATH tag contains directories, you can use the 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   564
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   565
# and *.h) to filter out the source-files in the directories. If left 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   566
# blank all files are included.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   567
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   568
EXAMPLE_PATTERNS       = 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   569
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   570
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   571
# searched for input files to be used with the \include or \dontinclude 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   572
# commands irrespective of the value of the RECURSIVE tag. 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   573
# Possible values are YES and NO. If left blank NO is used.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   574
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   575
EXAMPLE_RECURSIVE      = NO
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   576
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   577
# The IMAGE_PATH tag can be used to specify one or more files or 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   578
# directories that contain image that are included in the documentation (see 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   579
# the \image command).
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   580
1359
969f9671ee09 add image path
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 1252
diff changeset
   581
IMAGE_PATH             = doc
55
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   582
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   583
# The INPUT_FILTER tag can be used to specify a program that doxygen should 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   584
# invoke to filter for each input file. Doxygen will invoke the filter program 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   585
# by executing (via popen()) the command <filter> <input-file>, where <filter> 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   586
# is the value of the INPUT_FILTER tag, and <input-file> is the name of an 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   587
# input file. Doxygen will then use the output that the filter program writes 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   588
# to standard output.  If FILTER_PATTERNS is specified, this tag will be 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   589
# ignored.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   590
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   591
INPUT_FILTER           = 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   592
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   593
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   594
# basis.  Doxygen will compare the file name with each pattern and apply the 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   595
# filter if there is a match.  The filters are a list of the form: 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   596
# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   597
# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   598
# is applied to all files.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   599
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   600
FILTER_PATTERNS        = 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   601
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   602
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   603
# INPUT_FILTER) will be used to filter the input files when producing source 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   604
# files to browse (i.e. when SOURCE_BROWSER is set to YES).
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   605
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   606
FILTER_SOURCE_FILES    = NO
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   607
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   608
#---------------------------------------------------------------------------
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   609
# configuration options related to source browsing
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   610
#---------------------------------------------------------------------------
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   611
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   612
# If the SOURCE_BROWSER tag is set to YES then a list of source files will 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   613
# be generated. Documented entities will be cross-referenced with these sources. 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   614
# Note: To get rid of all source code in the generated output, make sure also 
1812
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   615
# VERBATIM_HEADERS is set to NO. If you have enabled CALL_GRAPH or CALLER_GRAPH 
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   616
# then you must also enable this option. If you don't then doxygen will produce 
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   617
# a warning and turn it on anyway
55
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   618
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   619
SOURCE_BROWSER         = NO
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   620
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   621
# Setting the INLINE_SOURCES tag to YES will include the body 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   622
# of functions and classes directly in the documentation.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   623
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   624
INLINE_SOURCES         = NO
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   625
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   626
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   627
# doxygen to hide any special comment blocks from generated source code 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   628
# fragments. Normal C and C++ comments will always remain visible.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   629
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   630
STRIP_CODE_COMMENTS    = YES
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   631
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   632
# If the REFERENCED_BY_RELATION tag is set to YES (the default) 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   633
# then for each documented function all documented 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   634
# functions referencing it will be listed.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   635
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   636
REFERENCED_BY_RELATION = YES
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   637
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   638
# If the REFERENCES_RELATION tag is set to YES (the default) 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   639
# then for each documented function all documented entities 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   640
# called/used by that function will be listed.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   641
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   642
REFERENCES_RELATION    = YES
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   643
1812
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   644
# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   645
# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   646
# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   647
# link to the source code.  Otherwise they will link to the documentstion.
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   648
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   649
REFERENCES_LINK_SOURCE = YES
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   650
55
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   651
# If the USE_HTAGS tag is set to YES then the references to source code 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   652
# will point to the HTML generated by the htags(1) tool instead of doxygen 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   653
# built-in source browser. The htags tool is part of GNU's global source 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   654
# tagging system (see http://www.gnu.org/software/global/global.html). You 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   655
# will need version 4.8.6 or higher.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   656
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   657
USE_HTAGS              = NO
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   658
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   659
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   660
# will generate a verbatim copy of the header file for each class for 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   661
# which an include is specified. Set to NO to disable this.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   662
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   663
VERBATIM_HEADERS       = NO
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   664
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   665
#---------------------------------------------------------------------------
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   666
# configuration options related to the alphabetical class index
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   667
#---------------------------------------------------------------------------
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   668
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   669
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   670
# of all compounds will be generated. Enable this if the project 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   671
# contains a lot of classes, structs, unions or interfaces.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   672
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   673
ALPHABETICAL_INDEX     = NO
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   674
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   675
# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   676
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   677
# in which this list will be split (can be a number in the range [1..20])
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   678
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   679
COLS_IN_ALPHA_INDEX    = 5
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   680
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   681
# In case all classes in a project start with a common prefix, all 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   682
# classes will be put under the same header in the alphabetical index. 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   683
# The IGNORE_PREFIX tag can be used to specify one or more prefixes that 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   684
# should be ignored while generating the index headers.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   685
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   686
IGNORE_PREFIX          = 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   687
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   688
#---------------------------------------------------------------------------
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   689
# configuration options related to the HTML output
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   690
#---------------------------------------------------------------------------
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   691
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   692
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   693
# generate HTML output.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   694
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   695
GENERATE_HTML          = YES
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   696
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   697
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   698
# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   699
# put in front of it. If left blank `html' will be used as the default path.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   700
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   701
HTML_OUTPUT            = html
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   702
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   703
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   704
# each generated HTML page (for example: .htm,.php,.asp). If it is left blank 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   705
# doxygen will generate files with .html extension.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   706
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   707
HTML_FILE_EXTENSION    = .html
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   708
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   709
# The HTML_HEADER tag can be used to specify a personal HTML header for 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   710
# each generated HTML page. If it is left blank doxygen will generate a 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   711
# standard header.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   712
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   713
HTML_HEADER            = 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   714
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   715
# The HTML_FOOTER tag can be used to specify a personal HTML footer for 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   716
# each generated HTML page. If it is left blank doxygen will generate a 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   717
# standard footer.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   718
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   719
HTML_FOOTER            = 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   720
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   721
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   722
# style sheet that is used by each HTML page. It can be used to 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   723
# fine-tune the look of the HTML output. If the tag is left blank doxygen 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   724
# will generate a default style sheet. Note that doxygen will try to copy 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   725
# the style sheet file to the HTML output directory, so don't put your own 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   726
# stylesheet in the HTML output directory as well, or it will be erased!
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   727
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   728
HTML_STYLESHEET        = 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   729
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   730
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   731
# files or namespaces will be aligned in HTML using tables. If set to 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   732
# NO a bullet list will be used.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   733
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   734
HTML_ALIGN_MEMBERS     = YES
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   735
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   736
# If the GENERATE_HTMLHELP tag is set to YES, additional index files 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   737
# will be generated that can be used as input for tools like the 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   738
# Microsoft HTML help workshop to generate a compressed HTML help file (.chm) 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   739
# of the generated HTML documentation.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   740
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   741
GENERATE_HTMLHELP      = NO
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   742
1812
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   743
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   744
# documentation will contain sections that can be hidden and shown after the 
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   745
# page has loaded. For this to work a browser that supports 
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   746
# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox 
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   747
# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   748
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   749
HTML_DYNAMIC_SECTIONS  = NO
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
   750
55
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   751
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   752
# be used to specify the file name of the resulting .chm file. You 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   753
# can add a path in front of the file if the result should not be 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   754
# written to the html output directory.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   755
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   756
CHM_FILE               = 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   757
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   758
# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   759
# be used to specify the location (absolute path including file name) of 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   760
# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   761
# the HTML help compiler on the generated index.hhp.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   762
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   763
HHC_LOCATION           = 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   764
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   765
# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   766
# controls if a separate .chi index file is generated (YES) or that 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   767
# it should be included in the master .chm file (NO).
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   768
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   769
GENERATE_CHI           = NO
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   770
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   771
# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   772
# controls whether a binary table of contents is generated (YES) or a 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   773
# normal table of contents (NO) in the .chm file.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   774
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   775
BINARY_TOC             = NO
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   776
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   777
# The TOC_EXPAND flag can be set to YES to add extra items for group members 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   778
# to the contents of the HTML help documentation and to the tree view.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   779
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   780
TOC_EXPAND             = NO
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   781
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   782
# The DISABLE_INDEX tag can be used to turn on/off the condensed index at 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   783
# top of each HTML page. The value NO (the default) enables the index and 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   784
# the value YES disables it.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   785
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   786
DISABLE_INDEX          = NO
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   787
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   788
# This tag can be used to set the number of enum values (range [1..20]) 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   789
# that doxygen will group on one line in the generated HTML documentation.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   790
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   791
ENUM_VALUES_PER_LINE   = 4
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   792
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   793
# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   794
# generated containing a tree-like index structure (just like the one that 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   795
# is generated for HTML Help). For this to work a browser that supports 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   796
# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   797
# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   798
# probably better off using the HTML help feature.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   799
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   800
GENERATE_TREEVIEW      = YES
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   801
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   802
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   803
# used to set the initial width (in pixels) of the frame in which the tree 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   804
# is shown.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   805
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   806
TREEVIEW_WIDTH         = 250
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   807
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   808
#---------------------------------------------------------------------------
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   809
# configuration options related to the LaTeX output
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   810
#---------------------------------------------------------------------------
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   811
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   812
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   813
# generate Latex output.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   814
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   815
GENERATE_LATEX         = YES
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   816
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   817
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   818
# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   819
# put in front of it. If left blank `latex' will be used as the default path.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   820
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   821
LATEX_OUTPUT           = latex
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   822
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   823
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   824
# invoked. If left blank `latex' will be used as the default command name.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   825
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   826
LATEX_CMD_NAME         = latex
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   827
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   828
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   829
# generate index for LaTeX. If left blank `makeindex' will be used as the 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   830
# default command name.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   831
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   832
MAKEINDEX_CMD_NAME     = makeindex
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   833
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   834
# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   835
# LaTeX documents. This may be useful for small projects and may help to 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   836
# save some trees in general.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   837
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   838
COMPACT_LATEX          = YES
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   839
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   840
# The PAPER_TYPE tag can be used to set the paper type that is used 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   841
# by the printer. Possible values are: a4, a4wide, letter, legal and 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   842
# executive. If left blank a4wide will be used.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   843
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   844
PAPER_TYPE             = a4wide
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   845
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   846
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   847
# packages that should be included in the LaTeX output.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   848
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   849
EXTRA_PACKAGES         = 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   850
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   851
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   852
# the generated latex document. The header should contain everything until 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   853
# the first chapter. If it is left blank doxygen will generate a 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   854
# standard header. Notice: only use this tag if you know what you are doing!
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   855
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   856
LATEX_HEADER           = 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   857
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   858
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   859
# is prepared for conversion to pdf (using ps2pdf). The pdf file will 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   860
# contain links (just like the HTML output) instead of page references 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   861
# This makes the output suitable for online browsing using a pdf viewer.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   862
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   863
PDF_HYPERLINKS         = YES
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   864
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   865
# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   866
# plain latex in the generated Makefile. Set this option to YES to get a 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   867
# higher quality PDF documentation.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   868
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   869
USE_PDFLATEX           = YES
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   870
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   871
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   872
# command to the generated LaTeX files. This will instruct LaTeX to keep 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   873
# running if errors occur, instead of asking the user for help. 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   874
# This option is also used when generating formulas in HTML.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   875
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   876
LATEX_BATCHMODE        = NO
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   877
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   878
# If LATEX_HIDE_INDICES is set to YES then doxygen will not 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   879
# include the index chapters (such as File Index, Compound Index, etc.) 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   880
# in the output.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   881
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   882
LATEX_HIDE_INDICES     = YES
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   883
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   884
#---------------------------------------------------------------------------
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   885
# configuration options related to the RTF output
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   886
#---------------------------------------------------------------------------
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   887
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   888
# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   889
# The RTF output is optimized for Word 97 and may not look very pretty with 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   890
# other RTF readers or editors.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   891
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   892
GENERATE_RTF           = NO
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   893
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   894
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   895
# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   896
# put in front of it. If left blank `rtf' will be used as the default path.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   897
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   898
RTF_OUTPUT             = rtf
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   899
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   900
# If the COMPACT_RTF tag is set to YES Doxygen generates more compact 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   901
# RTF documents. This may be useful for small projects and may help to 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   902
# save some trees in general.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   903
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   904
COMPACT_RTF            = NO
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   905
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   906
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   907
# will contain hyperlink fields. The RTF file will 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   908
# contain links (just like the HTML output) instead of page references. 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   909
# This makes the output suitable for online browsing using WORD or other 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   910
# programs which support those fields. 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   911
# Note: wordpad (write) and others do not support links.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   912
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   913
RTF_HYPERLINKS         = NO
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   914
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   915
# Load stylesheet definitions from file. Syntax is similar to doxygen's 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   916
# config file, i.e. a series of assignments. You only have to provide 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   917
# replacements, missing definitions are set to their default value.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   918
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   919
RTF_STYLESHEET_FILE    = 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   920
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   921
# Set optional variables used in the generation of an rtf document. 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   922
# Syntax is similar to doxygen's config file.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   923
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   924
RTF_EXTENSIONS_FILE    = 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   925
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   926
#---------------------------------------------------------------------------
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   927
# configuration options related to the man page output
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   928
#---------------------------------------------------------------------------
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   929
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   930
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   931
# generate man pages
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   932
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   933
GENERATE_MAN           = NO
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   934
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   935
# The MAN_OUTPUT tag is used to specify where the man pages will be put. 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   936
# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   937
# put in front of it. If left blank `man' will be used as the default path.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   938
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   939
MAN_OUTPUT             = man
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   940
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   941
# The MAN_EXTENSION tag determines the extension that is added to 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   942
# the generated man pages (default is the subroutine's section .3)
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   943
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   944
MAN_EXTENSION          = .3
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   945
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   946
# If the MAN_LINKS tag is set to YES and Doxygen generates man output, 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   947
# then it will generate one additional man file for each entity 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   948
# documented in the real man page(s). These additional files 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   949
# only source the real man page, but without them the man command 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   950
# would be unable to find the correct page. The default is NO.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   951
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   952
MAN_LINKS              = NO
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   953
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   954
#---------------------------------------------------------------------------
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   955
# configuration options related to the XML output
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   956
#---------------------------------------------------------------------------
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   957
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   958
# If the GENERATE_XML tag is set to YES Doxygen will 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   959
# generate an XML file that captures the structure of 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   960
# the code including all documentation.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   961
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   962
GENERATE_XML           = NO
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   963
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   964
# The XML_OUTPUT tag is used to specify where the XML pages will be put. 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   965
# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   966
# put in front of it. If left blank `xml' will be used as the default path.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   967
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   968
XML_OUTPUT             = xml
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   969
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   970
# The XML_SCHEMA tag can be used to specify an XML schema, 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   971
# which can be used by a validating XML parser to check the 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   972
# syntax of the XML files.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   973
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   974
XML_SCHEMA             = 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   975
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   976
# The XML_DTD tag can be used to specify an XML DTD, 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   977
# which can be used by a validating XML parser to check the 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   978
# syntax of the XML files.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   979
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   980
XML_DTD                = 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   981
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   982
# If the XML_PROGRAMLISTING tag is set to YES Doxygen will 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   983
# dump the program listings (including syntax highlighting 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   984
# and cross-referencing information) to the XML output. Note that 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   985
# enabling this will significantly increase the size of the XML output.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   986
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   987
XML_PROGRAMLISTING     = YES
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   988
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   989
#---------------------------------------------------------------------------
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   990
# configuration options for the AutoGen Definitions output
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   991
#---------------------------------------------------------------------------
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   992
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   993
# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   994
# generate an AutoGen Definitions (see autogen.sf.net) file 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   995
# that captures the structure of the code including all 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   996
# documentation. Note that this feature is still experimental 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   997
# and incomplete at the moment.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   998
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   999
GENERATE_AUTOGEN_DEF   = NO
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1000
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1001
#---------------------------------------------------------------------------
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1002
# configuration options related to the Perl module output
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1003
#---------------------------------------------------------------------------
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1004
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1005
# If the GENERATE_PERLMOD tag is set to YES Doxygen will 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1006
# generate a Perl module file that captures the structure of 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1007
# the code including all documentation. Note that this 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1008
# feature is still experimental and incomplete at the 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1009
# moment.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1010
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1011
GENERATE_PERLMOD       = NO
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1012
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1013
# If the PERLMOD_LATEX tag is set to YES Doxygen will generate 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1014
# the necessary Makefile rules, Perl scripts and LaTeX code to be able 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1015
# to generate PDF and DVI output from the Perl module output.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1016
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1017
PERLMOD_LATEX          = NO
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1018
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1019
# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1020
# nicely formatted so it can be parsed by a human reader.  This is useful 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1021
# if you want to understand what is going on.  On the other hand, if this 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1022
# tag is set to NO the size of the Perl module output will be much smaller 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1023
# and Perl will parse it just the same.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1024
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1025
PERLMOD_PRETTY         = YES
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1026
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1027
# The names of the make variables in the generated doxyrules.make file 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1028
# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1029
# This is useful so different doxyrules.make files included by the same 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1030
# Makefile don't overwrite each other's variables.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1031
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1032
PERLMOD_MAKEVAR_PREFIX = 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1033
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1034
#---------------------------------------------------------------------------
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1035
# Configuration options related to the preprocessor   
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1036
#---------------------------------------------------------------------------
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1037
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1038
# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1039
# evaluate all C-preprocessor directives found in the sources and include 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1040
# files.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1041
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1042
ENABLE_PREPROCESSING   = YES
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1043
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1044
# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1045
# names in the source code. If set to NO (the default) only conditional 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1046
# compilation will be performed. Macro expansion can be done in a controlled 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1047
# way by setting EXPAND_ONLY_PREDEF to YES.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1048
2969
9d05d2a95dfa improve the auto-generated doxygen output.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2960
diff changeset
  1049
MACRO_EXPANSION        = YES
55
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1050
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1051
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1052
# then the macro expansion is limited to the macros specified with the 
1812
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
  1053
# PREDEFINED and EXPAND_AS_DEFINED tags.
55
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1054
2969
9d05d2a95dfa improve the auto-generated doxygen output.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2960
diff changeset
  1055
EXPAND_ONLY_PREDEF     = YES
55
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1056
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1057
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1058
# in the INCLUDE_PATH (see below) will be search if a #include is found.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1059
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1060
SEARCH_INCLUDES        = YES
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1061
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1062
# The INCLUDE_PATH tag can be used to specify one or more directories that 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1063
# contain include files that are not input files but should be processed by 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1064
# the preprocessor.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1065
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1066
INCLUDE_PATH           = 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1067
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1068
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1069
# patterns (like *.h and *.hpp) to filter out the header-files in the 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1070
# directories. If left blank, the patterns specified with FILE_PATTERNS will 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1071
# be used.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1072
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1073
INCLUDE_FILE_PATTERNS  = 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1074
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1075
# The PREDEFINED tag can be used to specify one or more macro names that 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1076
# are defined before the preprocessor is started (similar to the -D option of 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1077
# gcc). The argument of the tag is a list of macros of the form: name 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1078
# or name=definition (no spaces). If the definition and the = are 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1079
# omitted =1 is assumed. To prevent a macro definition from being 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1080
# undefined via #undef or recursively expanded use the := operator 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1081
# instead of the = operator.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1082
1812
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
  1083
PREDEFINED             = RUN_SELF_TESTS \
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
  1084
                         NS3_ASSERT_ENABLE \
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
  1085
                         NS3_LOG_ENABLE
55
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1086
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1087
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1088
# this tag can be used to specify a list of macro names that should be expanded. 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1089
# The macro definition that is found in the sources will be used. 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1090
# Use the PREDEFINED tag if you want to use a different macro definition.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1091
2969
9d05d2a95dfa improve the auto-generated doxygen output.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2960
diff changeset
  1092
EXPAND_AS_DEFINED      = ATTRIBUTE_VALUE_DEFINE \
9d05d2a95dfa improve the auto-generated doxygen output.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2960
diff changeset
  1093
		       ATTRIBUTE_VALUE_DEFINE_WITH_NAME \
9d05d2a95dfa improve the auto-generated doxygen output.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2960
diff changeset
  1094
		       ATTRIBUTE_HELPER_HEADER_2
55
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1095
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1096
# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1097
# doxygen's preprocessor will remove all function-like macros that are alone 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1098
# on a line, have an all uppercase name, and do not end with a semicolon. Such 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1099
# function macros are typically used for boiler-plate code, and will confuse 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1100
# the parser if not removed.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1101
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1102
SKIP_FUNCTION_MACROS   = YES
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1103
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1104
#---------------------------------------------------------------------------
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1105
# Configuration::additions related to external references   
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1106
#---------------------------------------------------------------------------
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1107
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1108
# The TAGFILES option can be used to specify one or more tagfiles. 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1109
# Optionally an initial location of the external documentation 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1110
# can be added for each tagfile. The format of a tag file without 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1111
# this location is as follows: 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1112
#   TAGFILES = file1 file2 ... 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1113
# Adding location for the tag files is done as follows: 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1114
#   TAGFILES = file1=loc1 "file2 = loc2" ... 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1115
# where "loc1" and "loc2" can be relative or absolute paths or 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1116
# URLs. If a location is present for each tag, the installdox tool 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1117
# does not have to be run to correct the links.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1118
# Note that each tag file must have a unique name
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1119
# (where the name does NOT include the path)
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1120
# If a tag file is not located in the directory in which doxygen 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1121
# is run, you must also specify the path to the tagfile here.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1122
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1123
TAGFILES               = 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1124
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1125
# When a file name is specified after GENERATE_TAGFILE, doxygen will create 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1126
# a tag file that is based on the input files it reads.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1127
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1128
GENERATE_TAGFILE       = 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1129
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1130
# If the ALLEXTERNALS tag is set to YES all external classes will be listed 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1131
# in the class index. If set to NO only the inherited external classes 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1132
# will be listed.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1133
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1134
ALLEXTERNALS           = NO
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1135
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1136
# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1137
# in the modules index. If set to NO, only the current project's groups will 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1138
# be listed.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1139
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1140
EXTERNAL_GROUPS        = YES
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1141
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1142
# The PERL_PATH should be the absolute path and name of the perl script 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1143
# interpreter (i.e. the result of `which perl').
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1144
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1145
PERL_PATH              = /usr/bin/perl
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1146
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1147
#---------------------------------------------------------------------------
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1148
# Configuration options related to the dot tool   
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1149
#---------------------------------------------------------------------------
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1150
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1151
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1152
# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1153
# or super classes. Setting the tag to NO turns the diagrams off. Note that 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1154
# this option is superseded by the HAVE_DOT option below. This is only a 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1155
# fallback. It is recommended to install and use dot, since it yields more 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1156
# powerful graphs.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1157
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1158
CLASS_DIAGRAMS         = YES
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1159
1812
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
  1160
# You can define message sequence charts within doxygen comments using the \msc 
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
  1161
# command. Doxygen will then run the mscgen tool (see http://www.mcternan.me.uk/mscgen/) to 
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
  1162
# produce the chart and insert it in the documentation. The MSCGEN_PATH tag allows you to 
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
  1163
# specify the directory where the mscgen tool resides. If left empty the tool is assumed to 
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
  1164
# be found in the default search path.
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
  1165
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
  1166
MSCGEN_PATH            = 
750fce457d29 update doxygen.conf to 1.5.4
Tom Henderson <tomh@tomh.org>
parents: 1804
diff changeset
  1167
55
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1168
# If set to YES, the inheritance and collaboration graphs will hide 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1169
# inheritance and usage relations if the target is undocumented 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1170
# or is not a class.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1171
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1172
HIDE_UNDOC_RELATIONS   = YES
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1173
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1174
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1175
# available from the path. This tool is part of Graphviz, a graph visualization 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1176
# toolkit from AT&T and Lucent Bell Labs. The other options in this section 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1177
# have no effect if this option is set to NO (the default)
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1178
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1179
HAVE_DOT               = YES
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1180
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1181
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1182
# will generate a graph for each documented class showing the direct and 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1183
# indirect inheritance relations. Setting this tag to YES will force the 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1184
# the CLASS_DIAGRAMS tag to NO.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1185
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1186
CLASS_GRAPH            = YES
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1187
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1188
# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1189
# will generate a graph for each documented class showing the direct and 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1190
# indirect implementation dependencies (inheritance, containment, and 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1191
# class references variables) of the class with other documented classes.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1192
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1193
COLLABORATION_GRAPH    = YES
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1194
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1195
# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1196
# will generate a graph for groups, showing the direct groups dependencies
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1197
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1198
GROUP_GRAPHS           = YES
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1199
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1200
# If the UML_LOOK tag is set to YES doxygen will generate inheritance and 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1201
# collaboration diagrams in a style similar to the OMG's Unified Modeling 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1202
# Language.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1203
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1204
UML_LOOK               = NO
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1205
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1206
# If set to YES, the inheritance and collaboration graphs will show the 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1207
# relations between templates and their instances.
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1208
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1209
TEMPLATE_RELATIONS     = NO
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1210
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1211
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
  1212
# tags are set to YES then doxygen will generate a graph for each documented 
b811c06c6317 add doxygen framework
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset