Doxyfile 12.6 KB
Newer Older
1
# Doxyfile 1.8.3.1
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 10
PROJECT_BRIEF          =
PROJECT_LOGO           =
11
OUTPUT_DIRECTORY       = doxygen_docs
12
CREATE_SUBDIRS         = YES
13 14 15
OUTPUT_LANGUAGE        = English
BRIEF_MEMBER_DESC      = YES
REPEAT_BRIEF           = YES
16
ABBREVIATE_BRIEF       =
17
ALWAYS_DETAILED_SEC    = NO
Dimitri van Heesch's avatar
Dimitri van Heesch committed
18
INLINE_INHERITED_MEMB  = NO
19
FULL_PATH_NAMES        = YES
20 21
STRIP_FROM_PATH        =
STRIP_FROM_INC_PATH    =
22 23
SHORT_NAMES            = NO
JAVADOC_AUTOBRIEF      = YES
Dimitri van Heesch's avatar
Dimitri van Heesch committed
24
QT_AUTOBRIEF           = NO
25 26
MULTILINE_CPP_IS_BRIEF = NO
INHERIT_DOCS           = YES
27
SEPARATE_MEMBER_PAGES  = NO
28
TAB_SIZE               = 8
29
ALIASES                =
30
TCL_SUBST              =
31 32
OPTIMIZE_OUTPUT_FOR_C  = NO
OPTIMIZE_OUTPUT_JAVA   = NO
33
OPTIMIZE_FOR_FORTRAN   = NO
34
OPTIMIZE_OUTPUT_VHDL   = NO
35
EXTENSION_MAPPING      =
36
MARKDOWN_SUPPORT       = YES
37
AUTOLINK_SUPPORT       = YES
Dimitri van Heesch's avatar
Dimitri van Heesch committed
38 39
BUILTIN_STL_SUPPORT    = NO
CPP_CLI_SUPPORT        = NO
40
SIP_SUPPORT            = NO
41
IDL_PROPERTY_SUPPORT   = YES
Dimitri van Heesch's avatar
Dimitri van Heesch committed
42
DISTRIBUTE_GROUP_DOC   = NO
43
SUBGROUPING            = YES
44 45
INLINE_GROUPED_CLASSES = NO
INLINE_SIMPLE_STRUCTS  = NO
46
TYPEDEF_HIDES_STRUCT   = NO
47
LOOKUP_CACHE_SIZE      = 0
48 49 50 51
#---------------------------------------------------------------------------
# Build related configuration options
#---------------------------------------------------------------------------
EXTRACT_ALL            = YES
52
EXTRACT_PRIVATE        = YES
53
EXTRACT_PACKAGE        = NO
54 55
EXTRACT_STATIC         = YES
EXTRACT_LOCAL_CLASSES  = YES
56
EXTRACT_LOCAL_METHODS  = NO
57
EXTRACT_ANON_NSPACES   = NO
58 59 60 61
HIDE_UNDOC_MEMBERS     = NO
HIDE_UNDOC_CLASSES     = NO
HIDE_FRIEND_COMPOUNDS  = NO
HIDE_IN_BODY_DOCS      = NO
62 63 64
INTERNAL_DOCS          = NO
CASE_SENSE_NAMES       = NO
HIDE_SCOPE_NAMES       = NO
Dimitri van Heesch's avatar
Dimitri van Heesch committed
65
SHOW_INCLUDE_FILES     = YES
66
FORCE_LOCAL_INCLUDES   = NO
67 68
INLINE_INFO            = YES
SORT_MEMBER_DOCS       = YES
69
SORT_BRIEF_DOCS        = NO
70
SORT_MEMBERS_CTORS_1ST = NO
71
SORT_GROUP_NAMES       = NO
72
SORT_BY_SCOPE_NAME     = NO
73
STRICT_PROTO_MATCHING  = NO
74 75
GENERATE_TODOLIST      = YES
GENERATE_TESTLIST      = YES
Dimitri van Heesch's avatar
Dimitri van Heesch committed
76
GENERATE_BUGLIST       = YES
77
GENERATE_DEPRECATEDLIST= YES
78
ENABLED_SECTIONS       =
Dimitri van Heesch's avatar
Dimitri van Heesch committed
79
MAX_INITIALIZER_LINES  = 30
80
SHOW_USED_FILES        = YES
81 82
SHOW_FILES             = YES
SHOW_NAMESPACES        = YES
83 84
FILE_VERSION_FILTER    =
LAYOUT_FILE            =
85
CITE_BIB_FILES         =
86 87 88 89 90 91
#---------------------------------------------------------------------------
# configuration options related to warning and progress messages
#---------------------------------------------------------------------------
QUIET                  = NO
WARNINGS               = YES
WARN_IF_UNDOCUMENTED   = YES
92
WARN_IF_DOC_ERROR      = YES
93
WARN_NO_PARAMDOC       = NO
94
WARN_FORMAT            = "$file:$line: $text "
95
WARN_LOGFILE           =
96 97 98
#---------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------
Dimitri van Heesch's avatar
Dimitri van Heesch committed
99
INPUT                  = src
Dimitri van Heesch's avatar
Dimitri van Heesch committed
100
INPUT_ENCODING         = UTF-8
101
FILE_PATTERNS          = *.h \
Dimitri van Heesch's avatar
Dimitri van Heesch committed
102
                         *.cpp \
