NumA++.doxyfile 102 KB
Newer Older
1
# Doxyfile 1.8.13
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
2
3
4
5

# This file describes the settings to be used by the documentation system
# doxygen (www.doxygen.org) for a project.
#
6
7
8
9
# All text after a double hash (##) is considered a comment and is placed in
# front of the TAG it is preceding.
#
# All text after a single hash (#) is considered a comment and will be ignored.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
10
# The format is:
11
12
13
14
# TAG = value [value, ...]
# For lists, items can also be appended using:
# TAG += value [value, ...]
# Values that contain spaces should be placed between quotes (\" \").
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
15
16
17
18
19
20

#---------------------------------------------------------------------------
# Project related configuration options
#---------------------------------------------------------------------------

# This tag specifies the encoding used for all characters in the config file
21
22
23
24
25
# that follow. The default is UTF-8 which is also the encoding used for all text
# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
# for the list of possible encodings.
# The default value is: UTF-8.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
26

27
DOXYFILE_ENCODING = UTF-8
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
28

29
30
31
32
33
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
# double-quotes, unless you are using Doxywizard) that should identify the
# project for which the documentation is generated. This name is used in the
# title of most generated pages and in a few other places.
# The default value is: My Project.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
34

35
PROJECT_NAME = PARTONS/NumA++
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
36

37
38
39
# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
# could be handy for archiving the generated documentation or if some version
# control system is used.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
40

41
PROJECT_NUMBER = 2.0
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
42
43

# Using the PROJECT_BRIEF tag one can provide an optional one line description
44
45
46
# for a project that appears at the top of each page and should give viewer a
# quick idea about the purpose of the project. Keep the description short.

47
PROJECT_BRIEF = "Numerical Analysis C++ routines"
48
49
50
51
52

# With the PROJECT_LOGO tag one can specify a logo or an icon that is included
# in the documentation. The maximum height of the logo should not exceed 55
# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
# the logo to the output directory.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
53

54
PROJECT_LOGO = ../partons/doc/images/logo_partons_77x50.jpg
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
55

56
57
58
59
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
# into which the generated documentation will be written. If a relative path is
# entered, it will be relative to the location where doxygen was started. If
# left blank the current directory will be used.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
60

61
OUTPUT_DIRECTORY = doc
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
62

63
64
65
66
67
68
69
# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
# directories (in 2 levels) under the output directory of each output format and
# will distribute the generated files over these directories. Enabling this
# option can be useful when feeding doxygen a huge amount of source files, where
# putting all generated files in the same directory would otherwise causes
# performance problems for the file system.
# The default value is: NO.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
70

71
CREATE_SUBDIRS = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
72

73
74
75
76
77
# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
# characters to appear in the names of generated files. If set to NO, non-ASCII
# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
# U+3044.
# The default value is: NO.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
78

79
ALLOW_UNICODE_NAMES = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
80
81
82
83

# The OUTPUT_LANGUAGE tag is used to specify the language in which all
# documentation generated by doxygen is written. Doxygen will use this
# information to generate all constant output in the proper language.
84
85
86
87
88
89
90
91
92
93
# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
# Ukrainian and Vietnamese.
# The default value is: English.

94
OUTPUT_LANGUAGE = English
95
96
97
98
99
100

# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
# descriptions after the members that are listed in the file and class
# documentation (similar to Javadoc). Set to NO to disable this.
# The default value is: YES.

101
BRIEF_MEMBER_DESC = YES
102
103
104
105
106

# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
# description of a member or function before the detailed description
#
# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
107
# brief descriptions will be completely suppressed.
108
# The default value is: YES.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
109

110
REPEAT_BRIEF = YES
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
111

112
113
114
115
116
117
118
119
# This tag implements a quasi-intelligent brief description abbreviator that is
# used to form the text in various listings. Each string in this list, if found
# as the leading text of the brief description, will be stripped from the text
# and the result, after processing the whole list, is used as the annotated
# text. Otherwise, the brief description is used as-is. If left blank, the
# following values are used ($name is automatically replaced with the name of
# the entity):The $name class, The $name widget, The $name file, is, provides,
# specifies, contains, represents, a, an and the.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
120

121
ABBREVIATE_BRIEF = 
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
122
123

# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
124
# doxygen will generate a detailed section even if there is only a brief
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
125
# description.
126
# The default value is: NO.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
127

128
ALWAYS_DETAILED_SEC = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
129
130
131
132
133

# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
# inherited members of a class in the documentation of that class as if those
# members were ordinary class members. Constructors, destructors and assignment
# operators of the base classes will not be shown.
134
# The default value is: NO.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
135

136
INLINE_INHERITED_MEMB = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
137

138
139
140
141
# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
# before files name in the file list and in the header files. If set to NO the
# shortest path that makes the file name unique will be used
# The default value is: YES.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
142

143
FULL_PATH_NAMES = YES
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
144

145
146
147
148
149
150
151
152
153
154
# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
# Stripping is only done if one of the specified strings matches the left-hand
# part of the path. The tag can be used to show relative paths in the file list.
# If left blank the directory from which doxygen is run is used as the path to
# strip.
#
# Note that you can specify absolute paths here, but also relative paths, which
# will be relative from the directory where doxygen is started.
# This tag requires that the tag FULL_PATH_NAMES is set to YES.

