Doxyfile 10.6 KB
Newer Older
1
# Doxyfile 1.6.3
2 3

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