View File | Revision Log | Show Annotations | Download File | View Changeset
/hippo/hippo-documentation/hst_docs/tags/Release-HSTTWODOCS-v1_01_28/Doxyfile
Revision: 27699
Committed: Mon Apr 11 13:25:30 2011 UTC (8 years, 6 months ago) by epriyadi
File size: 64693 byte(s)
Log Message:
PRODDOCS-82: copy for tag Release-HSTTWODOCS-v1_01_28

File Contents

# Content
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 = Docsite
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 = trunk
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 = ./target/doxygen
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 = YES
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 = NO
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 =
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 = NO
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
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 = NO
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 = NO
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 = YES
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 INLINE_INFO tag is set to YES (the default) then a tag [inline]
400 # is inserted in the documentation for inline members.
401
402 INLINE_INFO = YES
403
404 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
405 # will sort the (detailed) documentation of file and class members
406 # alphabetically by member name. If set to NO the members will appear in
407 # declaration order.
408
409 SORT_MEMBER_DOCS = YES
410
411 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
412 # brief documentation of file, namespace and class members alphabetically
413 # by member name. If set to NO (the default) the members will appear in
414 # declaration order.
415
416 SORT_BRIEF_DOCS = NO
417
418 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
419 # hierarchy of group names into alphabetical order. If set to NO (the default)
420 # the group names will appear in their defined order.
421
422 SORT_GROUP_NAMES = NO
423
424 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
425 # sorted by fully-qualified names, including namespaces. If set to
426 # NO (the default), the class list will be sorted only by class name,
427 # not including the namespace part.
428 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
429 # Note: This option applies only to the class list, not to the
430 # alphabetical list.
431
432 SORT_BY_SCOPE_NAME = NO
433
434 # The GENERATE_TODOLIST tag can be used to enable (YES) or
435 # disable (NO) the todo list. This list is created by putting \todo
436 # commands in the documentation.
437
438 GENERATE_TODOLIST = YES
439
440 # The GENERATE_TESTLIST tag can be used to enable (YES) or
441 # disable (NO) the test list. This list is created by putting \test
442 # commands in the documentation.
443
444 GENERATE_TESTLIST = YES
445
446 # The GENERATE_BUGLIST tag can be used to enable (YES) or
447 # disable (NO) the bug list. This list is created by putting \bug
448 # commands in the documentation.
449
450 GENERATE_BUGLIST = YES
451
452 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
453 # disable (NO) the deprecated list. This list is created by putting
454 # \deprecated commands in the documentation.
455
456 GENERATE_DEPRECATEDLIST= YES
457
458 # The ENABLED_SECTIONS tag can be used to enable conditional
459 # documentation sections, marked by \if sectionname ... \endif.
460
461 ENABLED_SECTIONS =
462
463 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
464 # the initial value of a variable or define consists of for it to appear in
465 # the documentation. If the initializer consists of more lines than specified
466 # here it will be hidden. Use a value of 0 to hide initializers completely.
467 # The appearance of the initializer of individual variables and defines in the
468 # documentation can be controlled using \showinitializer or \hideinitializer
469 # command in the documentation regardless of this setting.
470
471 MAX_INITIALIZER_LINES = 30
472
473 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
474 # at the bottom of the documentation of classes and structs. If set to YES the
475 # list will mention the files that were used to generate the documentation.
476
477 SHOW_USED_FILES = YES
478
479 # If the sources in your project are distributed over multiple directories
480 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
481 # in the documentation. The default is NO.
482
483 SHOW_DIRECTORIES = YES
484
485 # Set the SHOW_FILES tag to NO to disable the generation of the Files page.
486 # This will remove the Files entry from the Quick Index and from the
487 # Folder Tree View (if specified). The default is YES.
488
489 SHOW_FILES = YES
490
491 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the
492 # Namespaces page. This will remove the Namespaces entry from the Quick Index
493 # and from the Folder Tree View (if specified). The default is YES.
494
495 SHOW_NAMESPACES = YES
496
497 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
498 # doxygen should invoke to get the current version for each file (typically from
499 # the version control system). Doxygen will invoke the program by executing (via
500 # popen()) the command <command> <input-file>, where <command> is the value of
501 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
502 # provided by doxygen. Whatever the program writes to standard output
503 # is used as the file version. See the manual for examples.
504
505 FILE_VERSION_FILTER =
506
507 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by
508 # doxygen. The layout file controls the global structure of the generated output files
509 # in an output format independent way. The create the layout file that represents
510 # doxygen's defaults, run doxygen with the -l option. You can optionally specify a
511 # file name after the option, if omitted DoxygenLayout.xml will be used as the name
512 # of the layout file.
513
514 LAYOUT_FILE =
515
516 #---------------------------------------------------------------------------
517 # configuration options related to warning and progress messages
518 #---------------------------------------------------------------------------
519
520 # The QUIET tag can be used to turn on/off the messages that are generated
521 # by doxygen. Possible values are YES and NO. If left blank NO is used.
522
523 QUIET = NO
524
525 # The WARNINGS tag can be used to turn on/off the warning messages that are
526 # generated by doxygen. Possible values are YES and NO. If left blank
527 # NO is used.
528
529 WARNINGS = YES
530
531 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
532 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
533 # automatically be disabled.
534
535 WARN_IF_UNDOCUMENTED = YES
536
537 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
538 # potential errors in the documentation, such as not documenting some
539 # parameters in a documented function, or documenting parameters that
540 # don't exist or using markup commands wrongly.
541
542 WARN_IF_DOC_ERROR = YES
543
544 # This WARN_NO_PARAMDOC option can be abled to get warnings for
545 # functions that are documented, but have no documentation for their parameters
546 # or return value. If set to NO (the default) doxygen will only warn about
547 # wrong or incomplete parameter documentation, but not about the absence of
548 # documentation.
549
550 WARN_NO_PARAMDOC = NO
551
552 # The WARN_FORMAT tag determines the format of the warning messages that
553 # doxygen can produce. The string should contain the $file, $line, and $text
554 # tags, which will be replaced by the file and line number from which the
555 # warning originated and the warning text. Optionally the format may contain
556 # $version, which will be replaced by the version of the file (if it could
557 # be obtained via FILE_VERSION_FILTER)
558
559 WARN_FORMAT = "$file:$line: $text"
560
561 # The WARN_LOGFILE tag can be used to specify a file to which warning
562 # and error messages should be written. If left blank the output is written
563 # to stderr.
564
565 WARN_LOGFILE =
566
567 #---------------------------------------------------------------------------
568 # configuration options related to the input files
569 #---------------------------------------------------------------------------
570
571 # The INPUT tag can be used to specify the files and/or directories that contain
572 # documented source files. You may enter file names like "myfile.cpp" or
573 # directories like "/usr/src/myproject". Separate the files or directories
574 # with spaces.
575
576 INPUT = .
577 # INPUT = ./README ./pom.xml ./api ./components ./client ./commons ./content-beans ./demosuite ./maven ./testsuite ./toolkit-resources
578
579 # This tag can be used to specify the character encoding of the source files
580 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
581 # also the default input encoding. Doxygen uses libiconv (or the iconv built
582 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
583 # the list of possible encodings.
584
585 INPUT_ENCODING = UTF-8
586
587 # If the value of the INPUT tag contains directories, you can use the
588 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
589 # and *.h) to filter out the source-files in the directories. If left
590 # blank the following patterns are tested:
591 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
592 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
593
594 FILE_PATTERNS = *.c \
595 *.cc \
596 *.cxx \
597 *.cpp \
598 *.c++ \
599 *.d \
600 *.java \
601 *.ii \
602 *.ixx \
603 *.ipp \
604 *.i++ \
605 *.inl \
606 *.h \
607 *.hh \
608 *.hxx \
609 *.hpp \
610 *.h++ \
611 *.idl \
612 *.odl \
613 *.cs \
614 *.php \
615 *.php3 \
616 *.inc \
617 *.m \
618 *.mm \
619 *.dox \
620 *.py \
621 *.f90 \
622 *.f \
623 *.vhd \
624 *.vhdl \
625 *.jsp \
626 *.jspx
627
628 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
629 # should be searched for input files as well. Possible values are YES and NO.
630 # If left blank NO is used.
631
632 RECURSIVE = YES
633
634 # The EXCLUDE tag can be used to specify files and/or directories that should
635 # excluded from the INPUT source files. This way you can easily exclude a
636 # subdirectory from a directory tree whose root is specified with the INPUT tag.
637
638 EXCLUDE =
639
640 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
641 # directories that are symbolic links (a Unix filesystem feature) are excluded
642 # from the input.
643
644 EXCLUDE_SYMLINKS = NO
645
646 # If the value of the INPUT tag contains directories, you can use the
647 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
648 # certain files from those directories. Note that the wildcards are matched
649 # against the file with absolute path, so to exclude all test directories
650 # for example use the pattern */test/*
651
652 EXCLUDE_PATTERNS = */target/* */.svn/*
653
654 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
655 # (namespaces, classes, functions, etc.) that should be excluded from the
656 # output. The symbol name can be a fully qualified name, a word, or if the
657 # wildcard * is used, a substring. Examples: ANamespace, AClass,
658 # AClass::ANamespace, ANamespace::*Test
659
660 EXCLUDE_SYMBOLS =
661
662 # The EXAMPLE_PATH tag can be used to specify one or more files or
663 # directories that contain example code fragments that are included (see
664 # the \include command).
665
666 EXAMPLE_PATH =
667
668 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
669 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
670 # and *.h) to filter out the source-files in the directories. If left
671 # blank all files are included.
672
673 EXAMPLE_PATTERNS = *
674
675 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
676 # searched for input files to be used with the \include or \dontinclude
677 # commands irrespective of the value of the RECURSIVE tag.
678 # Possible values are YES and NO. If left blank NO is used.
679
680 EXAMPLE_RECURSIVE = NO
681
682 # The IMAGE_PATH tag can be used to specify one or more files or
683 # directories that contain image that are included in the documentation (see
684 # the \image command).
685
686 IMAGE_PATH =
687
688 # The INPUT_FILTER tag can be used to specify a program that doxygen should
689 # invoke to filter for each input file. Doxygen will invoke the filter program
690 # by executing (via popen()) the command <filter> <input-file>, where <filter>
691 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
692 # input file. Doxygen will then use the output that the filter program writes
693 # to standard output. If FILTER_PATTERNS is specified, this tag will be
694 # ignored.
695
696 INPUT_FILTER =
697
698 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
699 # basis. Doxygen will compare the file name with each pattern and apply the
700 # filter if there is a match. The filters are a list of the form:
701 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
702 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
703 # is applied to all files.
704
705 FILTER_PATTERNS =
706
707 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
708 # INPUT_FILTER) will be used to filter the input files when producing source
709 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
710
711 FILTER_SOURCE_FILES = NO
712
713 #---------------------------------------------------------------------------
714 # configuration options related to source browsing
715 #---------------------------------------------------------------------------
716
717 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
718 # be generated. Documented entities will be cross-referenced with these sources.
719 # Note: To get rid of all source code in the generated output, make sure also
720 # VERBATIM_HEADERS is set to NO.
721
722 SOURCE_BROWSER = YES
723
724 # Setting the INLINE_SOURCES tag to YES will include the body
725 # of functions and classes directly in the documentation.
726
727 INLINE_SOURCES = NO
728
729 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
730 # doxygen to hide any special comment blocks from generated source code
731 # fragments. Normal C and C++ comments will always remain visible.
732
733 STRIP_CODE_COMMENTS = YES
734
735 # If the REFERENCED_BY_RELATION tag is set to YES
736 # then for each documented function all documented
737 # functions referencing it will be listed.
738
739 REFERENCED_BY_RELATION = YES
740
741 # If the REFERENCES_RELATION tag is set to YES
742 # then for each documented function all documented entities
743 # called/used by that function will be listed.
744
745 REFERENCES_RELATION = YES
746
747 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
748 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
749 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
750 # link to the source code. Otherwise they will link to the documentation.
751
752 REFERENCES_LINK_SOURCE = YES
753
754 # If the USE_HTAGS tag is set to YES then the references to source code
755 # will point to the HTML generated by the htags(1) tool instead of doxygen
756 # built-in source browser. The htags tool is part of GNU's global source
757 # tagging system (see http://www.gnu.org/software/global/global.html). You
758 # will need version 4.8.6 or higher.
759
760 USE_HTAGS = NO
761
762 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
763 # will generate a verbatim copy of the header file for each class for
764 # which an include is specified. Set to NO to disable this.
765
766 VERBATIM_HEADERS = YES
767
768 #---------------------------------------------------------------------------
769 # configuration options related to the alphabetical class index
770 #---------------------------------------------------------------------------
771
772 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
773 # of all compounds will be generated. Enable this if the project
774 # contains a lot of classes, structs, unions or interfaces.
775
776 ALPHABETICAL_INDEX = YES
777
778 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
779 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
780 # in which this list will be split (can be a number in the range [1..20])
781
782 COLS_IN_ALPHA_INDEX = 5
783
784 # In case all classes in a project start with a common prefix, all
785 # classes will be put under the same header in the alphabetical index.
786 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
787 # should be ignored while generating the index headers.
788
789 IGNORE_PREFIX =
790
791 #---------------------------------------------------------------------------
792 # configuration options related to the HTML output
793 #---------------------------------------------------------------------------
794
795 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
796 # generate HTML output.
797
798 GENERATE_HTML = YES
799
800 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
801 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
802 # put in front of it. If left blank `html' will be used as the default path.
803
804 HTML_OUTPUT = html
805
806 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
807 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
808 # doxygen will generate files with .html extension.
809
810 HTML_FILE_EXTENSION = .html
811
812 # The HTML_HEADER tag can be used to specify a personal HTML header for
813 # each generated HTML page. If it is left blank doxygen will generate a
814 # standard header.
815
816 HTML_HEADER =
817
818 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
819 # each generated HTML page. If it is left blank doxygen will generate a
820 # standard footer.
821
822 HTML_FOOTER =
823
824 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
825 # style sheet that is used by each HTML page. It can be used to
826 # fine-tune the look of the HTML output. If the tag is left blank doxygen
827 # will generate a default style sheet. Note that doxygen will try to copy
828 # the style sheet file to the HTML output directory, so don't put your own
829 # stylesheet in the HTML output directory as well, or it will be erased!
830
831 HTML_STYLESHEET =
832
833 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
834 # files or namespaces will be aligned in HTML using tables. If set to
835 # NO a bullet list will be used.
836
837 HTML_ALIGN_MEMBERS = YES
838
839 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
840 # documentation will contain sections that can be hidden and shown after the
841 # page has loaded. For this to work a browser that supports
842 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
843 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
844
845 HTML_DYNAMIC_SECTIONS = NO
846
847 # If the GENERATE_DOCSET tag is set to YES, additional index files
848 # will be generated that can be used as input for Apple's Xcode 3
849 # integrated development environment, introduced with OSX 10.5 (Leopard).
850 # To create a documentation set, doxygen will generate a Makefile in the
851 # HTML output directory. Running make will produce the docset in that
852 # directory and running "make install" will install the docset in
853 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
854 # it at startup.
855 # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.
856
857 GENERATE_DOCSET = NO
858
859 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
860 # feed. A documentation feed provides an umbrella under which multiple
861 # documentation sets from a single provider (such as a company or product suite)
862 # can be grouped.
863
864 DOCSET_FEEDNAME = "Docsite doxygen apidocs"
865
866 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
867 # should uniquely identify the documentation set bundle. This should be a
868 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
869 # will append .docset to the name.
870
871 DOCSET_BUNDLE_ID = org.doxygen.Project
872
873 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
874 # will be generated that can be used as input for tools like the
875 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
876 # of the generated HTML documentation.
877
878 GENERATE_HTMLHELP = NO
879
880 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
881 # be used to specify the file name of the resulting .chm file. You
882 # can add a path in front of the file if the result should not be
883 # written to the html output directory.
884
885 CHM_FILE =
886
887 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
888 # be used to specify the location (absolute path including file name) of
889 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
890 # the HTML help compiler on the generated index.hhp.
891
892 HHC_LOCATION =
893
894 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
895 # controls if a separate .chi index file is generated (YES) or that
896 # it should be included in the master .chm file (NO).
897
898 GENERATE_CHI = NO
899
900 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
901 # is used to encode HtmlHelp index (hhk), content (hhc) and project file
902 # content.
903
904 CHM_INDEX_ENCODING =
905
906 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
907 # controls whether a binary table of contents is generated (YES) or a
908 # normal table of contents (NO) in the .chm file.
909
910 BINARY_TOC = NO
911
912 # The TOC_EXPAND flag can be set to YES to add extra items for group members
913 # to the contents of the HTML help documentation and to the tree view.
914
915 TOC_EXPAND = NO
916
917 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER
918 # are set, an additional index file will be generated that can be used as input for
919 # Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated
920 # HTML documentation.
921
922 GENERATE_QHP = NO
923
924 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can
925 # be used to specify the file name of the resulting .qch file.
926 # The path specified is relative to the HTML output folder.
927
928 QCH_FILE =
929
930 # The QHP_NAMESPACE tag specifies the namespace to use when generating
931 # Qt Help Project output. For more information please see
932 # http://doc.trolltech.com/qthelpproject.html#namespace
933
934 QHP_NAMESPACE =
935
936 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
937 # Qt Help Project output. For more information please see
938 # http://doc.trolltech.com/qthelpproject.html#virtual-folders
939
940 QHP_VIRTUAL_FOLDER = doc
941
942 # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add.
943 # For more information please see
944 # http://doc.trolltech.com/qthelpproject.html#custom-filters
945
946 QHP_CUST_FILTER_NAME =
947
948 # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see
949 # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>.
950
951 QHP_CUST_FILTER_ATTRS =
952
953 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's
954 # filter section matches.
955 # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>.
956
957 QHP_SECT_FILTER_ATTRS =
958
959 # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
960 # be used to specify the location of Qt's qhelpgenerator.
961 # If non-empty doxygen will try to run qhelpgenerator on the generated
962 # .qhp file.
963
964 QHG_LOCATION =
965
966 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
967 # top of each HTML page. The value NO (the default) enables the index and
968 # the value YES disables it.
969
970 DISABLE_INDEX = NO
971
972 # This tag can be used to set the number of enum values (range [1..20])
973 # that doxygen will group on one line in the generated HTML documentation.
974
975 ENUM_VALUES_PER_LINE = 4
976
977 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
978 # structure should be generated to display hierarchical information.
979 # If the tag value is set to FRAME, a side panel will be generated
980 # containing a tree-like index structure (just like the one that
981 # is generated for HTML Help). For this to work a browser that supports
982 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
983 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
984 # probably better off using the HTML help feature. Other possible values
985 # for this tag are: HIERARCHIES, which will generate the Groups, Directories,
986 # and Class Hierarchy pages using a tree view instead of an ordered list;
987 # ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which
988 # disables this behavior completely. For backwards compatibility with previous
989 # releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE
990 # respectively.
991
992 GENERATE_TREEVIEW = NONE
993
994 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
995 # used to set the initial width (in pixels) of the frame in which the tree
996 # is shown.
997
998 TREEVIEW_WIDTH = 250
999
1000 # Use this tag to change the font size of Latex formulas included
1001 # as images in the HTML documentation. The default is 10. Note that
1002 # when you change the font size after a successful doxygen run you need
1003 # to manually remove any form_*.png images from the HTML output directory
1004 # to force them to be regenerated.
1005
1006 FORMULA_FONTSIZE = 10
1007
1008 #---------------------------------------------------------------------------
1009 # configuration options related to the LaTeX output
1010 #---------------------------------------------------------------------------
1011
1012 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
1013 # generate Latex output.
1014
1015 GENERATE_LATEX = No
1016
1017 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1018 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1019 # put in front of it. If left blank `latex' will be used as the default path.
1020
1021 LATEX_OUTPUT = latex
1022
1023 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1024 # invoked. If left blank `latex' will be used as the default command name.
1025
1026 LATEX_CMD_NAME = latex
1027
1028 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1029 # generate index for LaTeX. If left blank `makeindex' will be used as the
1030 # default command name.
1031
1032 MAKEINDEX_CMD_NAME = makeindex
1033
1034 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1035 # LaTeX documents. This may be useful for small projects and may help to
1036 # save some trees in general.
1037
1038 COMPACT_LATEX = NO
1039
1040 # The PAPER_TYPE tag can be used to set the paper type that is used
1041 # by the printer. Possible values are: a4, a4wide, letter, legal and
1042 # executive. If left blank a4wide will be used.
1043
1044 PAPER_TYPE = a4wide
1045
1046 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1047 # packages that should be included in the LaTeX output.
1048
1049 EXTRA_PACKAGES =
1050
1051 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1052 # the generated latex document. The header should contain everything until
1053 # the first chapter. If it is left blank doxygen will generate a
1054 # standard header. Notice: only use this tag if you know what you are doing!
1055
1056 LATEX_HEADER =
1057
1058 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1059 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
1060 # contain links (just like the HTML output) instead of page references
1061 # This makes the output suitable for online browsing using a pdf viewer.
1062
1063 PDF_HYPERLINKS = YES
1064
1065 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1066 # plain latex in the generated Makefile. Set this option to YES to get a
1067 # higher quality PDF documentation.
1068
1069 USE_PDFLATEX = YES
1070
1071 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1072 # command to the generated LaTeX files. This will instruct LaTeX to keep
1073 # running if errors occur, instead of asking the user for help.
1074 # This option is also used when generating formulas in HTML.
1075
1076 LATEX_BATCHMODE = NO
1077
1078 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
1079 # include the index chapters (such as File Index, Compound Index, etc.)
1080 # in the output.
1081
1082 LATEX_HIDE_INDICES = NO
1083
1084 #---------------------------------------------------------------------------
1085 # configuration options related to the RTF output
1086 #---------------------------------------------------------------------------
1087
1088 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1089 # The RTF output is optimized for Word 97 and may not look very pretty with
1090 # other RTF readers or editors.
1091
1092 GENERATE_RTF = NO
1093
1094 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1095 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1096 # put in front of it. If left blank `rtf' will be used as the default path.
1097
1098 RTF_OUTPUT = rtf
1099
1100 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1101 # RTF documents. This may be useful for small projects and may help to
1102 # save some trees in general.
1103
1104 COMPACT_RTF = NO
1105
1106 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1107 # will contain hyperlink fields. The RTF file will
1108 # contain links (just like the HTML output) instead of page references.
1109 # This makes the output suitable for online browsing using WORD or other
1110 # programs which support those fields.
1111 # Note: wordpad (write) and others do not support links.
1112
1113 RTF_HYPERLINKS = NO
1114
1115 # Load stylesheet definitions from file. Syntax is similar to doxygen's
1116 # config file, i.e. a series of assignments. You only have to provide
1117 # replacements, missing definitions are set to their default value.
1118
1119 RTF_STYLESHEET_FILE =
1120
1121 # Set optional variables used in the generation of an rtf document.
1122 # Syntax is similar to doxygen's config file.
1123
1124 RTF_EXTENSIONS_FILE =
1125
1126 #---------------------------------------------------------------------------
1127 # configuration options related to the man page output
1128 #---------------------------------------------------------------------------
1129
1130 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1131 # generate man pages
1132
1133 GENERATE_MAN = NO
1134
1135 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
1136 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1137 # put in front of it. If left blank `man' will be used as the default path.
1138
1139 MAN_OUTPUT = man
1140
1141 # The MAN_EXTENSION tag determines the extension that is added to
1142 # the generated man pages (default is the subroutine's section .3)
1143
1144 MAN_EXTENSION = .3
1145
1146 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1147 # then it will generate one additional man file for each entity
1148 # documented in the real man page(s). These additional files
1149 # only source the real man page, but without them the man command
1150 # would be unable to find the correct page. The default is NO.
1151
1152 MAN_LINKS = NO
1153
1154 #---------------------------------------------------------------------------
1155 # configuration options related to the XML output
1156 #---------------------------------------------------------------------------
1157
1158 # If the GENERATE_XML tag is set to YES Doxygen will
1159 # generate an XML file that captures the structure of
1160 # the code including all documentation.
1161
1162 GENERATE_XML = No
1163
1164 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
1165 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1166 # put in front of it. If left blank `xml' will be used as the default path.
1167
1168 XML_OUTPUT = xml
1169
1170 # The XML_SCHEMA tag can be used to specify an XML schema,
1171 # which can be used by a validating XML parser to check the
1172 # syntax of the XML files.
1173
1174 XML_SCHEMA =
1175
1176 # The XML_DTD tag can be used to specify an XML DTD,
1177 # which can be used by a validating XML parser to check the
1178 # syntax of the XML files.
1179
1180 XML_DTD =
1181
1182 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1183 # dump the program listings (including syntax highlighting
1184 # and cross-referencing information) to the XML output. Note that
1185 # enabling this will significantly increase the size of the XML output.
1186
1187 XML_PROGRAMLISTING = YES
1188
1189 #---------------------------------------------------------------------------
1190 # configuration options for the AutoGen Definitions output
1191 #---------------------------------------------------------------------------
1192
1193 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1194 # generate an AutoGen Definitions (see autogen.sf.net) file
1195 # that captures the structure of the code including all
1196 # documentation. Note that this feature is still experimental
1197 # and incomplete at the moment.
1198
1199 GENERATE_AUTOGEN_DEF = NO
1200
1201 #---------------------------------------------------------------------------
1202 # configuration options related to the Perl module output
1203 #---------------------------------------------------------------------------
1204
1205 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
1206 # generate a Perl module file that captures the structure of
1207 # the code including all documentation. Note that this
1208 # feature is still experimental and incomplete at the
1209 # moment.
1210
1211 GENERATE_PERLMOD = NO
1212
1213 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1214 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
1215 # to generate PDF and DVI output from the Perl module output.
1216
1217 PERLMOD_LATEX = NO
1218
1219 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1220 # nicely formatted so it can be parsed by a human reader. This is useful
1221 # if you want to understand what is going on. On the other hand, if this
1222 # tag is set to NO the size of the Perl module output will be much smaller
1223 # and Perl will parse it just the same.
1224
1225 PERLMOD_PRETTY = YES
1226
1227 # The names of the make variables in the generated doxyrules.make file
1228 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1229 # This is useful so different doxyrules.make files included by the same
1230 # Makefile don't overwrite each other's variables.
1231
1232 PERLMOD_MAKEVAR_PREFIX =
1233
1234 #---------------------------------------------------------------------------
1235 # Configuration options related to the preprocessor
1236 #---------------------------------------------------------------------------
1237
1238 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1239 # evaluate all C-preprocessor directives found in the sources and include
1240 # files.
1241
1242 ENABLE_PREPROCESSING = YES
1243
1244 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1245 # names in the source code. If set to NO (the default) only conditional
1246 # compilation will be performed. Macro expansion can be done in a controlled
1247 # way by setting EXPAND_ONLY_PREDEF to YES.
1248
1249 MACRO_EXPANSION = NO
1250
1251 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1252 # then the macro expansion is limited to the macros specified with the
1253 # PREDEFINED and EXPAND_AS_DEFINED tags.
1254
1255 EXPAND_ONLY_PREDEF = NO
1256
1257 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1258 # in the INCLUDE_PATH (see below) will be search if a #include is found.
1259
1260 SEARCH_INCLUDES = YES
1261
1262 # The INCLUDE_PATH tag can be used to specify one or more directories that
1263 # contain include files that are not input files but should be processed by
1264 # the preprocessor.
1265
1266 INCLUDE_PATH =
1267
1268 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1269 # patterns (like *.h and *.hpp) to filter out the header-files in the
1270 # directories. If left blank, the patterns specified with FILE_PATTERNS will
1271 # be used.
1272
1273 INCLUDE_FILE_PATTERNS =
1274
1275 # The PREDEFINED tag can be used to specify one or more macro names that
1276 # are defined before the preprocessor is started (similar to the -D option of
1277 # gcc). The argument of the tag is a list of macros of the form: name
1278 # or name=definition (no spaces). If the definition and the = are
1279 # omitted =1 is assumed. To prevent a macro definition from being
1280 # undefined via #undef or recursively expanded use the := operator
1281 # instead of the = operator.
1282
1283 PREDEFINED =
1284
1285 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1286 # this tag can be used to specify a list of macro names that should be expanded.
1287 # The macro definition that is found in the sources will be used.
1288 # Use the PREDEFINED tag if you want to use a different macro definition.
1289
1290 EXPAND_AS_DEFINED =
1291
1292 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1293 # doxygen's preprocessor will remove all function-like macros that are alone
1294 # on a line, have an all uppercase name, and do not end with a semicolon. Such
1295 # function macros are typically used for boiler-plate code, and will confuse
1296 # the parser if not removed.
1297
1298 SKIP_FUNCTION_MACROS = YES
1299
1300 #---------------------------------------------------------------------------
1301 # Configuration::additions related to external references
1302 #---------------------------------------------------------------------------
1303
1304 # The TAGFILES option can be used to specify one or more tagfiles.
1305 # Optionally an initial location of the external documentation
1306 # can be added for each tagfile. The format of a tag file without
1307 # this location is as follows:
1308 # TAGFILES = file1 file2 ...
1309 # Adding location for the tag files is done as follows:
1310 # TAGFILES = file1=loc1 "file2 = loc2" ...
1311 # where "loc1" and "loc2" can be relative or absolute paths or
1312 # URLs. If a location is present for each tag, the installdox tool
1313 # does not have to be run to correct the links.
1314 # Note that each tag file must have a unique name
1315 # (where the name does NOT include the path)
1316 # If a tag file is not located in the directory in which doxygen
1317 # is run, you must also specify the path to the tagfile here.
1318
1319 TAGFILES = ../../werk/hst/target/doxygen/hst_tags.xml=../../../../../werk/hst/target/doxygen/html/ ../../werk/cms/target/doxygen/cms_tags.xml=../../../../../werk/cms/target/doxygen/html/ ../../werk/import-tool/target/doxygen/import-tool_tags.xml=../../../../../werk/import-tool/target/doxygen/html/
1320
1321 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1322 # a tag file that is based on the input files it reads.
1323
1324 GENERATE_TAGFILE = ./target/doxygen/docsite_tags.xml
1325
1326 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1327 # in the class index. If set to NO only the inherited external classes
1328 # will be listed.
1329
1330 ALLEXTERNALS = NO
1331
1332 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1333 # in the modules index. If set to NO, only the current project's groups will
1334 # be listed.
1335
1336 EXTERNAL_GROUPS = YES
1337
1338 # The PERL_PATH should be the absolute path and name of the perl script
1339 # interpreter (i.e. the result of `which perl').
1340
1341 PERL_PATH = /usr/bin/perl
1342
1343 #---------------------------------------------------------------------------
1344 # Configuration options related to the dot tool
1345 #---------------------------------------------------------------------------
1346
1347 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1348 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1349 # or super classes. Setting the tag to NO turns the diagrams off. Note that
1350 # this option is superseded by the HAVE_DOT option below. This is only a
1351 # fallback. It is recommended to install and use dot, since it yields more
1352 # powerful graphs.
1353
1354 CLASS_DIAGRAMS = NO
1355
1356 # You can define message sequence charts within doxygen comments using the \msc
1357 # command. Doxygen will then run the mscgen tool (see
1358 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1359 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
1360 # the mscgen tool resides. If left empty the tool is assumed to be found in the
1361 # default search path.
1362
1363 MSCGEN_PATH =
1364
1365 # If set to YES, the inheritance and collaboration graphs will hide
1366 # inheritance and usage relations if the target is undocumented
1367 # or is not a class.
1368
1369 HIDE_UNDOC_RELATIONS = YES
1370
1371 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1372 # available from the path. This tool is part of Graphviz, a graph visualization
1373 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
1374 # have no effect if this option is set to NO (the default)
1375
1376 HAVE_DOT = YES
1377
1378 # By default doxygen will write a font called FreeSans.ttf to the output
1379 # directory and reference it in all dot files that doxygen generates. This
1380 # font does not include all possible unicode characters however, so when you need
1381 # these (or just want a differently looking font) you can specify the font name
1382 # using DOT_FONTNAME. You need need to make sure dot is able to find the font,
1383 # which can be done by putting it in a standard location or by setting the
1384 # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
1385 # containing the font.
1386
1387 DOT_FONTNAME = FreeSans
1388
1389 # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1390 # The default size is 10pt.
1391
1392 DOT_FONTSIZE = 10
1393
1394 # By default doxygen will tell dot to use the output directory to look for the
1395 # FreeSans.ttf font (which doxygen will put there itself). If you specify a
1396 # different font using DOT_FONTNAME you can set the path where dot
1397 # can find it using this tag.
1398
1399 DOT_FONTPATH =
1400
1401 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1402 # will generate a graph for each documented class showing the direct and
1403 # indirect inheritance relations. Setting this tag to YES will force the
1404 # the CLASS_DIAGRAMS tag to NO.
1405
1406 CLASS_GRAPH = YES
1407
1408 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1409 # will generate a graph for each documented class showing the direct and
1410 # indirect implementation dependencies (inheritance, containment, and
1411 # class references variables) of the class with other documented classes.
1412
1413 COLLABORATION_GRAPH = YES
1414
1415 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1416 # will generate a graph for groups, showing the direct groups dependencies
1417
1418 GROUP_GRAPHS = YES
1419
1420 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1421 # collaboration diagrams in a style similar to the OMG's Unified Modeling
1422 # Language.
1423
1424 UML_LOOK = NO
1425
1426 # If set to YES, the inheritance and collaboration graphs will show the
1427 # relations between templates and their instances.
1428
1429 TEMPLATE_RELATIONS = NO
1430
1431 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1432 # tags are set to YES then doxygen will generate a graph for each documented
1433 # file showing the direct and indirect include dependencies of the file with
1434 # other documented files.
1435
1436 INCLUDE_GRAPH = YES
1437
1438 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1439 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1440 # documented header file showing the documented files that directly or
1441 # indirectly include this file.
1442
1443 INCLUDED_BY_GRAPH = YES
1444
1445 # If the CALL_GRAPH and HAVE_DOT options are set to YES then
1446 # doxygen will generate a call dependency graph for every global function
1447 # or class method. Note that enabling this option will significantly increase
1448 # the time of a run. So in most cases it will be better to enable call graphs
1449 # for selected functions only using the \callgraph command.
1450
1451 CALL_GRAPH = YES
1452
1453 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1454 # doxygen will generate a caller dependency graph for every global function
1455 # or class method. Note that enabling this option will significantly increase
1456 # the time of a run. So in most cases it will be better to enable caller
1457 # graphs for selected functions only using the \callergraph command.
1458
1459 CALLER_GRAPH = YES
1460
1461 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1462 # will graphical hierarchy of all classes instead of a textual one.
1463
1464 GRAPHICAL_HIERARCHY = YES
1465
1466 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1467 # then doxygen will show the dependencies a directory has on other directories
1468 # in a graphical way. The dependency relations are determined by the #include
1469 # relations between the files in the directories.
1470
1471 DIRECTORY_GRAPH = YES
1472
1473 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1474 # generated by dot. Possible values are png, jpg, or gif
1475 # If left blank png will be used.
1476
1477 DOT_IMAGE_FORMAT = png
1478
1479 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1480 # found. If left blank, it is assumed the dot tool can be found in the path.
1481
1482 DOT_PATH =
1483
1484 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1485 # contain dot files that are included in the documentation (see the
1486 # \dotfile command).
1487
1488 DOTFILE_DIRS =
1489
1490 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1491 # nodes that will be shown in the graph. If the number of nodes in a graph
1492 # becomes larger than this value, doxygen will truncate the graph, which is
1493 # visualized by representing a node as a red box. Note that doxygen if the
1494 # number of direct children of the root node in a graph is already larger than
1495 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1496 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1497
1498 DOT_GRAPH_MAX_NODES = 50
1499
1500 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1501 # graphs generated by dot. A depth value of 3 means that only nodes reachable
1502 # from the root by following a path via at most 3 edges will be shown. Nodes
1503 # that lay further from the root node will be omitted. Note that setting this
1504 # option to 1 or 2 may greatly reduce the computation time needed for large
1505 # code bases. Also note that the size of a graph can be further restricted by
1506 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1507
1508 MAX_DOT_GRAPH_DEPTH = 0
1509
1510 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1511 # background. This is disabled by default, because dot on Windows does not
1512 # seem to support this out of the box. Warning: Depending on the platform used,
1513 # enabling this option may lead to badly anti-aliased labels on the edges of
1514 # a graph (i.e. they become hard to read).
1515
1516 DOT_TRANSPARENT = NO
1517
1518 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1519 # files in one run (i.e. multiple -o and -T options on the command line). This
1520 # makes dot run faster, but since only newer versions of dot (>1.8.10)
1521 # support this, this feature is disabled by default.
1522
1523 DOT_MULTI_TARGETS = NO
1524
1525 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1526 # generate a legend page explaining the meaning of the various boxes and
1527 # arrows in the dot generated graphs.
1528
1529 GENERATE_LEGEND = YES
1530
1531 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1532 # remove the intermediate dot files that are used to generate
1533 # the various graphs.
1534
1535 DOT_CLEANUP = YES
1536
1537 #---------------------------------------------------------------------------
1538 # Options related to the search engine
1539 #---------------------------------------------------------------------------
1540
1541 # The SEARCHENGINE tag specifies whether or not a search engine should be
1542 # used. If set to NO the values of all tags below this one will be ignored.
1543
1544 SEARCHENGINE = NO