155
STRIP_FROM_PATH = 
156
157
158
159
160
161
162
163

# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
# path mentioned in the documentation of a class, which tells the reader which
# header file to include in order to use a class. If left blank only the name of
# the header file containing the class definition is used. Otherwise one should
# specify the list of include paths that are normally passed to the compiler
# using the -I flag.

164
STRIP_FROM_INC_PATH = 
165
166
167
168
169
170

# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
# less readable) file names. This can be useful is your file systems doesn't
# support long names like on DOS, Mac, or CD-ROM.
# The default value is: NO.

171
SHORT_NAMES = NO
172
173
174
175
176
177
178
179

# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
# first line (until the first dot) of a Javadoc-style comment as the brief
# description. If set to NO, the Javadoc-style will behave just like regular Qt-
# style comments (thus requiring an explicit @brief command for a brief
# description.)
# The default value is: NO.

180
JAVADOC_AUTOBRIEF = YES
181
182
183
184
185
186
187

# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
# line (until the first dot) of a Qt-style comment as the brief description. If
# set to NO, the Qt-style will behave just like regular Qt-style comments (thus
# requiring an explicit \brief command for a brief description.)
# The default value is: NO.

188
QT_AUTOBRIEF = NO
189
190
191
192
193
194
195
196
197
198

# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
# multi-line C++ special comment block (i.e. a block of //! or /// comments) as
# a brief description. This used to be the default behavior. The new default is
# to treat a multi-line C++ comment block as a detailed description. Set this
# tag to YES if you prefer the old behavior instead.
#
# Note that setting this tag to YES also means that rational rose comments are
# not recognized any more.
# The default value is: NO.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
199
200
201

MULTILINE_CPP_IS_BRIEF = NO

202
203
204
# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
# documentation from any documented member that it re-implements.
# The default value is: YES.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
205

206
INHERIT_DOCS = YES
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
207

208
209
210
211
# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
# page for each member. If set to NO, the documentation of a member will be part
# of the file/class/namespace that contains it.
# The default value is: NO.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
212

213
SEPARATE_MEMBER_PAGES = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
214

215
216
217
# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
# uses this value to replace tabs by spaces in code fragments.
# Minimum value: 1, maximum value: 16, default value: 4.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
218

219
TAB_SIZE = 8
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
220

221
222
223
224
225
226
227
228
229
# This tag can be used to specify a number of aliases that act as commands in
# the documentation. An alias has the form:
# name=value
# For example adding
# "sideeffect=@par Side Effects:\n"
# will allow you to put the command \sideeffect (or @sideeffect) in the
# documentation, which will result in a user-defined paragraph with heading
# "Side Effects:". You can put \n's in the value part of an alias to insert
# newlines.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
230

231
ALIASES = "st{1}=\htmlonly<span style='text-decoration:line-through'>\1</span>\endhtmlonly" "color{2}=\htmlonly<span style='color:\1'>\2</span>\endhtmlonly"
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
232
233

# This tag can be used to specify a number of word-keyword mappings (TCL only).
234
235
# A mapping has the form "name=value". For example adding "class=itcl::class"
# will allow you to use the command class in the itcl::class meaning.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
236

237
TCL_SUBST = 
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
238

239
240
241
242
243
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
# only. Doxygen will then generate output that is more tailored for C. For
# instance, some of the names that are used will be different. The list of all
# members will be omitted, etc.
# The default value is: NO.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
244

245
OPTIMIZE_OUTPUT_FOR_C = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
246

247
248
249
250
251
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
# Python sources only. Doxygen will then generate output that is more tailored
# for that language. For instance, namespaces will be presented as packages,
# qualified scopes will look different, etc.
# The default value is: NO.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
252

253
OPTIMIZE_OUTPUT_JAVA = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
254
255

# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
256
257
# sources. Doxygen will then generate output that is tailored for Fortran.
# The default value is: NO.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
258

259
OPTIMIZE_FOR_FORTRAN = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
260
261

# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
262
263
# sources. Doxygen will then generate output that is tailored for VHDL.
# The default value is: NO.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
264

265
OPTIMIZE_OUTPUT_VHDL = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
266
267

# Doxygen selects the parser to use depending on the extension of the files it
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
# parses. With this tag you can assign which parser to use for a given
# extension. Doxygen has a built-in mapping, but you can override or extend it
# using this tag. The format is ext=language, where ext is a file extension, and
# language is one of the parsers supported by doxygen: IDL, Java, Javascript,
# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:
# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:
# Fortran. In the later case the parser tries to guess whether the code is fixed
# or free formatted code, this is the default for Fortran type files), VHDL. For
# instance to make doxygen treat .inc files as Fortran files (default is PHP),
# and .f files as C (default is Fortran), use: inc=Fortran f=C.
#
# Note: For files without extension you can use no_extension as a placeholder.
#
# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
# the files are not read by doxygen.

284
EXTENSION_MAPPING = 
285
286
287

# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
# according to the Markdown format, which allows for more readable
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
288
# documentation. See http://daringfireball.net/projects/markdown/ for details.
289
290
291
292
293
# The output of markdown processing is further processed by doxygen, so you can
# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
# case of backward compatibilities issues.
# The default value is: YES.

294
MARKDOWN_SUPPORT = YES
295
296
297
298
299
300
301
302

# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
# to that level are automatically included in the table of contents, even if
# they do not have an id attribute.
# Note: This feature currently applies only to Markdown headings.
# Minimum value: 0, maximum value: 99, default value: 0.
# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.

303
TOC_INCLUDE_HEADINGS = 0
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
304

305
306
307
308
309
310
# When enabled doxygen tries to link words that correspond to documented
# classes, or namespaces to their corresponding documentation. Such a link can
# be prevented in individual cases by putting a % sign in front of the word or
# globally by setting AUTOLINK_SUPPORT to NO.
# The default value is: YES.

311
AUTOLINK_SUPPORT = YES
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
312
313

# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
314
315
316
317
# to include (a tag file for) the STL sources as input, then you should set this
# tag to YES in order to let doxygen match functions declarations and
# definitions whose arguments contain STL classes (e.g. func(std::string);
# versus func(std::string) {}). This also make the inheritance and collaboration
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
318
# diagrams that involve STL classes more complete and accurate.
319
# The default value is: NO.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
320

321
BUILTIN_STL_SUPPORT = YES
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
322
323
324

# If you use Microsoft's C++/CLI language, you should set this option to YES to
# enable parsing support.
325
# The default value is: NO.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
326

327
CPP_CLI_SUPPORT = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
328

329
330
331
332
333
# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
# will parse them like normal C++ but will assume all classes use public instead
# of private inheritance when no explicit protection keyword is present.
# The default value is: NO.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
334

335
SIP_SUPPORT = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
336

337
338
339
340
341
342
343
# For Microsoft's IDL there are propget and propput attributes to indicate
# getter and setter methods for a property. Setting this option to YES will make
# doxygen to replace the get and set methods by a property in the documentation.
# This will only work if the methods are indeed getting or setting a simple
# type. If this is not the case, or you want to show the methods anyway, you
# should set this option to NO.
# The default value is: YES.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
344

345
IDL_PROPERTY_SUPPORT = YES
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
346
347

# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
348
# tag is set to YES then doxygen will reuse the documentation of the first
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
349
350
# member in the group (if any) for the other members of the group. By default
# all members of a group must be documented explicitly.
351
352
# The default value is: NO.

353
DISTRIBUTE_GROUP_DOC = YES
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
354

355
356
357
358
# If one adds a struct or class to a group and this option is enabled, then also
# any nested class or struct is added to the same group. By default this option
# is disabled and one has to add nested compounds explicitly via \ingroup.
# The default value is: NO.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
359

360
GROUP_NESTED_COMPOUNDS = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
361

362
363
364
365
366
367
# Set the SUBGROUPING tag to YES to allow class member groups of the same type
# (for instance a group of public functions) to be put as a subgroup of that
# type (e.g. under the Public Functions section). Set it to NO to prevent
# subgrouping. Alternatively, this can be done per class using the
# \nosubgrouping command.
# The default value is: YES.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
368

369
SUBGROUPING = YES
370
371
372
373
374
375
376
377
378

# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
# are shown inside the group in which they are included (e.g. using \ingroup)
# instead of on a separate page (for HTML and Man pages) or section (for LaTeX
# and RTF).
#
# Note that this feature does not work in combination with
# SEPARATE_MEMBER_PAGES.
# The default value is: NO.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
379
380
381

INLINE_GROUPED_CLASSES = NO

382
383
384
385
386
387
388
# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
# with only public data fields or simple typedef fields will be shown inline in
# the documentation of the scope in which they are defined (i.e. file,
# namespace, or group documentation), provided this scope is documented. If set
# to NO, structs, classes, and unions are shown on a separate page (for HTML and
# Man pages) or section (for LaTeX and RTF).
# The default value is: NO.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
389

390
INLINE_SIMPLE_STRUCTS = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
391

392
393
# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
# enum is documented as struct, union, or enum with the name of the typedef. So
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
394
395
# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
# with name TypeT. When disabled the typedef will appear as a member of a file,
396
397
# namespace, or class. And the struct will be named TypeS. This can typically be
# useful for C code in case the coding convention dictates that all compound
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
398
# types are typedef'ed and only the typedef is referenced, never the tag name.
399
# The default value is: NO.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
400

401
TYPEDEF_HIDES_STRUCT = NO
402
403
404
405
406
407
408
409
410
411
412
413

# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
# cache is used to resolve symbols given their name and scope. Since this can be
# an expensive process and often the same symbol appears multiple times in the
# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
# doxygen will become slower. If the cache is too large, memory is wasted. The
# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
# symbols. At the end of a run doxygen will report the cache usage and suggest
# the optimal cache size from a speed point of view.
# Minimum value: 0, maximum value: 9, default value: 0.

414
LOOKUP_CACHE_SIZE = 0
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
415
416
417
418
419

#---------------------------------------------------------------------------
# Build related configuration options
#---------------------------------------------------------------------------

420
421
422
423
424
425
426
# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
# documentation are documented, even if no documentation was available. Private
# class members and static file members will be hidden unless the
# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
# Note: This will also disable the warnings about undocumented members that are
# normally produced when WARNINGS is set to YES.
# The default value is: NO.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
427

428
EXTRACT_ALL = YES
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
429

430
431
432
# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
# be included in the documentation.
# The default value is: NO.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
433

434
EXTRACT_PRIVATE = YES
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
435

436
437
438
# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
# scope will be included in the documentation.
# The default value is: NO.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
439

