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