103
                         *.md
104 105 106 107 108 109 110 111 112 113
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 \
114
                         src/doctokenizer.cpp \
Dimitri van Heesch's avatar
Dimitri van Heesch committed
115 116 117
                         src/logos.cpp \
                         src/suffixtree.cpp \
                         src/suffixtree.h \
118
                         src/commentcnv.cpp \
119 120
                         src/commentscan.cpp \
                         src/pycode.cpp \
121 122
                         src/config.cpp \
                         src/pyscanner.cpp \
Dimitri van Heesch's avatar
Dimitri van Heesch committed
123
                         src/fortranscanner.cpp \
124 125
                         src/fortrancode.cpp \
                         src/vhdlscanner.cpp \
126
                         src/vhdlparser.cpp \
127
                         src/vhdlcode.cpp \
128
                         src/tclscanner.cpp \
129
                         src/lodepng.cpp \
130 131 132 133 134
                         src/doxygen_css.h \
                         src/doxygen_js.h \
                         src/doxygen_php.h \
                         src/compound_xsd.h \
                         src/layout_default.h \
135
                         src/bib2xhtml.h \
Dimitri van Heesch's avatar
Dimitri van Heesch committed
136 137 138 139 140 141 142 143 144 145 146 147
                         src/doxygen_bst.h \
                         src/header_html.h \
                         src/index_xsd.h \
                         src/jquery_js.h \
                         src/jquery_fx_js.h \
                         src/jquery_ui_js.h \
                         src/navtree_css.h \
                         src/navtree_hs.h \
                         src/search_css.h \
                         src/search_functions_php.h \
                         src/search_opensearch_php.h \
                         src/search_js.h \
148 149 150 151 152 153 154
                         src/sizzle_js.h \
			 src/navtree_js.h \
			 src/resize_js.h \
		         src/svgpan_js.h \
		         src/dynsections_js.h \
			 src/extsearch_js.h \
			 src/footer_html.h \