440
EXTRACT_PACKAGE = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
441

442
443
444
# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
# included in the documentation.
# The default value is: NO.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
445

446
EXTRACT_STATIC = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
447

448
449
450
451
452
# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
# locally in source files will be included in the documentation. If set to NO,
# only classes defined in header files are included. Does not have any effect
# for Java sources.
# The default value is: YES.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
453

454
EXTRACT_LOCAL_CLASSES = YES
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
455

456
457
458
459
460
# This flag is only useful for Objective-C code. If set to YES, local methods,
# which are defined in the implementation section but not in the interface are
# included in the documentation. If set to NO, only methods in the interface are
# included.
# The default value is: NO.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
461

462
EXTRACT_LOCAL_METHODS = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
463
464
465

# If this flag is set to YES, the members of anonymous namespaces will be
# extracted and appear in the documentation as a namespace called
466
467
468
469
# 'anonymous_namespace{file}', where file will be replaced with the base name of
# the file that contains the anonymous namespace. By default anonymous namespace
# are hidden.
# The default value is: NO.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
470

471
EXTRACT_ANON_NSPACES = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
472

473
474
475
476
477
# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
# undocumented members inside documented classes or files. If set to NO these
# members will be included in the various overviews, but no documentation
# section is generated. This option has no effect if EXTRACT_ALL is enabled.
# The default value is: NO.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
478

479
HIDE_UNDOC_MEMBERS = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
480

481
482
483
484
485
# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
# undocumented classes that are normally visible in the class hierarchy. If set
# to NO, these classes will be included in the various overviews. This option
# has no effect if EXTRACT_ALL is enabled.
# The default value is: NO.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
486

487
HIDE_UNDOC_CLASSES = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
488

489
490
491
492
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
# (class|struct|union) declarations. If set to NO, these declarations will be
# included in the documentation.
# The default value is: NO.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
493

494
HIDE_FRIEND_COMPOUNDS = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
495

496
497
498
499
# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
# documentation blocks found inside the body of a function. If set to NO, these
# blocks will be appended to the function's detailed documentation block.
# The default value is: NO.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
500

501
HIDE_IN_BODY_DOCS = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
502

503
504
505
506
# The INTERNAL_DOCS tag determines if documentation that is typed after a
# \internal command is included. If the tag is set to NO then the documentation
# will be excluded. Set it to YES to include the internal documentation.
# The default value is: NO.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
507

508
INTERNAL_DOCS = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
509

510
511
# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
# names in lower-case letters. If set to YES, upper-case letters are also
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
512
513
514
# allowed. This is useful if you have classes or files whose names only differ
# in case and if your file system supports case sensitive file names. Windows
# and Mac users are advised to set this option to NO.
515
516
# The default value is: system dependent.

517
CASE_SENSE_NAMES = YES
518
519
520
521
522
523

# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
# their full class and namespace scopes in the documentation. If set to YES, the
# scope will be hidden.
# The default value is: NO.

524
HIDE_SCOPE_NAMES = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
525

526
527
528
529
# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
# append additional text to a page's title, such as Class Reference. If set to
# YES the compound reference will be hidden.
# The default value is: NO.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
530

531
HIDE_COMPOUND_REFERENCE = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
532

533
534
535
# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
# the files that are included by a file in the documentation of that file.
# The default value is: YES.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
536

537
SHOW_INCLUDE_FILES = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
538

539
540
541
542
# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
# grouped member an include statement to the documentation, telling the reader
# which file to include in order to use the member.
# The default value is: NO.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
543

544
SHOW_GROUPED_MEMB_INC = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
545

546
547
548
# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
# files with double quotes in the documentation rather than with sharp brackets.
# The default value is: NO.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
549

550
FORCE_LOCAL_INCLUDES = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
551

552
553
554
# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
# documentation for inline members.
# The default value is: YES.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
555

556
INLINE_INFO = YES
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
557

558
559
560
561
# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
# (detailed) documentation of file and class members alphabetically by member
# name. If set to NO, the members will appear in declaration order.
# The default value is: YES.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
562

563
SORT_MEMBER_DOCS = YES
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
564

565
566
567
568
569
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
# descriptions of file, namespace and class members alphabetically by member
# name. If set to NO, the members will appear in declaration order. Note that
# this will also influence the order of the classes in the class list.
# The default value is: NO.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
570

571
SORT_BRIEF_DOCS = NO
572
573
574
575
576
577
578
579
580
581

# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
# (brief and detailed) documentation of class members so that constructors and
# destructors are listed first. If set to NO the constructors will appear in the
# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
# member documentation.
# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
# detailed member documentation.
# The default value is: NO.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
582
583
584

SORT_MEMBERS_CTORS_1ST = NO

585
586
587
588
# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
# of group names into alphabetical order. If set to NO the group names will
# appear in their defined order.
# The default value is: NO.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
589

590
SORT_GROUP_NAMES = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
591

592
593
594
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
# fully-qualified names, including namespaces. If set to NO, the class list will
# be sorted only by class name, not including the namespace part.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
595
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
596
597
598
# Note: This option applies only to the class list, not to the alphabetical
# list.
# The default value is: NO.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
599

600
SORT_BY_SCOPE_NAME = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
601

