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