doxydoc.cfg 9.36 KB
Newer Older
1
# Doxyfile 1.6.3
thomas.forbriger's avatar
thomas.forbriger committed
2
3

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