602
603
604
605
606
607
608
# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
# type resolution of all parameters of a function it will reject a match between
# the prototype and the implementation of a member function even if there is
# only one candidate or it is obvious which candidate to choose by doing a
# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
# accept a match between prototype and implementation in such cases.
# The default value is: NO.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
609

610
STRICT_PROTO_MATCHING = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
611

612
613
614
# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
# list. This list is created by putting \todo commands in the documentation.
# The default value is: YES.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
615

616
GENERATE_TODOLIST = YES
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
617

618
619
620
# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
# list. This list is created by putting \test commands in the documentation.
# The default value is: YES.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
621

622
GENERATE_TESTLIST = YES
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
623

624
625
626
# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
# list. This list is created by putting \bug commands in the documentation.
# The default value is: YES.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
627

628
GENERATE_BUGLIST = YES
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
629

630
631
632
633
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
# the deprecated list. This list is created by putting \deprecated commands in
# the documentation.
# The default value is: YES.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
634

635
GENERATE_DEPRECATEDLIST = YES
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
636

637
638
639
# The ENABLED_SECTIONS tag can be used to enable conditional documentation
# sections, marked by \if <section_label> ... \endif and \cond <section_label>
# ... \endcond blocks.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
640

641
ENABLED_SECTIONS = 
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
642

643
644
645
646
647
648
649
650
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
# initial value of a variable or macro / define can have for it to appear in the
# documentation. If the initializer consists of more lines than specified here
# it will be hidden. Use a value of 0 to hide initializers completely. The
# appearance of the value of individual variables and macros / defines can be
# controlled using \showinitializer or \hideinitializer command in the
# documentation regardless of this setting.
# Minimum value: 0, maximum value: 10000, default value: 30.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
651

652
MAX_INITIALIZER_LINES = 30
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
653

654
655
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
# the bottom of the documentation of classes and structs. If set to YES, the
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
656
# list will mention the files that were used to generate the documentation.
657
# The default value is: YES.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
658

659
SHOW_USED_FILES = YES
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
660

661
662
663
664
# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
# will remove the Files entry from the Quick Index and from the Folder Tree View
# (if specified).
# The default value is: YES.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
665

666
SHOW_FILES = YES
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
667

668
669
670
671
# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
# page. This will remove the Namespaces entry from the Quick Index and from the
# Folder Tree View (if specified).
# The default value is: YES.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
672

673
SHOW_NAMESPACES = YES
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
674
675
676
677

# The FILE_VERSION_FILTER tag can be used to specify a program or script that
# doxygen should invoke to get the current version for each file (typically from
# the version control system). Doxygen will invoke the program by executing (via
678
679
680
681
# popen()) the command command input-file, where command is the value of the
# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
# by doxygen. Whatever the program writes to standard output is used as the file
# version. For an example see the documentation.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
682

683
FILE_VERSION_FILTER = 
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
684
685
686
687

# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
# by doxygen. The layout file controls the global structure of the generated
# output files in an output format independent way. To create the layout file
688
689
690
691
692
693
694
# that represents doxygen's defaults, run doxygen with the -l option. You can
# optionally specify a file name after the option, if omitted DoxygenLayout.xml
# will be used as the name of the layout file.
#
# Note that if you run doxygen from a directory containing a file called
# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
# tag is left empty.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
695

696
LAYOUT_FILE = ../partons/doc/style/customlayout.xml
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
697

698
699
700
701
702
703
704
# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
# the reference definitions. This must be a list of .bib files. The .bib
# extension is automatically appended if omitted. This requires the bibtex tool
# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
# For LaTeX the style of the bibliography can be controlled using
# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
# search path. See also \cite for info how to create references.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
705

706
CITE_BIB_FILES = 
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
707
708

#---------------------------------------------------------------------------
709
# Configuration options related to warning and progress messages
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
710
711
#---------------------------------------------------------------------------

712
713
714
715
# The QUIET tag can be used to turn on/off the messages that are generated to
# standard output by doxygen. If QUIET is set to YES this implies that the
# messages are off.
# The default value is: NO.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
716

717
QUIET = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
718
719

# The WARNINGS tag can be used to turn on/off the warning messages that are
720
721
722
723
724
725
# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
# this implies that the warnings are on.
#
# Tip: Turn warnings on while writing the documentation.
# The default value is: YES.

726
WARNINGS = YES
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
727

728
729
730
731
# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
# will automatically be disabled.
# The default value is: YES.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
732

733
WARN_IF_UNDOCUMENTED = YES
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
734

735
736
737
738
739
# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
# potential errors in the documentation, such as not documenting some parameters
# in a documented function, or documenting parameters that don't exist or using
# markup commands wrongly.
# The default value is: YES.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
740

741
WARN_IF_DOC_ERROR = YES
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
742

743
744
745
746
747
# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
# are documented, but have no documentation for their parameters or return
# value. If set to NO, doxygen will only warn about wrong or incomplete
# parameter documentation, but not about the absence of documentation.
# The default value is: NO.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
748

749
WARN_NO_PARAMDOC = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
750

751
752
753
# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
# a warning is encountered.
# The default value is: NO.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
754

755
WARN_AS_ERROR = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
756

757
758
759
760
761
762
763
# The WARN_FORMAT tag determines the format of the warning messages that doxygen
# can produce. The string should contain the $file, $line, and $text tags, which
# will be replaced by the file and line number from which the warning originated
# and the warning text. Optionally the format may contain $version, which will
# be replaced by the version of the file (if it could be obtained via
# FILE_VERSION_FILTER)
# The default value is: $file:$line: $text.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
764

