]> vaikene.ee Git - evaf/blob - doc/Doxyfile
Warning fixes and copyright update.
[evaf] / doc / Doxyfile
1 # Doxyfile 1.5.8
2
3 # This file describes the settings to be used by the documentation system
4 # doxygen (www.doxygen.org) for a project
5 #
6 # All text after a hash (#) is considered a comment and will be ignored
7 # The format is:
8 # TAG = value [value, ...]
9 # For lists items can also be appended using:
10 # TAG += value [value, ...]
11 # Values that contain spaces should be placed between quotes (" ")
12
13 #---------------------------------------------------------------------------
14 # Project related configuration options
15 #---------------------------------------------------------------------------
16
17 # This tag specifies the encoding used for all characters in the config file
18 # that follow. The default is UTF-8 which is also the encoding used for all
19 # text before the first occurrence of this tag. Doxygen uses libiconv (or the
20 # iconv built into libc) for the transcoding. See
21 # http://www.gnu.org/software/libiconv for the list of possible encodings.
22
23 DOXYFILE_ENCODING = UTF-8
24
25 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
26 # by quotes) that should identify the project.
27
28 PROJECT_NAME = eVaf
29
30 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
31 # This could be handy for archiving the generated documentation or
32 # if some version control system is used.
33
34 PROJECT_NUMBER =
35
36 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
37 # base path where the generated documentation will be put.
38 # If a relative path is entered, it will be relative to the location
39 # where doxygen was started. If left blank the current directory will be used.
40
41 OUTPUT_DIRECTORY = ./
42
43 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
44 # 4096 sub-directories (in 2 levels) under the output directory of each output
45 # format and will distribute the generated files over these directories.
46 # Enabling this option can be useful when feeding doxygen a huge amount of
47 # source files, where putting all generated files in the same directory would
48 # otherwise cause performance problems for the file system.
49
50 CREATE_SUBDIRS = NO
51
52 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
53 # documentation generated by doxygen is written. Doxygen will use this
54 # information to generate all constant output in the proper language.
55 # The default language is English, other supported languages are:
56 # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
57 # Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek,
58 # Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages),
59 # Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish,
60 # Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak, Slovene,
61 # Spanish, Swedish, and Ukrainian.
62
63 OUTPUT_LANGUAGE = English
64
65 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
66 # include brief member descriptions after the members that are listed in
67 # the file and class documentation (similar to JavaDoc).
68 # Set to NO to disable this.
69
70 BRIEF_MEMBER_DESC = YES
71
72 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
73 # the brief description of a member or function before the detailed description.
74 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
75 # brief descriptions will be completely suppressed.
76
77 REPEAT_BRIEF = YES
78
79 # This tag implements a quasi-intelligent brief description abbreviator
80 # that is used to form the text in various listings. Each string
81 # in this list, if found as the leading text of the brief description, will be
82 # stripped from the text and the result after processing the whole list, is
83 # used as the annotated text. Otherwise, the brief description is used as-is.
84 # If left blank, the following values are used ("$name" is automatically
85 # replaced with the name of the entity): "The $name class" "The $name widget"
86 # "The $name file" "is" "provides" "specifies" "contains"
87 # "represents" "a" "an" "the"
88
89 ABBREVIATE_BRIEF = "The $name class" \
90 "The $name widget" \
91 "The $name file" \
92 is \
93 provides \
94 specifies \
95 contains \
96 represents \
97 a \
98 an \
99 the
100
101 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
102 # Doxygen will generate a detailed section even if there is only a brief
103 # description.
104
105 ALWAYS_DETAILED_SEC = NO
106
107 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
108 # inherited members of a class in the documentation of that class as if those
109 # members were ordinary class members. Constructors, destructors and assignment
110 # operators of the base classes will not be shown.
111
112 INLINE_INHERITED_MEMB = NO
113
114 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
115 # path before files name in the file list and in the header files. If set
116 # to NO the shortest path that makes the file name unique will be used.
117
118 FULL_PATH_NAMES = YES
119
120 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
121 # can be used to strip a user-defined part of the path. Stripping is
122 # only done if one of the specified strings matches the left-hand part of
123 # the path. The tag can be used to show relative paths in the file list.
124 # If left blank the directory from which doxygen is run is used as the
125 # path to strip.
126
127 STRIP_FROM_PATH = ../src
128
129 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
130 # the path mentioned in the documentation of a class, which tells
131 # the reader which header file to include in order to use a class.
132 # If left blank only the name of the header file containing the class
133 # definition is used. Otherwise one should specify the include paths that
134 # are normally passed to the compiler using the -I flag.
135
136 STRIP_FROM_INC_PATH = ../src/libs \
137 ../src/plugins
138
139 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
140 # (but less readable) file names. This can be useful is your file systems
141 # doesn't support long names like on DOS, Mac, or CD-ROM.
142
143 SHORT_NAMES = NO
144
145 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
146 # will interpret the first line (until the first dot) of a JavaDoc-style
147 # comment as the brief description. If set to NO, the JavaDoc
148 # comments will behave just like regular Qt-style comments
149 # (thus requiring an explicit @brief command for a brief description.)
150
151 JAVADOC_AUTOBRIEF = YES
152
153 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
154 # interpret the first line (until the first dot) of a Qt-style
155 # comment as the brief description. If set to NO, the comments
156 # will behave just like regular Qt-style comments (thus requiring
157 # an explicit \brief command for a brief description.)
158
159 QT_AUTOBRIEF = YES
160
161 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
162 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
163 # comments) as a brief description. This used to be the default behaviour.
164 # The new default is to treat a multi-line C++ comment block as a detailed
165 # description. Set this tag to YES if you prefer the old behaviour instead.
166
167 MULTILINE_CPP_IS_BRIEF = YES
168
169 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
170 # member inherits the documentation from any documented member that it
171 # re-implements.
172
173 INHERIT_DOCS = YES
174
175 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
176 # a new page for each member. If set to NO, the documentation of a member will
177 # be part of the file/class/namespace that contains it.
178
179 SEPARATE_MEMBER_PAGES = NO
180
181 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
182 # Doxygen uses this value to replace tabs by spaces in code fragments.
183
184 TAB_SIZE = 8
185
186 # This tag can be used to specify a number of aliases that acts
187 # as commands in the documentation. An alias has the form "name=value".
188 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
189 # put the command \sideeffect (or @sideeffect) in the documentation, which
190 # will result in a user-defined paragraph with heading "Side Effects:".
191 # You can put \n's in the value part of an alias to insert newlines.
192
193 ALIASES =
194
195 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
196 # sources only. Doxygen will then generate output that is more tailored for C.
197 # For instance, some of the names that are used will be different. The list
198 # of all members will be omitted, etc.
199
200 OPTIMIZE_OUTPUT_FOR_C = NO
201
202 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
203 # sources only. Doxygen will then generate output that is more tailored for
204 # Java. For instance, namespaces will be presented as packages, qualified
205 # scopes will look different, etc.
206
207 OPTIMIZE_OUTPUT_JAVA = NO
208
209 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
210 # sources only. Doxygen will then generate output that is more tailored for
211 # Fortran.
212
213 OPTIMIZE_FOR_FORTRAN = NO
214
215 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
216 # sources. Doxygen will then generate output that is tailored for
217 # VHDL.
218
219 OPTIMIZE_OUTPUT_VHDL = NO
220
221 # Doxygen selects the parser to use depending on the extension of the files it parses.
222 # With this tag you can assign which parser to use for a given extension.
223 # Doxygen has a built-in mapping, but you can override or extend it using this tag.
224 # The format is ext=language, where ext is a file extension, and language is one of
225 # the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP,
226 # Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat
227 # .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran),
228 # use: inc=Fortran f=C
229
230 EXTENSION_MAPPING =
231
232 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
233 # to include (a tag file for) the STL sources as input, then you should
234 # set this tag to YES in order to let doxygen match functions declarations and
235 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
236 # func(std::string) {}). This also make the inheritance and collaboration
237 # diagrams that involve STL classes more complete and accurate.
238
239 BUILTIN_STL_SUPPORT = NO
240
241 # If you use Microsoft's C++/CLI language, you should set this option to YES to
242 # enable parsing support.
243
244 CPP_CLI_SUPPORT = NO
245
246 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
247 # Doxygen will parse them like normal C++ but will assume all classes use public
248 # instead of private inheritance when no explicit protection keyword is present.
249
250 SIP_SUPPORT = NO
251
252 # For Microsoft's IDL there are propget and propput attributes to indicate getter
253 # and setter methods for a property. Setting this option to YES (the default)
254 # will make doxygen to replace the get and set methods by a property in the
255 # documentation. This will only work if the methods are indeed getting or
256 # setting a simple type. If this is not the case, or you want to show the
257 # methods anyway, you should set this option to NO.
258
259 IDL_PROPERTY_SUPPORT = YES
260
261 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
262 # tag is set to YES, then doxygen will reuse the documentation of the first
263 # member in the group (if any) for the other members of the group. By default
264 # all members of a group must be documented explicitly.
265
266 DISTRIBUTE_GROUP_DOC = NO
267
268 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
269 # the same type (for instance a group of public functions) to be put as a
270 # subgroup of that type (e.g. under the Public Functions section). Set it to
271 # NO to prevent subgrouping. Alternatively, this can be done per class using
272 # the \nosubgrouping command.
273
274 SUBGROUPING = YES
275
276 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
277 # is documented as struct, union, or enum with the name of the typedef. So
278 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
279 # with name TypeT. When disabled the typedef will appear as a member of a file,
280 # namespace, or class. And the struct will be named TypeS. This can typically
281 # be useful for C code in case the coding convention dictates that all compound
282 # types are typedef'ed and only the typedef is referenced, never the tag name.
283
284 TYPEDEF_HIDES_STRUCT = NO
285
286 # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
287 # determine which symbols to keep in memory and which to flush to disk.
288 # When the cache is full, less often used symbols will be written to disk.
289 # For small to medium size projects (<1000 input files) the default value is
290 # probably good enough. For larger projects a too small cache size can cause
291 # doxygen to be busy swapping symbols to and from disk most of the time
292 # causing a significant performance penality.
293 # If the system has enough physical memory increasing the cache will improve the
294 # performance by keeping more symbols in memory. Note that the value works on
295 # a logarithmic scale so increasing the size by one will rougly double the
296 # memory usage. The cache size is given by this formula:
297 # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
298 # corresponding to a cache size of 2^16 = 65536 symbols
299
300 SYMBOL_CACHE_SIZE = 0
301
302 #---------------------------------------------------------------------------
303 # Build related configuration options
304 #---------------------------------------------------------------------------
305
306 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
307 # documentation are documented, even if no documentation was available.
308 # Private class members and static file members will be hidden unless
309 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
310
311 EXTRACT_ALL = YES
312
313 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
314 # will be included in the documentation.
315
316 EXTRACT_PRIVATE = NO
317
318 # If the EXTRACT_STATIC tag is set to YES all static members of a file
319 # will be included in the documentation.
320
321 EXTRACT_STATIC = YES
322
323 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
324 # defined locally in source files will be included in the documentation.
325 # If set to NO only classes defined in header files are included.
326
327 EXTRACT_LOCAL_CLASSES = NO
328
329 # This flag is only useful for Objective-C code. When set to YES local
330 # methods, which are defined in the implementation section but not in
331 # the interface are included in the documentation.
332 # If set to NO (the default) only methods in the interface are included.
333
334 EXTRACT_LOCAL_METHODS = NO
335
336 # If this flag is set to YES, the members of anonymous namespaces will be
337 # extracted and appear in the documentation as a namespace called
338 # 'anonymous_namespace{file}', where file will be replaced with the base
339 # name of the file that contains the anonymous namespace. By default
340 # anonymous namespace are hidden.
341
342 EXTRACT_ANON_NSPACES = NO
343
344 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
345 # undocumented members of documented classes, files or namespaces.
346 # If set to NO (the default) these members will be included in the
347 # various overviews, but no documentation section is generated.
348 # This option has no effect if EXTRACT_ALL is enabled.
349
350 HIDE_UNDOC_MEMBERS = NO
351
352 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
353 # undocumented classes that are normally visible in the class hierarchy.
354 # If set to NO (the default) these classes will be included in the various
355 # overviews. This option has no effect if EXTRACT_ALL is enabled.
356
357 HIDE_UNDOC_CLASSES = NO
358
359 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
360 # friend (class|struct|union) declarations.
361 # If set to NO (the default) these declarations will be included in the
362 # documentation.
363
364 HIDE_FRIEND_COMPOUNDS = YES
365
366 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
367 # documentation blocks found inside the body of a function.
368 # If set to NO (the default) these blocks will be appended to the
369 # function's detailed documentation block.
370
371 HIDE_IN_BODY_DOCS = NO
372
373 # The INTERNAL_DOCS tag determines if documentation
374 # that is typed after a \internal command is included. If the tag is set
375 # to NO (the default) then the documentation will be excluded.
376 # Set it to YES to include the internal documentation.
377
378 INTERNAL_DOCS = YES
379
380 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
381 # file names in lower-case letters. If set to YES upper-case letters are also
382 # allowed. This is useful if you have classes or files whose names only differ
383 # in case and if your file system supports case sensitive file names. Windows
384 # and Mac users are advised to set this option to NO.
385
386 CASE_SENSE_NAMES = YES
387
388 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
389 # will show members with their full class and namespace scopes in the
390 # documentation. If set to YES the scope will be hidden.
391
392 HIDE_SCOPE_NAMES = NO
393
394 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
395 # will put a list of the files that are included by a file in the documentation
396 # of that file.
397
398 SHOW_INCLUDE_FILES = YES
399
400 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
401 # is inserted in the documentation for inline members.
402
403 INLINE_INFO = YES
404
405 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
406 # will sort the (detailed) documentation of file and class members
407 # alphabetically by member name. If set to NO the members will appear in
408 # declaration order.
409
410 SORT_MEMBER_DOCS = YES
411
412 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
413 # brief documentation of file, namespace and class members alphabetically
414 # by member name. If set to NO (the default) the members will appear in
415 # declaration order.
416
417 SORT_BRIEF_DOCS = YES
418
419 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
420 # hierarchy of group names into alphabetical order. If set to NO (the default)
421 # the group names will appear in their defined order.
422
423 SORT_GROUP_NAMES = NO
424
425 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
426 # sorted by fully-qualified names, including namespaces. If set to
427 # NO (the default), the class list will be sorted only by class name,
428 # not including the namespace part.
429 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
430 # Note: This option applies only to the class list, not to the
431 # alphabetical list.
432
433 SORT_BY_SCOPE_NAME = NO
434
435 # The GENERATE_TODOLIST tag can be used to enable (YES) or
436 # disable (NO) the todo list. This list is created by putting \todo
437 # commands in the documentation.
438
439 GENERATE_TODOLIST = YES
440
441 # The GENERATE_TESTLIST tag can be used to enable (YES) or
442 # disable (NO) the test list. This list is created by putting \test
443 # commands in the documentation.
444
445 GENERATE_TESTLIST = YES
446
447 # The GENERATE_BUGLIST tag can be used to enable (YES) or
448 # disable (NO) the bug list. This list is created by putting \bug
449 # commands in the documentation.
450
451 GENERATE_BUGLIST = YES
452
453 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
454 # disable (NO) the deprecated list. This list is created by putting
455 # \deprecated commands in the documentation.
456
457 GENERATE_DEPRECATEDLIST= YES
458
459 # The ENABLED_SECTIONS tag can be used to enable conditional
460 # documentation sections, marked by \if sectionname ... \endif.
461
462 ENABLED_SECTIONS =
463
464 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
465 # the initial value of a variable or define consists of for it to appear in
466 # the documentation. If the initializer consists of more lines than specified
467 # here it will be hidden. Use a value of 0 to hide initializers completely.
468 # The appearance of the initializer of individual variables and defines in the
469 # documentation can be controlled using \showinitializer or \hideinitializer
470 # command in the documentation regardless of this setting.
471
472 MAX_INITIALIZER_LINES = 30
473
474 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
475 # at the bottom of the documentation of classes and structs. If set to YES the
476 # list will mention the files that were used to generate the documentation.
477
478 SHOW_USED_FILES = YES
479
480 # If the sources in your project are distributed over multiple directories
481 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
482 # in the documentation. The default is NO.
483
484 SHOW_DIRECTORIES = YES
485
486 # Set the SHOW_FILES tag to NO to disable the generation of the Files page.
487 # This will remove the Files entry from the Quick Index and from the
488 # Folder Tree View (if specified). The default is YES.
489
490 SHOW_FILES = YES
491
492 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the
493 # Namespaces page.
494 # This will remove the Namespaces entry from the Quick Index
495 # and from the Folder Tree View (if specified). The default is YES.
496
497 SHOW_NAMESPACES = YES
498
499 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
500 # doxygen should invoke to get the current version for each file (typically from
501 # the version control system). Doxygen will invoke the program by executing (via
502 # popen()) the command <command> <input-file>, where <command> is the value of
503 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
504 # provided by doxygen. Whatever the program writes to standard output
505 # is used as the file version. See the manual for examples.
506
507 FILE_VERSION_FILTER =
508
509 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by
510 # doxygen. The layout file controls the global structure of the generated output files
511 # in an output format independent way. The create the layout file that represents
512 # doxygen's defaults, run doxygen with the -l option. You can optionally specify a
513 # file name after the option, if omitted DoxygenLayout.xml will be used as the name
514 # of the layout file.
515
516 LAYOUT_FILE =
517
518 #---------------------------------------------------------------------------
519 # configuration options related to warning and progress messages
520 #---------------------------------------------------------------------------
521
522 # The QUIET tag can be used to turn on/off the messages that are generated
523 # by doxygen. Possible values are YES and NO. If left blank NO is used.
524
525 QUIET = NO
526
527 # The WARNINGS tag can be used to turn on/off the warning messages that are
528 # generated by doxygen. Possible values are YES and NO. If left blank
529 # NO is used.
530
531 WARNINGS = YES
532
533 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
534 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
535 # automatically be disabled.
536
537 WARN_IF_UNDOCUMENTED = YES
538
539 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
540 # potential errors in the documentation, such as not documenting some
541 # parameters in a documented function, or documenting parameters that
542 # don't exist or using markup commands wrongly.
543
544 WARN_IF_DOC_ERROR = YES
545
546 # This WARN_NO_PARAMDOC option can be abled to get warnings for
547 # functions that are documented, but have no documentation for their parameters
548 # or return value. If set to NO (the default) doxygen will only warn about
549 # wrong or incomplete parameter documentation, but not about the absence of
550 # documentation.
551
552 WARN_NO_PARAMDOC = YES
553
554 # The WARN_FORMAT tag determines the format of the warning messages that
555 # doxygen can produce. The string should contain the $file, $line, and $text
556 # tags, which will be replaced by the file and line number from which the
557 # warning originated and the warning text. Optionally the format may contain
558 # $version, which will be replaced by the version of the file (if it could
559 # be obtained via FILE_VERSION_FILTER)
560
561 WARN_FORMAT = "$file:$line: $text"
562
563 # The WARN_LOGFILE tag can be used to specify a file to which warning
564 # and error messages should be written. If left blank the output is written
565 # to stderr.
566
567 WARN_LOGFILE =
568
569 #---------------------------------------------------------------------------
570 # configuration options related to the input files
571 #---------------------------------------------------------------------------
572
573 # The INPUT tag can be used to specify the files and/or directories that contain
574 # documented source files. You may enter file names like "myfile.cpp" or
575 # directories like "/usr/src/myproject". Separate the files or directories
576 # with spaces.
577
578 INPUT = ../src/
579
580 # This tag can be used to specify the character encoding of the source files
581 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
582 # also the default input encoding. Doxygen uses libiconv (or the iconv built
583 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
584 # the list of possible encodings.
585
586 INPUT_ENCODING = UTF-8
587
588 # If the value of the INPUT tag contains directories, you can use the
589 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
590 # and *.h) to filter out the source-files in the directories. If left
591 # blank the following patterns are tested:
592 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
593 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
594
595 FILE_PATTERNS = *.h
596
597 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
598 # should be searched for input files as well. Possible values are YES and NO.
599 # If left blank NO is used.
600
601 RECURSIVE = YES
602
603 # The EXCLUDE tag can be used to specify files and/or directories that should
604 # excluded from the INPUT source files. This way you can easily exclude a
605 # subdirectory from a directory tree whose root is specified with the INPUT tag.
606
607 EXCLUDE =
608
609 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
610 # directories that are symbolic links (a Unix filesystem feature) are excluded
611 # from the input.
612
613 EXCLUDE_SYMLINKS = NO
614
615 # If the value of the INPUT tag contains directories, you can use the
616 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
617 # certain files from those directories. Note that the wildcards are matched
618 # against the file with absolute path, so to exclude all test directories
619 # for example use the pattern */test/*
620
621 EXCLUDE_PATTERNS = moc_*
622
623 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
624 # (namespaces, classes, functions, etc.) that should be excluded from the
625 # output. The symbol name can be a fully qualified name, a word, or if the
626 # wildcard * is used, a substring. Examples: ANamespace, AClass,
627 # AClass::ANamespace, ANamespace::*Test
628
629 EXCLUDE_SYMBOLS =
630
631 # The EXAMPLE_PATH tag can be used to specify one or more files or
632 # directories that contain example code fragments that are included (see
633 # the \include command).
634
635 EXAMPLE_PATH =
636
637 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
638 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
639 # and *.h) to filter out the source-files in the directories. If left
640 # blank all files are included.
641
642 EXAMPLE_PATTERNS = *
643
644 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
645 # searched for input files to be used with the \include or \dontinclude
646 # commands irrespective of the value of the RECURSIVE tag.
647 # Possible values are YES and NO. If left blank NO is used.
648
649 EXAMPLE_RECURSIVE = NO
650
651 # The IMAGE_PATH tag can be used to specify one or more files or
652 # directories that contain image that are included in the documentation (see
653 # the \image command).
654
655 IMAGE_PATH =
656
657 # The INPUT_FILTER tag can be used to specify a program that doxygen should
658 # invoke to filter for each input file. Doxygen will invoke the filter program
659 # by executing (via popen()) the command <filter> <input-file>, where <filter>
660 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
661 # input file. Doxygen will then use the output that the filter program writes
662 # to standard output.
663 # If FILTER_PATTERNS is specified, this tag will be
664 # ignored.
665
666 INPUT_FILTER =
667
668 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
669 # basis.
670 # Doxygen will compare the file name with each pattern and apply the
671 # filter if there is a match.
672 # The filters are a list of the form:
673 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
674 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
675 # is applied to all files.
676
677 FILTER_PATTERNS =
678
679 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
680 # INPUT_FILTER) will be used to filter the input files when producing source
681 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
682
683 FILTER_SOURCE_FILES = NO
684
685 #---------------------------------------------------------------------------
686 # configuration options related to source browsing
687 #---------------------------------------------------------------------------
688
689 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
690 # be generated. Documented entities will be cross-referenced with these sources.
691 # Note: To get rid of all source code in the generated output, make sure also
692 # VERBATIM_HEADERS is set to NO.
693
694 SOURCE_BROWSER = YES
695
696 # Setting the INLINE_SOURCES tag to YES will include the body
697 # of functions and classes directly in the documentation.
698
699 INLINE_SOURCES = NO
700
701 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
702 # doxygen to hide any special comment blocks from generated source code
703 # fragments. Normal C and C++ comments will always remain visible.
704
705 STRIP_CODE_COMMENTS = YES
706
707 # If the REFERENCED_BY_RELATION tag is set to YES
708 # then for each documented function all documented
709 # functions referencing it will be listed.
710
711 REFERENCED_BY_RELATION = NO
712
713 # If the REFERENCES_RELATION tag is set to YES
714 # then for each documented function all documented entities
715 # called/used by that function will be listed.
716
717 REFERENCES_RELATION = NO
718
719 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
720 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
721 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
722 # link to the source code.
723 # Otherwise they will link to the documentation.
724
725 REFERENCES_LINK_SOURCE = YES
726
727 # If the USE_HTAGS tag is set to YES then the references to source code
728 # will point to the HTML generated by the htags(1) tool instead of doxygen
729 # built-in source browser. The htags tool is part of GNU's global source
730 # tagging system (see http://www.gnu.org/software/global/global.html). You
731 # will need version 4.8.6 or higher.
732
733 USE_HTAGS = NO
734
735 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
736 # will generate a verbatim copy of the header file for each class for
737 # which an include is specified. Set to NO to disable this.
738
739 VERBATIM_HEADERS = NO
740
741 #---------------------------------------------------------------------------
742 # configuration options related to the alphabetical class index
743 #---------------------------------------------------------------------------
744
745 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
746 # of all compounds will be generated. Enable this if the project
747 # contains a lot of classes, structs, unions or interfaces.
748
749 ALPHABETICAL_INDEX = YES
750
751 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
752 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
753 # in which this list will be split (can be a number in the range [1..20])
754
755 COLS_IN_ALPHA_INDEX = 5
756
757 # In case all classes in a project start with a common prefix, all
758 # classes will be put under the same header in the alphabetical index.
759 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
760 # should be ignored while generating the index headers.
761
762 IGNORE_PREFIX = R \
763 i
764
765 #---------------------------------------------------------------------------
766 # configuration options related to the HTML output
767 #---------------------------------------------------------------------------
768
769 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
770 # generate HTML output.
771
772 GENERATE_HTML = YES
773
774 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
775 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
776 # put in front of it. If left blank `html' will be used as the default path.
777
778 HTML_OUTPUT = html
779
780 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
781 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
782 # doxygen will generate files with .html extension.
783
784 HTML_FILE_EXTENSION = .html
785
786 # The HTML_HEADER tag can be used to specify a personal HTML header for
787 # each generated HTML page. If it is left blank doxygen will generate a
788 # standard header.
789
790 HTML_HEADER =
791
792 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
793 # each generated HTML page. If it is left blank doxygen will generate a
794 # standard footer.
795
796 HTML_FOOTER =
797
798 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
799 # style sheet that is used by each HTML page. It can be used to
800 # fine-tune the look of the HTML output. If the tag is left blank doxygen
801 # will generate a default style sheet. Note that doxygen will try to copy
802 # the style sheet file to the HTML output directory, so don't put your own
803 # stylesheet in the HTML output directory as well, or it will be erased!
804
805 HTML_STYLESHEET =
806
807 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
808 # files or namespaces will be aligned in HTML using tables. If set to
809 # NO a bullet list will be used.
810
811 HTML_ALIGN_MEMBERS = YES
812
813 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
814 # documentation will contain sections that can be hidden and shown after the
815 # page has loaded. For this to work a browser that supports
816 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
817 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
818
819 HTML_DYNAMIC_SECTIONS = NO
820
821 # If the GENERATE_DOCSET tag is set to YES, additional index files
822 # will be generated that can be used as input for Apple's Xcode 3
823 # integrated development environment, introduced with OSX 10.5 (Leopard).
824 # To create a documentation set, doxygen will generate a Makefile in the
825 # HTML output directory. Running make will produce the docset in that
826 # directory and running "make install" will install the docset in
827 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
828 # it at startup.
829 # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.
830
831 GENERATE_DOCSET = NO
832
833 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
834 # feed. A documentation feed provides an umbrella under which multiple
835 # documentation sets from a single provider (such as a company or product suite)
836 # can be grouped.
837
838 DOCSET_FEEDNAME = "Doxygen generated docs"
839
840 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
841 # should uniquely identify the documentation set bundle. This should be a
842 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
843 # will append .docset to the name.
844
845 DOCSET_BUNDLE_ID = org.doxygen.Project
846
847 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
848 # will be generated that can be used as input for tools like the
849 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
850 # of the generated HTML documentation.
851
852 GENERATE_HTMLHELP = NO
853
854 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
855 # be used to specify the file name of the resulting .chm file. You
856 # can add a path in front of the file if the result should not be
857 # written to the html output directory.
858
859 CHM_FILE =
860
861 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
862 # be used to specify the location (absolute path including file name) of
863 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
864 # the HTML help compiler on the generated index.hhp.
865
866 HHC_LOCATION =
867
868 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
869 # controls if a separate .chi index file is generated (YES) or that
870 # it should be included in the master .chm file (NO).
871
872 GENERATE_CHI = NO
873
874 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
875 # is used to encode HtmlHelp index (hhk), content (hhc) and project file
876 # content.
877
878 CHM_INDEX_ENCODING =
879
880 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
881 # controls whether a binary table of contents is generated (YES) or a
882 # normal table of contents (NO) in the .chm file.
883
884 BINARY_TOC = NO
885
886 # The TOC_EXPAND flag can be set to YES to add extra items for group members
887 # to the contents of the HTML help documentation and to the tree view.
888
889 TOC_EXPAND = YES
890
891 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER
892 # are set, an additional index file will be generated that can be used as input for
893 # Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated
894 # HTML documentation.
895
896 GENERATE_QHP = NO
897
898 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can
899 # be used to specify the file name of the resulting .qch file.
900 # The path specified is relative to the HTML output folder.
901
902 QCH_FILE = evaf.qch
903
904 # The QHP_NAMESPACE tag specifies the namespace to use when generating
905 # Qt Help Project output. For more information please see
906 # http://doc.trolltech.com/qthelpproject.html#namespace
907
908 QHP_NAMESPACE = net.vaikene.evaf
909
910 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
911 # Qt Help Project output. For more information please see
912 # http://doc.trolltech.com/qthelpproject.html#virtual-folders
913
914 QHP_VIRTUAL_FOLDER = doc
915
916 # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add.
917 # For more information please see
918 # http://doc.trolltech.com/qthelpproject.html#custom-filters
919
920 QHP_CUST_FILTER_NAME = eVaf 0.1.1
921
922 # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see
923 # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>.
924
925 QHP_CUST_FILTER_ATTRS = eVaf 0.1.1
926
927 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's
928 # filter section matches.
929 # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>.
930
931 QHP_SECT_FILTER_ATTRS = eVaf 0.1.1
932
933 # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
934 # be used to specify the location of Qt's qhelpgenerator.
935 # If non-empty doxygen will try to run qhelpgenerator on the generated
936 # .qhp file.
937
938 QHG_LOCATION = qhelpgenerator
939
940 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
941 # top of each HTML page. The value NO (the default) enables the index and
942 # the value YES disables it.
943
944 DISABLE_INDEX = NO
945
946 # This tag can be used to set the number of enum values (range [1..20])
947 # that doxygen will group on one line in the generated HTML documentation.
948
949 ENUM_VALUES_PER_LINE = 4
950
951 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
952 # structure should be generated to display hierarchical information.
953 # If the tag value is set to FRAME, a side panel will be generated
954 # containing a tree-like index structure (just like the one that
955 # is generated for HTML Help). For this to work a browser that supports
956 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
957 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
958 # probably better off using the HTML help feature. Other possible values
959 # for this tag are: HIERARCHIES, which will generate the Groups, Directories,
960 # and Class Hierarchy pages using a tree view instead of an ordered list;
961 # ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which
962 # disables this behavior completely. For backwards compatibility with previous
963 # releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE
964 # respectively.
965
966 GENERATE_TREEVIEW = YES
967
968 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
969 # used to set the initial width (in pixels) of the frame in which the tree
970 # is shown.
971
972 TREEVIEW_WIDTH = 250
973
974 # Use this tag to change the font size of Latex formulas included
975 # as images in the HTML documentation. The default is 10. Note that
976 # when you change the font size after a successful doxygen run you need
977 # to manually remove any form_*.png images from the HTML output directory
978 # to force them to be regenerated.
979
980 FORMULA_FONTSIZE = 10
981
982 #---------------------------------------------------------------------------
983 # configuration options related to the LaTeX output
984 #---------------------------------------------------------------------------
985
986 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
987 # generate Latex output.
988
989 GENERATE_LATEX = NO
990
991 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
992 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
993 # put in front of it. If left blank `latex' will be used as the default path.
994
995 LATEX_OUTPUT = latex
996
997 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
998 # invoked. If left blank `latex' will be used as the default command name.
999
1000 LATEX_CMD_NAME = latex
1001
1002 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1003 # generate index for LaTeX. If left blank `makeindex' will be used as the
1004 # default command name.
1005
1006 MAKEINDEX_CMD_NAME = makeindex
1007
1008 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1009 # LaTeX documents. This may be useful for small projects and may help to
1010 # save some trees in general.
1011
1012 COMPACT_LATEX = NO
1013
1014 # The PAPER_TYPE tag can be used to set the paper type that is used
1015 # by the printer. Possible values are: a4, a4wide, letter, legal and
1016 # executive. If left blank a4wide will be used.
1017
1018 PAPER_TYPE = a4wide
1019
1020 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1021 # packages that should be included in the LaTeX output.
1022
1023 EXTRA_PACKAGES =
1024
1025 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1026 # the generated latex document. The header should contain everything until
1027 # the first chapter. If it is left blank doxygen will generate a
1028 # standard header. Notice: only use this tag if you know what you are doing!
1029
1030 LATEX_HEADER =
1031
1032 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1033 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
1034 # contain links (just like the HTML output) instead of page references
1035 # This makes the output suitable for online browsing using a pdf viewer.
1036
1037 PDF_HYPERLINKS = YES
1038
1039 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1040 # plain latex in the generated Makefile. Set this option to YES to get a
1041 # higher quality PDF documentation.
1042
1043 USE_PDFLATEX = NO
1044
1045 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1046 # command to the generated LaTeX files. This will instruct LaTeX to keep
1047 # running if errors occur, instead of asking the user for help.
1048 # This option is also used when generating formulas in HTML.
1049
1050 LATEX_BATCHMODE = NO
1051
1052 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
1053 # include the index chapters (such as File Index, Compound Index, etc.)
1054 # in the output.
1055
1056 LATEX_HIDE_INDICES = NO
1057
1058 #---------------------------------------------------------------------------
1059 # configuration options related to the RTF output
1060 #---------------------------------------------------------------------------
1061
1062 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1063 # The RTF output is optimized for Word 97 and may not look very pretty with
1064 # other RTF readers or editors.
1065
1066 GENERATE_RTF = NO
1067
1068 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1069 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1070 # put in front of it. If left blank `rtf' will be used as the default path.
1071
1072 RTF_OUTPUT = rtf
1073
1074 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1075 # RTF documents. This may be useful for small projects and may help to
1076 # save some trees in general.
1077
1078 COMPACT_RTF = NO
1079
1080 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1081 # will contain hyperlink fields. The RTF file will
1082 # contain links (just like the HTML output) instead of page references.
1083 # This makes the output suitable for online browsing using WORD or other
1084 # programs which support those fields.
1085 # Note: wordpad (write) and others do not support links.
1086
1087 RTF_HYPERLINKS = NO
1088
1089 # Load stylesheet definitions from file. Syntax is similar to doxygen's
1090 # config file, i.e. a series of assignments. You only have to provide
1091 # replacements, missing definitions are set to their default value.
1092
1093 RTF_STYLESHEET_FILE =
1094
1095 # Set optional variables used in the generation of an rtf document.
1096 # Syntax is similar to doxygen's config file.
1097
1098 RTF_EXTENSIONS_FILE =
1099
1100 #---------------------------------------------------------------------------
1101 # configuration options related to the man page output
1102 #---------------------------------------------------------------------------
1103
1104 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1105 # generate man pages
1106
1107 GENERATE_MAN = NO
1108
1109 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
1110 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1111 # put in front of it. If left blank `man' will be used as the default path.
1112
1113 MAN_OUTPUT = man
1114
1115 # The MAN_EXTENSION tag determines the extension that is added to
1116 # the generated man pages (default is the subroutine's section .3)
1117
1118 MAN_EXTENSION = .3
1119
1120 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1121 # then it will generate one additional man file for each entity
1122 # documented in the real man page(s). These additional files
1123 # only source the real man page, but without them the man command
1124 # would be unable to find the correct page. The default is NO.
1125
1126 MAN_LINKS = NO
1127
1128 #---------------------------------------------------------------------------
1129 # configuration options related to the XML output
1130 #---------------------------------------------------------------------------
1131
1132 # If the GENERATE_XML tag is set to YES Doxygen will
1133 # generate an XML file that captures the structure of
1134 # the code including all documentation.
1135
1136 GENERATE_XML = NO
1137
1138 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
1139 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1140 # put in front of it. If left blank `xml' will be used as the default path.
1141
1142 XML_OUTPUT = xml
1143
1144 # The XML_SCHEMA tag can be used to specify an XML schema,
1145 # which can be used by a validating XML parser to check the
1146 # syntax of the XML files.
1147
1148 XML_SCHEMA =
1149
1150 # The XML_DTD tag can be used to specify an XML DTD,
1151 # which can be used by a validating XML parser to check the
1152 # syntax of the XML files.
1153
1154 XML_DTD =
1155
1156 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1157 # dump the program listings (including syntax highlighting
1158 # and cross-referencing information) to the XML output. Note that
1159 # enabling this will significantly increase the size of the XML output.
1160
1161 XML_PROGRAMLISTING = YES
1162
1163 #---------------------------------------------------------------------------
1164 # configuration options for the AutoGen Definitions output
1165 #---------------------------------------------------------------------------
1166
1167 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1168 # generate an AutoGen Definitions (see autogen.sf.net) file
1169 # that captures the structure of the code including all
1170 # documentation. Note that this feature is still experimental
1171 # and incomplete at the moment.
1172
1173 GENERATE_AUTOGEN_DEF = NO
1174
1175 #---------------------------------------------------------------------------
1176 # configuration options related to the Perl module output
1177 #---------------------------------------------------------------------------
1178
1179 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
1180 # generate a Perl module file that captures the structure of
1181 # the code including all documentation. Note that this
1182 # feature is still experimental and incomplete at the
1183 # moment.
1184
1185 GENERATE_PERLMOD = NO
1186
1187 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1188 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
1189 # to generate PDF and DVI output from the Perl module output.
1190
1191 PERLMOD_LATEX = NO
1192
1193 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1194 # nicely formatted so it can be parsed by a human reader.
1195 # This is useful
1196 # if you want to understand what is going on.
1197 # On the other hand, if this
1198 # tag is set to NO the size of the Perl module output will be much smaller
1199 # and Perl will parse it just the same.
1200
1201 PERLMOD_PRETTY = YES
1202
1203 # The names of the make variables in the generated doxyrules.make file
1204 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1205 # This is useful so different doxyrules.make files included by the same
1206 # Makefile don't overwrite each other's variables.
1207
1208 PERLMOD_MAKEVAR_PREFIX =
1209
1210 #---------------------------------------------------------------------------
1211 # Configuration options related to the preprocessor
1212 #---------------------------------------------------------------------------
1213
1214 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1215 # evaluate all C-preprocessor directives found in the sources and include
1216 # files.
1217
1218 ENABLE_PREPROCESSING = YES
1219
1220 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1221 # names in the source code. If set to NO (the default) only conditional
1222 # compilation will be performed. Macro expansion can be done in a controlled
1223 # way by setting EXPAND_ONLY_PREDEF to YES.
1224
1225 MACRO_EXPANSION = NO
1226
1227 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1228 # then the macro expansion is limited to the macros specified with the
1229 # PREDEFINED and EXPAND_AS_DEFINED tags.
1230
1231 EXPAND_ONLY_PREDEF = YES
1232
1233 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1234 # in the INCLUDE_PATH (see below) will be search if a #include is found.
1235
1236 SEARCH_INCLUDES = YES
1237
1238 # The INCLUDE_PATH tag can be used to specify one or more directories that
1239 # contain include files that are not input files but should be processed by
1240 # the preprocessor.
1241
1242 INCLUDE_PATH =
1243
1244 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1245 # patterns (like *.h and *.hpp) to filter out the header-files in the
1246 # directories. If left blank, the patterns specified with FILE_PATTERNS will
1247 # be used.
1248
1249 INCLUDE_FILE_PATTERNS =
1250
1251 # The PREDEFINED tag can be used to specify one or more macro names that
1252 # are defined before the preprocessor is started (similar to the -D option of
1253 # gcc). The argument of the tag is a list of macros of the form: name
1254 # or name=definition (no spaces). If the definition and the = are
1255 # omitted =1 is assumed. To prevent a macro definition from being
1256 # undefined via #undef or recursively expanded use the := operator
1257 # instead of the = operator.
1258
1259 PREDEFINED = Q_OBJECT \
1260 Q_INTERFACES \
1261 Q_PROPERTY
1262
1263 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1264 # this tag can be used to specify a list of macro names that should be expanded.
1265 # The macro definition that is found in the sources will be used.
1266 # Use the PREDEFINED tag if you want to use a different macro definition.
1267
1268 EXPAND_AS_DEFINED =
1269
1270 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1271 # doxygen's preprocessor will remove all function-like macros that are alone
1272 # on a line, have an all uppercase name, and do not end with a semicolon. Such
1273 # function macros are typically used for boiler-plate code, and will confuse
1274 # the parser if not removed.
1275
1276 SKIP_FUNCTION_MACROS = NO
1277
1278 #---------------------------------------------------------------------------
1279 # Configuration::additions related to external references
1280 #---------------------------------------------------------------------------
1281
1282 # The TAGFILES option can be used to specify one or more tagfiles.
1283 # Optionally an initial location of the external documentation
1284 # can be added for each tagfile. The format of a tag file without
1285 # this location is as follows:
1286 #
1287 # TAGFILES = file1 file2 ...
1288 # Adding location for the tag files is done as follows:
1289 #
1290 # TAGFILES = file1=loc1 "file2 = loc2" ...
1291 # where "loc1" and "loc2" can be relative or absolute paths or
1292 # URLs. If a location is present for each tag, the installdox tool
1293 # does not have to be run to correct the links.
1294 # Note that each tag file must have a unique name
1295 # (where the name does NOT include the path)
1296 # If a tag file is not located in the directory in which doxygen
1297 # is run, you must also specify the path to the tagfile here.
1298
1299 TAGFILES =
1300
1301 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1302 # a tag file that is based on the input files it reads.
1303
1304 GENERATE_TAGFILE =
1305
1306 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1307 # in the class index. If set to NO only the inherited external classes
1308 # will be listed.
1309
1310 ALLEXTERNALS = NO
1311
1312 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1313 # in the modules index. If set to NO, only the current project's groups will
1314 # be listed.
1315
1316 EXTERNAL_GROUPS = YES
1317
1318 # The PERL_PATH should be the absolute path and name of the perl script
1319 # interpreter (i.e. the result of `which perl').
1320
1321 PERL_PATH = /usr/bin/perl
1322
1323 #---------------------------------------------------------------------------
1324 # Configuration options related to the dot tool
1325 #---------------------------------------------------------------------------
1326
1327 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1328 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1329 # or super classes. Setting the tag to NO turns the diagrams off. Note that
1330 # this option is superseded by the HAVE_DOT option below. This is only a
1331 # fallback. It is recommended to install and use dot, since it yields more
1332 # powerful graphs.
1333
1334 CLASS_DIAGRAMS = NO
1335
1336 # You can define message sequence charts within doxygen comments using the \msc
1337 # command. Doxygen will then run the mscgen tool (see
1338 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1339 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
1340 # the mscgen tool resides. If left empty the tool is assumed to be found in the
1341 # default search path.
1342
1343 MSCGEN_PATH =
1344
1345 # If set to YES, the inheritance and collaboration graphs will hide
1346 # inheritance and usage relations if the target is undocumented
1347 # or is not a class.
1348
1349 HIDE_UNDOC_RELATIONS = NO
1350
1351 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1352 # available from the path. This tool is part of Graphviz, a graph visualization
1353 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
1354 # have no effect if this option is set to NO (the default)
1355
1356 HAVE_DOT = NO
1357
1358 # By default doxygen will write a font called FreeSans.ttf to the output
1359 # directory and reference it in all dot files that doxygen generates. This
1360 # font does not include all possible unicode characters however, so when you need
1361 # these (or just want a differently looking font) you can specify the font name
1362 # using DOT_FONTNAME. You need need to make sure dot is able to find the font,
1363 # which can be done by putting it in a standard location or by setting the
1364 # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
1365 # containing the font.
1366
1367 DOT_FONTNAME = FreeSans
1368
1369 # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1370 # The default size is 10pt.
1371
1372 DOT_FONTSIZE = 10
1373
1374 # By default doxygen will tell dot to use the output directory to look for the
1375 # FreeSans.ttf font (which doxygen will put there itself). If you specify a
1376 # different font using DOT_FONTNAME you can set the path where dot
1377 # can find it using this tag.
1378
1379 DOT_FONTPATH =
1380
1381 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1382 # will generate a graph for each documented class showing the direct and
1383 # indirect inheritance relations. Setting this tag to YES will force the
1384 # the CLASS_DIAGRAMS tag to NO.
1385
1386 CLASS_GRAPH = NO
1387
1388 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1389 # will generate a graph for each documented class showing the direct and
1390 # indirect implementation dependencies (inheritance, containment, and
1391 # class references variables) of the class with other documented classes.
1392
1393 COLLABORATION_GRAPH = NO
1394
1395 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1396 # will generate a graph for groups, showing the direct groups dependencies
1397
1398 GROUP_GRAPHS = NO
1399
1400 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1401 # collaboration diagrams in a style similar to the OMG's Unified Modeling
1402 # Language.
1403
1404 UML_LOOK = NO
1405
1406 # If set to YES, the inheritance and collaboration graphs will show the
1407 # relations between templates and their instances.
1408
1409 TEMPLATE_RELATIONS = NO
1410
1411 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1412 # tags are set to YES then doxygen will generate a graph for each documented
1413 # file showing the direct and indirect include dependencies of the file with
1414 # other documented files.
1415
1416 INCLUDE_GRAPH = NO
1417
1418 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1419 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1420 # documented header file showing the documented files that directly or
1421 # indirectly include this file.
1422
1423 INCLUDED_BY_GRAPH = NO
1424
1425 # If the CALL_GRAPH and HAVE_DOT options are set to YES then
1426 # doxygen will generate a call dependency graph for every global function
1427 # or class method. Note that enabling this option will significantly increase
1428 # the time of a run. So in most cases it will be better to enable call graphs
1429 # for selected functions only using the \callgraph command.
1430
1431 CALL_GRAPH = NO
1432
1433 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1434 # doxygen will generate a caller dependency graph for every global function
1435 # or class method. Note that enabling this option will significantly increase
1436 # the time of a run. So in most cases it will be better to enable caller
1437 # graphs for selected functions only using the \callergraph command.
1438
1439 CALLER_GRAPH = NO
1440
1441 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1442 # will graphical hierarchy of all classes instead of a textual one.
1443
1444 GRAPHICAL_HIERARCHY = NO
1445
1446 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1447 # then doxygen will show the dependencies a directory has on other directories
1448 # in a graphical way. The dependency relations are determined by the #include
1449 # relations between the files in the directories.
1450
1451 DIRECTORY_GRAPH = NO
1452
1453 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1454 # generated by dot. Possible values are png, jpg, or gif
1455 # If left blank png will be used.
1456
1457 DOT_IMAGE_FORMAT = png
1458
1459 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1460 # found. If left blank, it is assumed the dot tool can be found in the path.
1461
1462 DOT_PATH =
1463
1464 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1465 # contain dot files that are included in the documentation (see the
1466 # \dotfile command).
1467
1468 DOTFILE_DIRS =
1469
1470 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1471 # nodes that will be shown in the graph. If the number of nodes in a graph
1472 # becomes larger than this value, doxygen will truncate the graph, which is
1473 # visualized by representing a node as a red box. Note that doxygen if the
1474 # number of direct children of the root node in a graph is already larger than
1475 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1476 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1477
1478 DOT_GRAPH_MAX_NODES = 50
1479
1480 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1481 # graphs generated by dot. A depth value of 3 means that only nodes reachable
1482 # from the root by following a path via at most 3 edges will be shown. Nodes
1483 # that lay further from the root node will be omitted. Note that setting this
1484 # option to 1 or 2 may greatly reduce the computation time needed for large
1485 # code bases. Also note that the size of a graph can be further restricted by
1486 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1487
1488 MAX_DOT_GRAPH_DEPTH = 1000
1489
1490 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1491 # background. This is disabled by default, because dot on Windows does not
1492 # seem to support this out of the box. Warning: Depending on the platform used,
1493 # enabling this option may lead to badly anti-aliased labels on the edges of
1494 # a graph (i.e. they become hard to read).
1495
1496 DOT_TRANSPARENT = NO
1497
1498 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1499 # files in one run (i.e. multiple -o and -T options on the command line). This
1500 # makes dot run faster, but since only newer versions of dot (>1.8.10)
1501 # support this, this feature is disabled by default.
1502
1503 DOT_MULTI_TARGETS = NO
1504
1505 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1506 # generate a legend page explaining the meaning of the various boxes and
1507 # arrows in the dot generated graphs.
1508
1509 GENERATE_LEGEND = NO
1510
1511 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1512 # remove the intermediate dot files that are used to generate
1513 # the various graphs.
1514
1515 DOT_CLEANUP = YES
1516
1517 #---------------------------------------------------------------------------
1518 # Options related to the search engine
1519 #---------------------------------------------------------------------------
1520
1521 # The SEARCHENGINE tag specifies whether or not a search engine should be
1522 # used. If set to NO the values of all tags below this one will be ignored.
1523
1524 SEARCHENGINE = NO