155
EXCLUDE_SYMLINKS       = NO
156 157 158
EXCLUDE_SYMBOLS        =
EXAMPLE_PATH           =
EXAMPLE_PATTERNS       =
Dimitri van Heesch's avatar
Dimitri van Heesch committed
159
EXAMPLE_RECURSIVE      = NO
160 161 162
IMAGE_PATH             =
INPUT_FILTER           =
FILTER_PATTERNS        =
163
FILTER_SOURCE_FILES    = NO
164
FILTER_SOURCE_PATTERNS =
165
USE_MDFILE_AS_MAINPAGE =
166
#---------------------------------------------------------------------------
Dimitri van Heesch's avatar
Dimitri van Heesch committed
167 168 169 170
# configuration options related to source browsing
#---------------------------------------------------------------------------
SOURCE_BROWSER         = YES
INLINE_SOURCES         = NO
171
STRIP_CODE_COMMENTS    = YES
Dimitri van Heesch's avatar
Dimitri van Heesch committed
172 173
REFERENCED_BY_RELATION = YES
REFERENCES_RELATION    = YES
Dimitri van Heesch's avatar
Dimitri van Heesch committed
174
REFERENCES_LINK_SOURCE = YES
175
USE_HTAGS              = NO
176
VERBATIM_HEADERS       = YES
177 178
CLANG_ASSISTED_PARSING = YES
CLANG_OPTIONS          =
Dimitri van Heesch's avatar
Dimitri van Heesch committed
179
#---------------------------------------------------------------------------
180 181
# configuration options related to the alphabetical class index
#---------------------------------------------------------------------------
182
ALPHABETICAL_INDEX     = YES
183
COLS_IN_ALPHA_INDEX    = 5
184
IGNORE_PREFIX          =
185 186 187
#---------------------------------------------------------------------------
# configuration options related to the HTML output
#---------------------------------------------------------------------------
Dimitri van Heesch's avatar
Dimitri van Heesch committed
188
GENERATE_HTML          = YES
189
HTML_OUTPUT            =
190
HTML_FILE_EXTENSION    = .html
191 192 193
HTML_HEADER            =
HTML_FOOTER            =
HTML_STYLESHEET        =
194
HTML_EXTRA_STYLESHEET  =
195
HTML_EXTRA_FILES       =
196 197 198 199
HTML_COLORSTYLE_HUE    = 220
HTML_COLORSTYLE_SAT    = 100
HTML_COLORSTYLE_GAMMA  = 80
HTML_TIMESTAMP         = YES
Dimitri van Heesch's avatar
Dimitri van Heesch committed
200
HTML_DYNAMIC_SECTIONS  = YES
201
HTML_INDEX_NUM_ENTRIES = 100
202 203 204
GENERATE_DOCSET        = YES
DOCSET_FEEDNAME        = "Doxygen docs"
DOCSET_BUNDLE_ID       = org.doxygen.Doxygen
205 206
DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
DOCSET_PUBLISHER_NAME  = Publisher
207
GENERATE_HTMLHELP      = NO
208 209
CHM_FILE               =
HHC_LOCATION           =
Dimitri van Heesch's avatar
Dimitri van Heesch committed
210
GENERATE_CHI           = NO
211
CHM_INDEX_ENCODING     =
Dimitri van Heesch's avatar
Dimitri van Heesch committed
212 213
BINARY_TOC             = NO
TOC_EXPAND             = NO
Dimitri van Heesch's avatar
Dimitri van Heesch committed
214
GENERATE_QHP           = NO
215
QCH_FILE               =
Dimitri van Heesch's avatar
Dimitri van Heesch committed
216 217
QHP_NAMESPACE          = org.doxygen.Project
QHP_VIRTUAL_FOLDER     = doc
218 219 220 221 222 223
QHP_CUST_FILTER_NAME   =
QHP_CUST_FILTER_ATTRS  =
QHP_SECT_FILTER_ATTRS  =
QHG_LOCATION           =
GENERATE_ECLIPSEHELP   = NO
ECLIPSE_DOC_ID         = org.doxygen.Project
224
DISABLE_INDEX          = YES
225
GENERATE_TREEVIEW      = YES
226
ENUM_VALUES_PER_LINE   = 4
227
TREEVIEW_WIDTH         = 250
228
EXT_LINKS_IN_WINDOW    = NO
229
FORMULA_FONTSIZE       = 10
230 231
FORMULA_TRANSPARENT    = YES
USE_MATHJAX            = NO
232
MATHJAX_FORMAT         = HTML-CSS
233 234
MATHJAX_RELPATH        = http://cdn.mathjax.org/mathjax/latest
MATHJAX_EXTENSIONS     =
235
SEARCHENGINE           = YES
236
SERVER_BASED_SEARCH    = YES
237 238 239 240 241
EXTERNAL_SEARCH        = NO
SEARCHENGINE_URL       =
SEARCHDATA_FILE        = searchdata.xml
EXTERNAL_SEARCH_ID     =
EXTRA_SEARCH_MAPPINGS  =
242 243 244
#---------------------------------------------------------------------------
# configuration options related to the LaTeX output
#---------------------------------------------------------------------------
245
GENERATE_LATEX         = NO
246
LATEX_OUTPUT           =
247 248
LATEX_CMD_NAME         = latex
MAKEINDEX_CMD_NAME     = makeindex
249 250
COMPACT_LATEX          = NO
PAPER_TYPE             = a4wide
251 252
EXTRA_PACKAGES         =
LATEX_HEADER           =
253
LATEX_FOOTER           =
254
LATEX_EXTRA_FILES      =
Dimitri van Heesch's avatar
Dimitri van Heesch committed
255
PDF_HYPERLINKS         = YES
256 257
USE_PDFLATEX           = NO
LATEX_BATCHMODE        = NO
258
LATEX_HIDE_INDICES     = NO
259
LATEX_SOURCE_CODE      = NO
260
LATEX_BIB_STYLE        = plain
261 262 263 264
#---------------------------------------------------------------------------
# configuration options related to the RTF output
#---------------------------------------------------------------------------
GENERATE_RTF           = NO
265
RTF_OUTPUT             =
266 267
COMPACT_RTF            = NO
RTF_HYPERLINKS         = NO
268 269
RTF_STYLESHEET_FILE    =
RTF_EXTENSIONS_FILE    =
270 271 272 273
#---------------------------------------------------------------------------
# configuration options related to the man page output
#---------------------------------------------------------------------------
GENERATE_MAN           = NO
274
MAN_OUTPUT             =
275
MAN_EXTENSION          = .3
Dimitri van Heesch's avatar
Dimitri van Heesch committed
276 277 278 279
MAN_LINKS              = NO
#---------------------------------------------------------------------------
# configuration options related to the XML output
#---------------------------------------------------------------------------
280
GENERATE_XML           = NO
281
XML_OUTPUT             = xml
282 283
XML_SCHEMA             =
XML_DTD                =
284
XML_PROGRAMLISTING     = YES
Dimitri van Heesch's avatar
Dimitri van Heesch committed
285
#---------------------------------------------------------------------------
286 287 288 289 290
# configuration options related to the DOCBOOK output
#---------------------------------------------------------------------------
GENERATE_DOCBOOK       = NO
DOCBOOK_OUTPUT         = docbook
#---------------------------------------------------------------------------
Dimitri van Heesch's avatar
Dimitri van Heesch committed
291 292 293
# configuration options for the AutoGen Definitions output
#---------------------------------------------------------------------------
GENERATE_AUTOGEN_DEF   = NO
294
#---------------------------------------------------------------------------
295 296
# configuration options related to the Perl module output
#---------------------------------------------------------------------------
297
GENERATE_PERLMOD       = NO
298 299
PERLMOD_LATEX          = NO
PERLMOD_PRETTY         = YES
300
PERLMOD_MAKEVAR_PREFIX =
301
#---------------------------------------------------------------------------
302
# Configuration options related to the preprocessor
303 304 305 306 307
#---------------------------------------------------------------------------
ENABLE_PREPROCESSING   = YES
MACRO_EXPANSION        = YES
EXPAND_ONLY_PREDEF     = YES
SEARCH_INCLUDES        = YES
308
INCLUDE_PATH           = qtools libmd5
309 310 311
INCLUDE_FILE_PATTERNS  =
PREDEFINED             =
EXPAND_AS_DEFINED      =
Dimitri van Heesch's avatar
Dimitri van Heesch committed
312
SKIP_FUNCTION_MACROS   = YES
313
#---------------------------------------------------------------------------
314
# Configuration::additions related to external references
315
#---------------------------------------------------------------------------
Dimitri van Heesch's avatar
Dimitri van Heesch committed
316
TAGFILES               = qtools_docs/qtools.tag=../../qtools_docs/html
317
GENERATE_TAGFILE       = doxygen.tag
318
ALLEXTERNALS           = NO
319
EXTERNAL_GROUPS        = YES
320
EXTERNAL_PAGES         = YES
321 322
PERL_PATH              = /usr/bin/perl
#---------------------------------------------------------------------------
323
# Configuration options related to the dot tool
324
#---------------------------------------------------------------------------
Dimitri van Heesch's avatar
Dimitri van Heesch committed
325
CLASS_DIAGRAMS         = NO
326
MSCGEN_PATH            =
327
HIDE_UNDOC_RELATIONS   = YES
Dimitri van Heesch's avatar
Dimitri van Heesch committed
328
HAVE_DOT               = YES
329
DOT_NUM_THREADS        = 0
330
DOT_FONTNAME           = Helvetica
331
DOT_FONTSIZE           = 10
332
DOT_FONTPATH           =
Dimitri van Heesch's avatar
Dimitri van Heesch committed
333 334 335
CLASS_GRAPH            = YES
COLLABORATION_GRAPH    = YES
GROUP_GRAPHS           = YES
336
UML_LOOK               = NO
337
UML_LIMIT_NUM_FIELDS   = 10
Dimitri van Heesch's avatar
Dimitri van Heesch committed
338
TEMPLATE_RELATIONS     = YES
Dimitri van Heesch's avatar
Dimitri van Heesch committed
339 340
INCLUDE_GRAPH          = YES
INCLUDED_BY_GRAPH      = YES
341
CALL_GRAPH             = NO
Dimitri van Heesch's avatar
Dimitri van Heesch committed
342
CALLER_GRAPH           = NO
343
GRAPHICAL_HIERARCHY    = YES
Dimitri van Heesch's avatar
Dimitri van Heesch committed
344
DIRECTORY_GRAPH        = YES
345
DOT_IMAGE_FORMAT       = svg
346
INTERACTIVE_SVG        = YES
347 348
DOT_PATH               =
DOTFILE_DIRS           =
349
MSCFILE_DIRS           =
Dimitri van Heesch's avatar
Dimitri van Heesch committed
350
DOT_GRAPH_MAX_NODES    = 50
351
MAX_DOT_GRAPH_DEPTH    = 0
352 353
DOT_TRANSPARENT        = NO
DOT_MULTI_TARGETS      = NO
354
GENERATE_LEGEND        = YES
355
DOT_CLEANUP            = NO