765
WARN_FORMAT = "$file:$line: $text"
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
766

767
768
769
770
# The WARN_LOGFILE tag can be used to specify a file to which warning and error
# messages should be written. If left blank the output is written to standard
# error (stderr).

771
WARN_LOGFILE = 
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
772
773

#---------------------------------------------------------------------------
774
# Configuration options related to the input files
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
775
776
#---------------------------------------------------------------------------

777
778
779
780
781
# The INPUT tag is used to specify the files and/or directories that contain
# documented source files. You may enter file names like myfile.cpp or
# directories like /usr/src/myproject. Separate the files or directories with
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
# Note: If this tag is empty the current directory is searched.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
782

783
INPUT = src include
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
784
785

# This tag can be used to specify the character encoding of the source files
786
787
788
789
790
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
# documentation (see: http://www.gnu.org/software/libiconv) for the list of
# possible encodings.
# The default value is: UTF-8.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
791

792
INPUT_ENCODING = UTF-8
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
793
794

# If the value of the INPUT tag contains directories, you can use the
795
796
797
798
799
800
801
802
803
804
805
806
# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
# *.h) to filter out the source-files in the directories.
#
# Note that for custom extensions or not directly supported extensions you also
# need to set EXTENSION_MAPPING for the extension otherwise the files are not
# read by doxygen.
#
# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,
# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08,
# *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
807

808
FILE_PATTERNS = 
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
809

810
811
812
# The RECURSIVE tag can be used to specify whether or not subdirectories should
# be searched for input files as well.
# The default value is: NO.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
813

814
RECURSIVE = YES
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
815
816
817
818

# The EXCLUDE tag can be used to specify files and/or directories that should be
# excluded from the INPUT source files. This way you can easily exclude a
# subdirectory from a directory tree whose root is specified with the INPUT tag.
819
#
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
820
821
822
# Note that relative paths are relative to the directory from which doxygen is
# run.

823
EXCLUDE = 
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
824
825
826
827

# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
# directories that are symbolic links (a Unix file system feature) are excluded
# from the input.
828
# The default value is: NO.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
829

830
EXCLUDE_SYMLINKS = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
831
832
833

# If the value of the INPUT tag contains directories, you can use the
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
834
835
836
837
# certain files from those directories.
#
# Note that the wildcards are matched against the file with absolute path, so to
# exclude all test directories for example use the pattern */test/*
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
838

839
EXCLUDE_PATTERNS = 
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
840
841
842
843
844
845

# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
# (namespaces, classes, functions, etc.) that should be excluded from the
# output. The symbol name can be a fully qualified name, a word, or if the
# wildcard * is used, a substring. Examples: ANamespace, AClass,
# AClass::ANamespace, ANamespace::*Test
846
847
848
#
# Note that the wildcards are matched against the file with absolute path, so to
# exclude all test directories use the pattern */test/*
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
849

850
EXCLUDE_SYMBOLS = 
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
851

852
853
854
# The EXAMPLE_PATH tag can be used to specify one or more files or directories
# that contain example code fragments that are included (see the \include
# command).
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
855

856
EXAMPLE_PATH = 
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
857
858

# If the value of the EXAMPLE_PATH tag contains directories, you can use the
859
860
861
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
# *.h) to filter out the source-files in the directories. If left blank all
# files are included.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
862

863
EXAMPLE_PATTERNS = 
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
864
865

# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
866
867
868
# searched for input files to be used with the \include or \dontinclude commands
# irrespective of the value of the RECURSIVE tag.
# The default value is: NO.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
869

870
EXAMPLE_RECURSIVE = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
871

872
873
874
# The IMAGE_PATH tag can be used to specify one or more files or directories
# that contain images that are to be included in the documentation (see the
# \image command).
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
875

876
IMAGE_PATH = 
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
877
878
879

# The INPUT_FILTER tag can be used to specify a program that doxygen should
# invoke to filter for each input file. Doxygen will invoke the filter program
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
# by executing (via popen()) the command:
#
# <filter> <input-file>
#
# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
# name of an input file. Doxygen will then use the output that the filter
# program writes to standard output. If FILTER_PATTERNS is specified, this tag
# will be ignored.
#
# Note that the filter must not add or remove lines; it is applied before the
# code is scanned, but not when the output code is generated. If lines are added
# or removed, the anchors will not be placed correctly.
#
# Note that for custom extensions or not directly supported extensions you also
# need to set EXTENSION_MAPPING for the extension otherwise the files are not
# properly processed by doxygen.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
896

897
INPUT_FILTER = 
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
898
899

# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
900
901
902
903
904
905
906
907
908
# basis. Doxygen will compare the file name with each pattern and apply the
# filter if there is a match. The filters are a list of the form: pattern=filter
# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
# patterns match the file name, INPUT_FILTER is applied.
#
# Note that for custom extensions or not directly supported extensions you also
# need to set EXTENSION_MAPPING for the extension otherwise the files are not
# properly processed by doxygen.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
909

910
FILTER_PATTERNS = 
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
911
912

# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
913
914
915
# INPUT_FILTER) will also be used to filter the input files that are used for
# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
# The default value is: NO.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
916

