doc/Doxyfile.in
author Alpar Juttner <alpar@cs.elte.hu>
Mon, 06 Oct 2008 13:02:13 +0100
changeset 305 069f27927ba9
parent 219 b9c6a47c977b
parent 224 b246072978e8
child 299 907446600ca9
permissions -rw-r--r--
0.x -> 1.x migration script and guide (preliminary version) (#157)
ladanyi@150
     1
# Doxyfile 1.5.5
ladanyi@1
     2
ladanyi@1
     3
#---------------------------------------------------------------------------
ladanyi@1
     4
# Project related configuration options
ladanyi@1
     5
#---------------------------------------------------------------------------
ladanyi@150
     6
DOXYFILE_ENCODING      = UTF-8
ladanyi@1
     7
PROJECT_NAME           = @PACKAGE_NAME@
ladanyi@1
     8
PROJECT_NUMBER         = @PACKAGE_VERSION@
ladanyi@1
     9
OUTPUT_DIRECTORY       = 
ladanyi@1
    10
CREATE_SUBDIRS         = NO
ladanyi@1
    11
OUTPUT_LANGUAGE        = English
ladanyi@1
    12
BRIEF_MEMBER_DESC      = YES
ladanyi@1
    13
REPEAT_BRIEF           = NO
ladanyi@1
    14
ABBREVIATE_BRIEF       = 
ladanyi@1
    15
ALWAYS_DETAILED_SEC    = NO
ladanyi@1
    16
INLINE_INHERITED_MEMB  = NO
ladanyi@1
    17
FULL_PATH_NAMES        = YES
alpar@224
    18
STRIP_FROM_PATH        = "@abs_top_srcdir@"
alpar@224
    19
STRIP_FROM_INC_PATH    = "@abs_top_srcdir@"
ladanyi@1
    20
SHORT_NAMES            = YES
ladanyi@1
    21
JAVADOC_AUTOBRIEF      = NO
ladanyi@150
    22
QT_AUTOBRIEF           = NO
ladanyi@1
    23
MULTILINE_CPP_IS_BRIEF = NO
ladanyi@1
    24
DETAILS_AT_TOP         = YES
ladanyi@1
    25
INHERIT_DOCS           = NO
ladanyi@150
    26
SEPARATE_MEMBER_PAGES  = NO
ladanyi@150
    27
TAB_SIZE               = 8
ladanyi@150
    28
ALIASES                = 
ladanyi@150
    29
OPTIMIZE_OUTPUT_FOR_C  = NO
ladanyi@150
    30
OPTIMIZE_OUTPUT_JAVA   = NO
ladanyi@150
    31
OPTIMIZE_FOR_FORTRAN   = NO
ladanyi@150
    32
OPTIMIZE_OUTPUT_VHDL   = NO
alpar@151
    33
BUILTIN_STL_SUPPORT    = YES
ladanyi@150
    34
CPP_CLI_SUPPORT        = NO
ladanyi@150
    35
SIP_SUPPORT            = NO
ladanyi@1
    36
DISTRIBUTE_GROUP_DOC   = NO
ladanyi@1
    37
SUBGROUPING            = YES
ladanyi@150
    38
TYPEDEF_HIDES_STRUCT   = NO
ladanyi@1
    39
#---------------------------------------------------------------------------
ladanyi@1
    40
# Build related configuration options
ladanyi@1
    41
#---------------------------------------------------------------------------
ladanyi@1
    42
EXTRACT_ALL            = NO
ladanyi@1
    43
EXTRACT_PRIVATE        = YES
ladanyi@1
    44
EXTRACT_STATIC         = YES
ladanyi@1
    45
EXTRACT_LOCAL_CLASSES  = NO
ladanyi@1
    46
EXTRACT_LOCAL_METHODS  = NO
ladanyi@150
    47
EXTRACT_ANON_NSPACES   = NO
ladanyi@1
    48
HIDE_UNDOC_MEMBERS     = YES
ladanyi@1
    49
HIDE_UNDOC_CLASSES     = YES
ladanyi@1
    50
HIDE_FRIEND_COMPOUNDS  = NO
ladanyi@1
    51
HIDE_IN_BODY_DOCS      = NO
ladanyi@150
    52
INTERNAL_DOCS          = NO
ladanyi@1
    53
CASE_SENSE_NAMES       = YES
ladanyi@1
    54
HIDE_SCOPE_NAMES       = YES
ladanyi@1
    55
SHOW_INCLUDE_FILES     = YES
ladanyi@1
    56
INLINE_INFO            = YES
ladanyi@1
    57
SORT_MEMBER_DOCS       = NO
ladanyi@1
    58
SORT_BRIEF_DOCS        = NO
ladanyi@150
    59
SORT_GROUP_NAMES       = NO
ladanyi@1
    60
SORT_BY_SCOPE_NAME     = NO
ladanyi@1
    61
GENERATE_TODOLIST      = YES
ladanyi@1
    62
GENERATE_TESTLIST      = YES
ladanyi@1
    63
GENERATE_BUGLIST       = YES
ladanyi@1
    64
GENERATE_DEPRECATEDLIST= YES
ladanyi@1
    65
ENABLED_SECTIONS       = 
ladanyi@1
    66
MAX_INITIALIZER_LINES  = 5
ladanyi@1
    67
SHOW_USED_FILES        = YES
ladanyi@1
    68
SHOW_DIRECTORIES       = YES
ladanyi@1
    69
FILE_VERSION_FILTER    = 
ladanyi@1
    70
#---------------------------------------------------------------------------
ladanyi@1
    71
# configuration options related to warning and progress messages
ladanyi@1
    72
#---------------------------------------------------------------------------
ladanyi@1
    73
QUIET                  = NO
ladanyi@1
    74
WARNINGS               = YES
ladanyi@1
    75
WARN_IF_UNDOCUMENTED   = YES
ladanyi@1
    76
WARN_IF_DOC_ERROR      = YES
ladanyi@1
    77
WARN_NO_PARAMDOC       = NO
ladanyi@150
    78
WARN_FORMAT            = "$file:$line: $text  "
ladanyi@1
    79
WARN_LOGFILE           = doxygen.log
ladanyi@1
    80
#---------------------------------------------------------------------------
ladanyi@1
    81
# configuration options related to the input files
ladanyi@1
    82
#---------------------------------------------------------------------------
alpar@224
    83
INPUT                  = "@abs_top_srcdir@/doc" \
alpar@224
    84
                         "@abs_top_srcdir@/lemon" \
alpar@224
    85
                         "@abs_top_srcdir@/lemon/bits" \
alpar@224
    86
                         "@abs_top_srcdir@/lemon/concepts" \
alpar@224
    87
                         "@abs_top_srcdir@/demo" \
alpar@224
    88
                         "@abs_top_srcdir@/tools" \
alpar@224
    89
                         "@abs_top_srcdir@/test/test_tools.h"
ladanyi@150
    90
INPUT_ENCODING         = UTF-8
ladanyi@150
    91
FILE_PATTERNS          = *.h \
ladanyi@150
    92
                         *.cc \
ladanyi@150
    93
                         *.dox
ladanyi@1
    94
RECURSIVE              = NO
ladanyi@1
    95
EXCLUDE                = 
ladanyi@1
    96
EXCLUDE_SYMLINKS       = NO
ladanyi@1
    97
EXCLUDE_PATTERNS       = 
ladanyi@150
    98
EXCLUDE_SYMBOLS        = 
alpar@224
    99
EXAMPLE_PATH           = "@abs_top_srcdir@/demo" \
alpar@224
   100
                         "@abs_top_srcdir@/LICENSE" \
alpar@224
   101
                         "@abs_top_srcdir@/doc"
ladanyi@1
   102
EXAMPLE_PATTERNS       = 
ladanyi@1
   103
EXAMPLE_RECURSIVE      = NO
alpar@224
   104
IMAGE_PATH             = "@abs_top_srcdir@/doc/images" \
alpar@224
   105
                         "@abs_top_builddir@/doc/gen-images"
ladanyi@1
   106
INPUT_FILTER           = 
ladanyi@1
   107
FILTER_PATTERNS        = 
ladanyi@1
   108
FILTER_SOURCE_FILES    = NO
ladanyi@1
   109
#---------------------------------------------------------------------------
ladanyi@1
   110
# configuration options related to source browsing
ladanyi@1
   111
#---------------------------------------------------------------------------
ladanyi@1
   112
SOURCE_BROWSER         = NO
ladanyi@1
   113
INLINE_SOURCES         = NO
ladanyi@1
   114
STRIP_CODE_COMMENTS    = YES
ladanyi@1
   115
REFERENCED_BY_RELATION = NO
ladanyi@1
   116
REFERENCES_RELATION    = NO
ladanyi@150
   117
REFERENCES_LINK_SOURCE = YES
ladanyi@150
   118
USE_HTAGS              = NO
ladanyi@1
   119
VERBATIM_HEADERS       = NO
ladanyi@1
   120
#---------------------------------------------------------------------------
ladanyi@1
   121
# configuration options related to the alphabetical class index
ladanyi@1
   122
#---------------------------------------------------------------------------
ladanyi@1
   123
ALPHABETICAL_INDEX     = YES
ladanyi@1
   124
COLS_IN_ALPHA_INDEX    = 2
ladanyi@1
   125
IGNORE_PREFIX          = 
ladanyi@1
   126
#---------------------------------------------------------------------------
ladanyi@1
   127
# configuration options related to the HTML output
ladanyi@1
   128
#---------------------------------------------------------------------------
ladanyi@1
   129
GENERATE_HTML          = YES
ladanyi@1
   130
HTML_OUTPUT            = html
ladanyi@1
   131
HTML_FILE_EXTENSION    = .html
ladanyi@1
   132
HTML_HEADER            = 
ladanyi@1
   133
HTML_FOOTER            = 
ladanyi@1
   134
HTML_STYLESHEET        = 
ladanyi@1
   135
HTML_ALIGN_MEMBERS     = YES
ladanyi@1
   136
GENERATE_HTMLHELP      = NO
ladanyi@150
   137
GENERATE_DOCSET        = NO
ladanyi@150
   138
DOCSET_FEEDNAME        = "Doxygen generated docs"
ladanyi@150
   139
DOCSET_BUNDLE_ID       = org.doxygen.Project
ladanyi@150
   140
HTML_DYNAMIC_SECTIONS  = NO
ladanyi@1
   141
CHM_FILE               = 
ladanyi@1
   142
HHC_LOCATION           = 
ladanyi@1
   143
GENERATE_CHI           = NO
ladanyi@1
   144
BINARY_TOC             = NO
ladanyi@1
   145
TOC_EXPAND             = NO
ladanyi@1
   146
DISABLE_INDEX          = NO
ladanyi@1
   147
ENUM_VALUES_PER_LINE   = 4
alpar@219
   148
GENERATE_TREEVIEW      = NO
ladanyi@1
   149
TREEVIEW_WIDTH         = 250
ladanyi@1
   150
#---------------------------------------------------------------------------
ladanyi@1
   151
# configuration options related to the LaTeX output
ladanyi@1
   152
#---------------------------------------------------------------------------
ladanyi@1
   153
GENERATE_LATEX         = NO
ladanyi@1
   154
LATEX_OUTPUT           = latex
ladanyi@1
   155
LATEX_CMD_NAME         = latex
ladanyi@1
   156
MAKEINDEX_CMD_NAME     = makeindex
ladanyi@1
   157
COMPACT_LATEX          = YES
ladanyi@1
   158
PAPER_TYPE             = a4wide
ladanyi@1
   159
EXTRA_PACKAGES         = amsmath \
ladanyi@1
   160
                         amssymb
ladanyi@1
   161
LATEX_HEADER           = 
ladanyi@1
   162
PDF_HYPERLINKS         = YES
ladanyi@1
   163
USE_PDFLATEX           = YES
ladanyi@1
   164
LATEX_BATCHMODE        = NO
ladanyi@1
   165
LATEX_HIDE_INDICES     = NO
ladanyi@1
   166
#---------------------------------------------------------------------------
ladanyi@1
   167
# configuration options related to the RTF output
ladanyi@1
   168
#---------------------------------------------------------------------------
ladanyi@1
   169
GENERATE_RTF           = NO
ladanyi@1
   170
RTF_OUTPUT             = rtf
ladanyi@1
   171
COMPACT_RTF            = NO
ladanyi@1
   172
RTF_HYPERLINKS         = NO
ladanyi@1
   173
RTF_STYLESHEET_FILE    = 
ladanyi@1
   174
RTF_EXTENSIONS_FILE    = 
ladanyi@1
   175
#---------------------------------------------------------------------------
ladanyi@1
   176
# configuration options related to the man page output
ladanyi@1
   177
#---------------------------------------------------------------------------
ladanyi@1
   178
GENERATE_MAN           = NO
ladanyi@1
   179
MAN_OUTPUT             = man
ladanyi@1
   180
MAN_EXTENSION          = .3
ladanyi@1
   181
MAN_LINKS              = NO
ladanyi@1
   182
#---------------------------------------------------------------------------
ladanyi@1
   183
# configuration options related to the XML output
ladanyi@1
   184
#---------------------------------------------------------------------------
ladanyi@1
   185
GENERATE_XML           = NO
ladanyi@1
   186
XML_OUTPUT             = xml
ladanyi@1
   187
XML_SCHEMA             = 
ladanyi@1
   188
XML_DTD                = 
ladanyi@1
   189
XML_PROGRAMLISTING     = YES
ladanyi@1
   190
#---------------------------------------------------------------------------
ladanyi@1
   191
# configuration options for the AutoGen Definitions output
ladanyi@1
   192
#---------------------------------------------------------------------------
ladanyi@1
   193
GENERATE_AUTOGEN_DEF   = NO
ladanyi@1
   194
#---------------------------------------------------------------------------
ladanyi@1
   195
# configuration options related to the Perl module output
ladanyi@1
   196
#---------------------------------------------------------------------------
ladanyi@1
   197
GENERATE_PERLMOD       = NO
ladanyi@1
   198
PERLMOD_LATEX          = NO
ladanyi@1
   199
PERLMOD_PRETTY         = YES
ladanyi@1
   200
PERLMOD_MAKEVAR_PREFIX = 
ladanyi@1
   201
#---------------------------------------------------------------------------
ladanyi@1
   202
# Configuration options related to the preprocessor   
ladanyi@1
   203
#---------------------------------------------------------------------------
ladanyi@1
   204
ENABLE_PREPROCESSING   = YES
ladanyi@1
   205
MACRO_EXPANSION        = NO
ladanyi@1
   206
EXPAND_ONLY_PREDEF     = NO
ladanyi@1
   207
SEARCH_INCLUDES        = YES
ladanyi@1
   208
INCLUDE_PATH           = 
ladanyi@1
   209
INCLUDE_FILE_PATTERNS  = 
ladanyi@1
   210
PREDEFINED             = DOXYGEN
ladanyi@1
   211
EXPAND_AS_DEFINED      = 
ladanyi@1
   212
SKIP_FUNCTION_MACROS   = YES
ladanyi@1
   213
#---------------------------------------------------------------------------
ladanyi@1
   214
# Configuration::additions related to external references   
ladanyi@1
   215
#---------------------------------------------------------------------------
ladanyi@150
   216
TAGFILES               = "@abs_top_srcdir@/doc/libstdc++.tag = http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/  "
ladanyi@1
   217
GENERATE_TAGFILE       = html/lemon.tag
ladanyi@1
   218
ALLEXTERNALS           = NO
ladanyi@1
   219
EXTERNAL_GROUPS        = NO
ladanyi@1
   220
PERL_PATH              = /usr/bin/perl
ladanyi@1
   221
#---------------------------------------------------------------------------
ladanyi@1
   222
# Configuration options related to the dot tool   
ladanyi@1
   223
#---------------------------------------------------------------------------
ladanyi@1
   224
CLASS_DIAGRAMS         = NO
ladanyi@150
   225
MSCGEN_PATH            = 
ladanyi@1
   226
HIDE_UNDOC_RELATIONS   = YES
ladanyi@1
   227
HAVE_DOT               = YES
ladanyi@1
   228
CLASS_GRAPH            = YES
ladanyi@1
   229
COLLABORATION_GRAPH    = NO
ladanyi@1
   230
GROUP_GRAPHS           = NO
ladanyi@1
   231
UML_LOOK               = NO
ladanyi@1
   232
TEMPLATE_RELATIONS     = NO
ladanyi@1
   233
INCLUDE_GRAPH          = NO
ladanyi@1
   234
INCLUDED_BY_GRAPH      = NO
ladanyi@1
   235
CALL_GRAPH             = NO
ladanyi@150
   236
CALLER_GRAPH           = NO
ladanyi@1
   237
GRAPHICAL_HIERARCHY    = NO
ladanyi@1
   238
DIRECTORY_GRAPH        = NO
ladanyi@1
   239
DOT_IMAGE_FORMAT       = png
ladanyi@1
   240
DOT_PATH               = 
ladanyi@1
   241
DOTFILE_DIRS           = 
ladanyi@150
   242
DOT_GRAPH_MAX_NODES    = 50
ladanyi@1
   243
MAX_DOT_GRAPH_DEPTH    = 0
ladanyi@1
   244
DOT_TRANSPARENT        = NO
ladanyi@1
   245
DOT_MULTI_TARGETS      = NO
ladanyi@1
   246
GENERATE_LEGEND        = YES
ladanyi@1
   247
DOT_CLEANUP            = YES
ladanyi@1
   248
#---------------------------------------------------------------------------
ladanyi@1
   249
# Configuration::additions related to the search engine   
ladanyi@1
   250
#---------------------------------------------------------------------------
ladanyi@1
   251
SEARCHENGINE           = NO