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