917
FILTER_SOURCE_FILES = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
918
919

# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
920
921
922
923
924
# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
# it is also possible to disable source filtering for a specific pattern using
# *.ext= (so without naming a filter).
# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.

925
FILTER_SOURCE_PATTERNS = 
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
926

927
928
929
930
931
# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
# is part of the input, its contents will be placed on the main page
# (index.html). This can be useful if you have a project on for instance GitHub
# and want to reuse the introduction page also for the doxygen output.

932
USE_MDFILE_AS_MAINPAGE = 
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
933
934

#---------------------------------------------------------------------------
935
# Configuration options related to source browsing
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
936
937
#---------------------------------------------------------------------------

938
939
940
941
942
943
# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
# generated. Documented entities will be cross-referenced with these sources.
#
# Note: To get rid of all source code in the generated output, make sure that
# also VERBATIM_HEADERS is set to NO.
# The default value is: NO.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
944

945
SOURCE_BROWSER = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
946

947
948
949
# Setting the INLINE_SOURCES tag to YES will include the body of functions,
# classes and enums directly into the documentation.
# The default value is: NO.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
950

951
INLINE_SOURCES = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
952

953
954
955
956
# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
# special comment blocks from generated source code fragments. Normal C, C++ and
# Fortran comments will always remain visible.
# The default value is: YES.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
957

958
STRIP_CODE_COMMENTS = YES
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
959

960
961
962
# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
# function all documented functions referencing it will be listed.
# The default value is: NO.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
963
964
965

REFERENCED_BY_RELATION = NO

966
967
968
# If the REFERENCES_RELATION tag is set to YES then for each documented function
# all documented entities called/used by that function will be listed.
# The default value is: NO.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
969

970
REFERENCES_RELATION = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
971

972
973
974
975
976
# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
# to YES then the hyperlinks from functions in REFERENCES_RELATION and
# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
# link to the documentation.
# The default value is: YES.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
977
978
979

REFERENCES_LINK_SOURCE = YES

980
981
982
983
984
985
986
987
# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
# source code will show a tooltip with additional information such as prototype,
# brief description and links to the definition and documentation. Since this
# will make the HTML file larger and loading of large files a bit slower, you
# can opt to disable this feature.
# The default value is: YES.
# This tag requires that the tag SOURCE_BROWSER is set to YES.

988
SOURCE_TOOLTIPS = YES
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008

# If the USE_HTAGS tag is set to YES then the references to source code will
# point to the HTML generated by the htags(1) tool instead of doxygen built-in
# source browser. The htags tool is part of GNU's global source tagging system
# (see http://www.gnu.org/software/global/global.html). You will need version
# 4.8.6 or higher.
#
# To use it do the following:
# - Install the latest version of global
# - Enable SOURCE_BROWSER and USE_HTAGS in the config file
# - Make sure the INPUT points to the root of the source tree
# - Run doxygen as normal
#
# Doxygen will invoke htags (and that will in turn invoke gtags), so these
# tools must be available from the command line (i.e. in the search path).
#
# The result: instead of the source browser generated by doxygen, the links to
# source code will now point to the output of htags.
# The default value is: NO.
# This tag requires that the tag SOURCE_BROWSER is set to YES.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
1009

1010
USE_HTAGS = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
1011

1012
1013
1014
1015
1016
# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
# verbatim copy of the header file for each class for which an include is
# specified. Set to NO to disable this.
# See also: Section \class.
# The default value is: YES.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
1017

1018
VERBATIM_HEADERS = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
1019
1020

#---------------------------------------------------------------------------
1021
# Configuration options related to the alphabetical class index
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
1022
1023
#---------------------------------------------------------------------------

1024
1025
1026
1027
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
# compounds will be generated. Enable this if the project contains a lot of
# classes, structs, unions or interfaces.
# The default value is: YES.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
1028

1029
ALPHABETICAL_INDEX = YES
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
1030

1031
1032
1033
1034
# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
# which the alphabetical index list will be split.
# Minimum value: 1, maximum value: 20, default value: 5.
# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
1035

1036
COLS_IN_ALPHA_INDEX = 5
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
1037

1038
1039
1040
1041
1042
# In case all classes in a project start with a common prefix, all classes will
# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
# can be used to specify a prefix (or a list of prefixes) that should be ignored
# while generating the index headers.
# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
1043

1044
IGNORE_PREFIX = 
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
1045
1046

#---------------------------------------------------------------------------
1047
# Configuration options related to the HTML output
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
1048
1049
#---------------------------------------------------------------------------

1050
1051
# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
# The default value is: YES.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
1052

1053
GENERATE_HTML = YES
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
1054

1055
1056
1057
1058
1059
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
# it.
# The default directory is: html.
# This tag requires that the tag GENERATE_HTML is set to YES.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
1060

1061
HTML_OUTPUT = html
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
1062

1063
1064
1065
1066
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
# generated HTML page (for example: .htm, .php, .asp).
# The default value is: .html.
# This tag requires that the tag GENERATE_HTML is set to YES.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
1067

1068
HTML_FILE_EXTENSION = .html
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
1069

