Doxyfile 9.65 KB
Newer Older
dimitri's avatar
dimitri committed
1
# Doxyfile 1.5.4
dimitri's avatar
dimitri committed
2 3

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