/[zanavi_public1]/navit/navit/maptool/poly2tri-c/002/Doxyfile
ZANavi

Contents of /navit/navit/maptool/poly2tri-c/002/Doxyfile

Parent Directory Parent Directory | Revision Log Revision Log


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

   
Visit the ZANavi Wiki