1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
# each generated HTML page. If the tag is left blank doxygen will generate a
# standard header.
#
# To get valid HTML the header file that includes any scripts and style sheets
# that doxygen needs, which is dependent on the configuration options used (e.g.
# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
# default header using
# doxygen -w html new_header.html new_footer.html new_stylesheet.css
# YourConfigFile
# and then modify the file new_header.html. See also section "Doxygen usage"
# for information on how to generate the default header that doxygen normally
# uses.
# Note: The header is subject to change so you typically have to regenerate the
# default header when upgrading to a newer version of doxygen. For a description
# of the possible markers and block names see the documentation.
# This tag requires that the tag GENERATE_HTML is set to YES.

1088
HTML_HEADER = ../partons/doc/style/customheader.html
1089
1090
1091
1092
1093
1094
1095
1096
1097

# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
# generated HTML page. If the tag is left blank doxygen will generate a standard
# footer. See HTML_HEADER for more information on how to generate a default
# footer and what special commands can be used inside the footer. See also
# section "Doxygen usage" for information on how to generate the default footer
# that doxygen normally uses.
# This tag requires that the tag GENERATE_HTML is set to YES.

1098
HTML_FOOTER = ../partons/doc/style/customfooter.html
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109

# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
# sheet that is used by each HTML page. It can be used to fine-tune the look of
# the HTML output. If left blank doxygen will generate a default style sheet.
# See also section "Doxygen usage" for information on how to generate the style
# sheet that doxygen normally uses.
# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
# it is more robust and this tag (HTML_STYLESHEET) will in the future become
# obsolete.
# This tag requires that the tag GENERATE_HTML is set to YES.

1110
HTML_STYLESHEET = 
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122

# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
# cascading style sheets that are included after the standard style sheets
# created by doxygen. Using this option one can overrule certain style aspects.
# This is preferred over using HTML_STYLESHEET since it does not replace the
# standard style sheet and is therefore more robust against future updates.
# Doxygen will copy the style sheet files to the output directory.
# Note: The order of the extra style sheet files is of importance (e.g. the last
# style sheet in the list overrules the setting of the previous ones in the
# list). For an example see the documentation.
# This tag requires that the tag GENERATE_HTML is set to YES.

1123
HTML_EXTRA_STYLESHEET = ../partons/doc/style/customdoxygen.css ../partons/doc/style/customtabs.css
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
1124
1125
1126
1127

# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
# other source files which should be copied to the HTML output directory. Note
# that these files will be copied to the base HTML output directory. Use the
1128
1129
1130
1131
1132
# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
# files will be copied as-is; there are no commands or markers available.
# This tag requires that the tag GENERATE_HTML is set to YES.

1133
HTML_EXTRA_FILES = ../partons/doc/images/icon_partons.ico
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143

# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
# will adjust the colors in the style sheet and background images according to
# this color. Hue is specified as an angle on a colorwheel, see
# http://en.wikipedia.org/wiki/Hue for more information. For instance the value
# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
# purple, and 360 is red again.
# Minimum value: 0, maximum value: 359, default value: 220.
# This tag requires that the tag GENERATE_HTML is set to YES.

1144
HTML_COLORSTYLE_HUE = 220
1145
1146
1147
1148
1149
1150
1151

# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
# in the HTML output. For a value of 0 the output will use grayscales only. A
# value of 255 will produce the most vivid colors.
# Minimum value: 0, maximum value: 255, default value: 100.
# This tag requires that the tag GENERATE_HTML is set to YES.

1152
HTML_COLORSTYLE_SAT = 100
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162

# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
# luminance component of the colors in the HTML output. Values below 100
# gradually make the output lighter, whereas values above 100 make the output
# darker. The value divided by 100 is the actual gamma applied, so 80 represents
# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
# change the gamma.
# Minimum value: 40, maximum value: 240, default value: 80.
# This tag requires that the tag GENERATE_HTML is set to YES.

1163
HTML_COLORSTYLE_GAMMA = 80
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
1164
1165

# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1166
1167
1168
1169
1170
# page will contain the date and time when the page was generated. Setting this
# to YES can help to show when doxygen was last run and thus if the
# documentation is up to date.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
1171

1172
HTML_TIMESTAMP = YES
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
1173
1174
1175
1176

# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
# documentation will contain sections that can be hidden and shown after the
# page has loaded.
1177
1178
1179
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.

1180
HTML_DYNAMIC_SECTIONS = NO
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191

# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
# shown in the various tree structured indices initially; the user can expand
# and collapse entries dynamically later on. Doxygen will expand the tree to
# such a level that at most the specified number of entries are visible (unless
# a fully collapsed tree already exceeds this amount). So setting the number of
# entries 1 will produce a full collapsed tree by default. 0 is a special value
# representing an infinite number of entries and will result in a full expanded
# tree by default.
# Minimum value: 0, maximum value: 9999, default value: 100.
# This tag requires that the tag GENERATE_HTML is set to YES.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
1192
1193
1194

HTML_INDEX_NUM_ENTRIES = 100

1195
1196
1197
1198
1199
1200
1201
1202
# If the GENERATE_DOCSET tag is set to YES, additional index files will be
# generated that can be used as input for Apple's Xcode 3 integrated development
# environment (see: http://developer.apple.com/tools/xcode/), introduced with
# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
# Makefile in the HTML output directory. Running make will produce the docset in
# that directory and running make install will install the docset in
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
1203
# for more information.
1204
1205
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
1206

1207
GENERATE_DOCSET = NO
Nabil Chouika's avatar
refs#16  
Nabil Chouika committed
1208