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