Doxyfile 10.6 KB
Newer Older
1
# Doxyfile 1.8.4
Dimitri van Heesch's avatar
Dimitri van Heesch committed
2 3

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