| Geant4 Cross Reference |
1 # Doxyfile 1.3.4
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 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
18 # by quotes) that should identify the project.
19
20 PROJECT_NAME = G4vis_management
21
22 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
23 # This could be handy for archiving the generated documentation or
24 # if some version control system is used.
25
26 PROJECT_NUMBER =
27
28 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
29 # base path where the generated documentation will be put.
30 # If a relative path is entered, it will be relative to the location
31 # where doxygen was started. If left blank the current directory will be used.
32
33 OUTPUT_DIRECTORY = $(G4WORKDIR)/tmp/$(G4SYSTEM)/G4vis_management
34
35 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
36 # documentation generated by doxygen is written. Doxygen will use this
37 # information to generate all constant output in the proper language.
38 # The default language is English, other supported languages are:
39 # Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch,
40 # Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en
41 # (Japanese with English messages), Korean, Norwegian, Polish, Portuguese,
42 # Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
43
44 OUTPUT_LANGUAGE = English
45
46 # This tag can be used to specify the encoding used in the generated output.
47 # The encoding is not always determined by the language that is chosen,
48 # but also whether or not the output is meant for Windows or non-Windows users.
49 # In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES
50 # forces the Windows encoding (this is the default for the Windows binary),
51 # whereas setting the tag to NO uses a Unix-style encoding (the default for
52 # all platforms other than Windows).
53
54 USE_WINDOWS_ENCODING = NO
55
56 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
57 # include brief member descriptions after the members that are listed in
58 # the file and class documentation (similar to JavaDoc).
59 # Set to NO to disable this.
60
61 BRIEF_MEMBER_DESC = YES
62
63 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
64 # the brief description of a member or function before the detailed description.
65 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
66 # brief descriptions will be completely suppressed.
67
68 REPEAT_BRIEF = YES
69
70 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
71 # Doxygen will generate a detailed section even if there is only a brief
72 # description.
73
74 ALWAYS_DETAILED_SEC = NO
75
76 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited
77 # members of a class in the documentation of that class as if those members were
78 # ordinary class members. Constructors, destructors and assignment operators of
79 # the base classes will not be shown.
80
81 INLINE_INHERITED_MEMB = NO
82
83 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
84 # path before files name in the file list and in the header files. If set
85 # to NO the shortest path that makes the file name unique will be used.
86
87 FULL_PATH_NAMES = NO
88
89 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
90 # can be used to strip a user-defined part of the path. Stripping is
91 # only done if one of the specified strings matches the left-hand part of
92 # the path. It is allowed to use relative paths in the argument list.
93
94 STRIP_FROM_PATH =
95
96 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
97 # (but less readable) file names. This can be useful is your file systems
98 # doesn't support long names like on DOS, Mac, or CD-ROM.
99
100 SHORT_NAMES = NO
101
102 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
103 # will interpret the first line (until the first dot) of a JavaDoc-style
104 # comment as the brief description. If set to NO, the JavaDoc
105 # comments will behave just like the Qt-style comments (thus requiring an
106 # explict @brief command for a brief description.
107
108 JAVADOC_AUTOBRIEF = NO
109
110 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
111 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
112 # comments) as a brief description. This used to be the default behaviour.
113 # The new default is to treat a multi-line C++ comment block as a detailed
114 # description. Set this tag to YES if you prefer the old behaviour instead.
115
116 MULTILINE_CPP_IS_BRIEF = NO
117
118 # If the DETAILS_AT_TOP tag is set to YES then Doxygen
119 # will output the detailed description near the top, like JavaDoc.
120 # If set to NO, the detailed description appears after the member
121 # documentation.
122
123 DETAILS_AT_TOP = NO
124
125 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
126 # member inherits the documentation from any documented member that it
127 # reimplements.
128
129 INHERIT_DOCS = YES
130
131 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
132 # tag is set to YES, then doxygen will reuse the documentation of the first
133 # member in the group (if any) for the other members of the group. By default
134 # all members of a group must be documented explicitly.
135
136 DISTRIBUTE_GROUP_DOC = NO
137
138 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
139 # Doxygen uses this value to replace tabs by spaces in code fragments.
140
141 TAB_SIZE = 8
142
143 # This tag can be used to specify a number of aliases that acts
144 # as commands in the documentation. An alias has the form "name=value".
145 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
146 # put the command \sideeffect (or @sideeffect) in the documentation, which
147 # will result in a user-defined paragraph with heading "Side Effects:".
148 # You can put \n's in the value part of an alias to insert newlines.
149
150 ALIASES =
151
152 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
153 # only. Doxygen will then generate output that is more tailored for C.
154 # For instance, some of the names that are used will be different. The list
155 # of all members will be omitted, etc.
156
157 OPTIMIZE_OUTPUT_FOR_C = NO
158
159 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
160 # only. Doxygen will then generate output that is more tailored for Java.
161 # For instance, namespaces will be presented as packages, qualified scopes
162 # will look different, etc.
163
164 OPTIMIZE_OUTPUT_JAVA = NO
165
166 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
167 # the same type (for instance a group of public functions) to be put as a
168 # subgroup of that type (e.g. under the Public Functions section). Set it to
169 # NO to prevent subgrouping. Alternatively, this can be done per class using
170 # the \nosubgrouping command.
171
172 SUBGROUPING = YES
173
174 #---------------------------------------------------------------------------
175 # Build related configuration options
176 #---------------------------------------------------------------------------
177
178 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
179 # documentation are documented, even if no documentation was available.
180 # Private class members and static file members will be hidden unless
181 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
182
183 EXTRACT_ALL = YES
184
185 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
186 # will be included in the documentation.
187
188 EXTRACT_PRIVATE = NO
189
190 # If the EXTRACT_STATIC tag is set to YES all static members of a file
191 # will be included in the documentation.
192
193 EXTRACT_STATIC = NO
194
195 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
196 # defined locally in source files will be included in the documentation.
197 # If set to NO only classes defined in header files are included.
198
199 EXTRACT_LOCAL_CLASSES = YES
200
201 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
202 # undocumented members of documented classes, files or namespaces.
203 # If set to NO (the default) these members will be included in the
204 # various overviews, but no documentation section is generated.
205 # This option has no effect if EXTRACT_ALL is enabled.
206
207 HIDE_UNDOC_MEMBERS = NO
208
209 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
210 # undocumented classes that are normally visible in the class hierarchy.
211 # If set to NO (the default) these classes will be included in the various
212 # overviews. This option has no effect if EXTRACT_ALL is enabled.
213
214 HIDE_UNDOC_CLASSES = NO
215
216 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
217 # friend (class|struct|union) declarations.
218 # If set to NO (the default) these declarations will be included in the
219 # documentation.
220
221 HIDE_FRIEND_COMPOUNDS = NO
222
223 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
224 # documentation blocks found inside the body of a function.
225 # If set to NO (the default) these blocks will be appended to the
226 # function's detailed documentation block.
227
228 HIDE_IN_BODY_DOCS = NO
229
230 # The INTERNAL_DOCS tag determines if documentation
231 # that is typed after a \internal command is included. If the tag is set
232 # to NO (the default) then the documentation will be excluded.
233 # Set it to YES to include the internal documentation.
234
235 INTERNAL_DOCS = NO
236
237 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
238 # file names in lower-case letters. If set to YES upper-case letters are also
239 # allowed. This is useful if you have classes or files whose names only differ
240 # in case and if your file system supports case sensitive file names. Windows
241 # users are advised to set this option to NO.
242
243 CASE_SENSE_NAMES = YES
244
245 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
246 # will show members with their full class and namespace scopes in the
247 # documentation. If set to YES the scope will be hidden.
248
249 HIDE_SCOPE_NAMES = NO
250
251 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
252 # will put a list of the files that are included by a file in the documentation
253 # of that file.
254
255 SHOW_INCLUDE_FILES = YES
256
257 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
258 # is inserted in the documentation for inline members.
259
260 INLINE_INFO = YES
261
262 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
263 # will sort the (detailed) documentation of file and class members
264 # alphabetically by member name. If set to NO the members will appear in
265 # declaration order.
266
267 SORT_MEMBER_DOCS = YES
268
269 # The GENERATE_TODOLIST tag can be used to enable (YES) or
270 # disable (NO) the todo list. This list is created by putting \todo
271 # commands in the documentation.
272
273 GENERATE_TODOLIST = YES
274
275 # The GENERATE_TESTLIST tag can be used to enable (YES) or
276 # disable (NO) the test list. This list is created by putting \test
277 # commands in the documentation.
278
279 GENERATE_TESTLIST = YES
280
281 # The GENERATE_BUGLIST tag can be used to enable (YES) or
282 # disable (NO) the bug list. This list is created by putting \bug
283 # commands in the documentation.
284
285 GENERATE_BUGLIST = YES
286
287 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
288 # disable (NO) the deprecated list. This list is created by putting
289 # \deprecated commands in the documentation.
290
291 GENERATE_DEPRECATEDLIST= YES
292
293 # The ENABLED_SECTIONS tag can be used to enable conditional
294 # documentation sections, marked by \if sectionname ... \endif.
295
296 ENABLED_SECTIONS =
297
298 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
299 # the initial value of a variable or define consists of for it to appear in
300 # the documentation. If the initializer consists of more lines than specified
301 # here it will be hidden. Use a value of 0 to hide initializers completely.
302 # The appearance of the initializer of individual variables and defines in the
303 # documentation can be controlled using \showinitializer or \hideinitializer
304 # command in the documentation regardless of this setting.
305
306 MAX_INITIALIZER_LINES = 30
307
308 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
309 # at the bottom of the documentation of classes and structs. If set to YES the
310 # list will mention the files that were used to generate the documentation.
311
312 SHOW_USED_FILES = YES
313
314 #---------------------------------------------------------------------------
315 # configuration options related to warning and progress messages
316 #---------------------------------------------------------------------------
317
318 # The QUIET tag can be used to turn on/off the messages that are generated
319 # by doxygen. Possible values are YES and NO. If left blank NO is used.
320
321 QUIET = YES
322
323 # The WARNINGS tag can be used to turn on/off the warning messages that are
324 # generated by doxygen. Possible values are YES and NO. If left blank
325 # NO is used.
326
327 WARNINGS = YES
328
329 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
330 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
331 # automatically be disabled.
332
333 WARN_IF_UNDOCUMENTED = YES
334
335 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
336 # potential errors in the documentation, such as not documenting some
337 # parameters in a documented function, or documenting parameters that
338 # don't exist or using markup commands wrongly.
339
340 WARN_IF_DOC_ERROR = YES
341
342 # The WARN_FORMAT tag determines the format of the warning messages that
343 # doxygen can produce. The string should contain the $file, $line, and $text
344 # tags, which will be replaced by the file and line number from which the
345 # warning originated and the warning text.
346
347 WARN_FORMAT = "$file:$line: $text"
348
349 # The WARN_LOGFILE tag can be used to specify a file to which warning
350 # and error messages should be written. If left blank the output is written
351 # to stderr.
352
353 WARN_LOGFILE =
354
355 #---------------------------------------------------------------------------
356 # configuration options related to the input files
357 #---------------------------------------------------------------------------
358
359 # The INPUT tag can be used to specify the files and/or directories that contain
360 # documented source files. You may enter file names like "myfile.cpp" or
361 # directories like "/usr/src/myproject". Separate the files or directories
362 # with spaces.
363
364 INPUT = include \
365 src \
366 ../modeling/include \
367 ../modeling/src \
368 ../../graphics_reps/include/G4VGraphicsScene.hh \
369 ../../graphics_reps/include/G4VVisManager.hh \
370 ../../graphics_reps/src/G4VVisManager.cc
371
372 # If the value of the INPUT tag contains directories, you can use the
373 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
374 # and *.h) to filter out the source-files in the directories. If left
375 # blank the following patterns are tested:
376 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp
377 # *.h++ *.idl *.odl *.cs *.php *.php3 *.inc
378
379 FILE_PATTERNS =
380
381 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
382 # should be searched for input files as well. Possible values are YES and NO.
383 # If left blank NO is used.
384
385 RECURSIVE = NO
386
387 # The EXCLUDE tag can be used to specify files and/or directories that should
388 # excluded from the INPUT source files. This way you can easily exclude a
389 # subdirectory from a directory tree whose root is specified with the INPUT tag.
390
391 EXCLUDE =
392
393 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories
394 # that are symbolic links (a Unix filesystem feature) are excluded from the input.
395
396 EXCLUDE_SYMLINKS = NO
397
398 # If the value of the INPUT tag contains directories, you can use the
399 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
400 # certain files from those directories.
401
402 EXCLUDE_PATTERNS =
403
404 # The EXAMPLE_PATH tag can be used to specify one or more files or
405 # directories that contain example code fragments that are included (see
406 # the \include command).
407
408 EXAMPLE_PATH =
409
410 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
411 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
412 # and *.h) to filter out the source-files in the directories. If left
413 # blank all files are included.
414
415 EXAMPLE_PATTERNS =
416
417 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
418 # searched for input files to be used with the \include or \dontinclude
419 # commands irrespective of the value of the RECURSIVE tag.
420 # Possible values are YES and NO. If left blank NO is used.
421
422 EXAMPLE_RECURSIVE = NO
423
424 # The IMAGE_PATH tag can be used to specify one or more files or
425 # directories that contain image that are included in the documentation (see
426 # the \image command).
427
428 IMAGE_PATH =
429
430 # The INPUT_FILTER tag can be used to specify a program that doxygen should
431 # invoke to filter for each input file. Doxygen will invoke the filter program
432 # by executing (via popen()) the command <filter> <input-file>, where <filter>
433 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
434 # input file. Doxygen will then use the output that the filter program writes
435 # to standard output.
436
437 INPUT_FILTER =
438
439 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
440 # INPUT_FILTER) will be used to filter the input files when producing source
441 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
442
443 FILTER_SOURCE_FILES = NO
444
445 #---------------------------------------------------------------------------
446 # configuration options related to source browsing
447 #---------------------------------------------------------------------------
448
449 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
450 # be generated. Documented entities will be cross-referenced with these sources.
451
452 SOURCE_BROWSER = YES
453
454 # Setting the INLINE_SOURCES tag to YES will include the body
455 # of functions and classes directly in the documentation.
456
457 INLINE_SOURCES = NO
458
459 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
460 # doxygen to hide any special comment blocks from generated source code
461 # fragments. Normal C and C++ comments will always remain visible.
462
463 STRIP_CODE_COMMENTS = YES
464
465 # If the REFERENCED_BY_RELATION tag is set to YES (the default)
466 # then for each documented function all documented
467 # functions referencing it will be listed.
468
469 REFERENCED_BY_RELATION = YES
470
471 # If the REFERENCES_RELATION tag is set to YES (the default)
472 # then for each documented function all documented entities
473 # called/used by that function will be listed.
474
475 REFERENCES_RELATION = YES
476
477 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
478 # will generate a verbatim copy of the header file for each class for
479 # which an include is specified. Set to NO to disable this.
480
481 VERBATIM_HEADERS = YES
482
483 #---------------------------------------------------------------------------
484 # configuration options related to the alphabetical class index
485 #---------------------------------------------------------------------------
486
487 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
488 # of all compounds will be generated. Enable this if the project
489 # contains a lot of classes, structs, unions or interfaces.
490
491 ALPHABETICAL_INDEX = NO
492
493 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
494 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
495 # in which this list will be split (can be a number in the range [1..20])
496
497 COLS_IN_ALPHA_INDEX = 5
498
499 # In case all classes in a project start with a common prefix, all
500 # classes will be put under the same header in the alphabetical index.
501 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
502 # should be ignored while generating the index headers.
503
504 IGNORE_PREFIX =
505
506 #---------------------------------------------------------------------------
507 # configuration options related to the HTML output
508 #---------------------------------------------------------------------------
509
510 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
511 # generate HTML output.
512
513 GENERATE_HTML = YES
514
515 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
516 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
517 # put in front of it. If left blank `html' will be used as the default path.
518
519 HTML_OUTPUT = html
520
521 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
522 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
523 # doxygen will generate files with .html extension.
524
525 HTML_FILE_EXTENSION = .html
526
527 # The HTML_HEADER tag can be used to specify a personal HTML header for
528 # each generated HTML page. If it is left blank doxygen will generate a
529 # standard header.
530
531 HTML_HEADER =
532
533 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
534 # each generated HTML page. If it is left blank doxygen will generate a
535 # standard footer.
536
537 HTML_FOOTER =
538
539 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
540 # style sheet that is used by each HTML page. It can be used to
541 # fine-tune the look of the HTML output. If the tag is left blank doxygen
542 # will generate a default style sheet
543
544 HTML_STYLESHEET =
545
546 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
547 # files or namespaces will be aligned in HTML using tables. If set to
548 # NO a bullet list will be used.
549
550 HTML_ALIGN_MEMBERS = YES
551
552 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
553 # will be generated that can be used as input for tools like the
554 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
555 # of the generated HTML documentation.
556
557 GENERATE_HTMLHELP = NO
558
559 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
560 # be used to specify the file name of the resulting .chm file. You
561 # can add a path in front of the file if the result should not be
562 # written to the html output dir.
563
564 CHM_FILE =
565
566 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
567 # be used to specify the location (absolute path including file name) of
568 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
569 # the HTML help compiler on the generated index.hhp.
570
571 HHC_LOCATION =
572
573 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
574 # controls if a separate .chi index file is generated (YES) or that
575 # it should be included in the master .chm file (NO).
576
577 GENERATE_CHI = NO
578
579 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
580 # controls whether a binary table of contents is generated (YES) or a
581 # normal table of contents (NO) in the .chm file.
582
583 BINARY_TOC = NO
584
585 # The TOC_EXPAND flag can be set to YES to add extra items for group members
586 # to the contents of the HTML help documentation and to the tree view.
587
588 TOC_EXPAND = NO
589
590 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
591 # top of each HTML page. The value NO (the default) enables the index and
592 # the value YES disables it.
593
594 DISABLE_INDEX = NO
595
596 # This tag can be used to set the number of enum values (range [1..20])
597 # that doxygen will group on one line in the generated HTML documentation.
598
599 ENUM_VALUES_PER_LINE = 4
600
601 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
602 # generated containing a tree-like index structure (just like the one that
603 # is generated for HTML Help). For this to work a browser that supports
604 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
605 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
606 # probably better off using the HTML help feature.
607
608 GENERATE_TREEVIEW = NO
609
610 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
611 # used to set the initial width (in pixels) of the frame in which the tree
612 # is shown.
613
614 TREEVIEW_WIDTH = 250
615
616 #---------------------------------------------------------------------------
617 # configuration options related to the LaTeX output
618 #---------------------------------------------------------------------------
619
620 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
621 # generate Latex output.
622
623 GENERATE_LATEX = YES
624
625 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
626 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
627 # put in front of it. If left blank `latex' will be used as the default path.
628
629 LATEX_OUTPUT = latex
630
631 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
632 # invoked. If left blank `latex' will be used as the default command name.
633
634 LATEX_CMD_NAME = latex
635
636 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
637 # generate index for LaTeX. If left blank `makeindex' will be used as the
638 # default command name.
639
640 MAKEINDEX_CMD_NAME = makeindex
641
642 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
643 # LaTeX documents. This may be useful for small projects and may help to
644 # save some trees in general.
645
646 COMPACT_LATEX = NO
647
648 # The PAPER_TYPE tag can be used to set the paper type that is used
649 # by the printer. Possible values are: a4, a4wide, letter, legal and
650 # executive. If left blank a4wide will be used.
651
652 PAPER_TYPE = a4wide
653
654 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
655 # packages that should be included in the LaTeX output.
656
657 EXTRA_PACKAGES =
658
659 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
660 # the generated latex document. The header should contain everything until
661 # the first chapter. If it is left blank doxygen will generate a
662 # standard header. Notice: only use this tag if you know what you are doing!
663
664 LATEX_HEADER =
665
666 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
667 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
668 # contain links (just like the HTML output) instead of page references
669 # This makes the output suitable for online browsing using a pdf viewer.
670
671 PDF_HYPERLINKS = NO
672
673 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
674 # plain latex in the generated Makefile. Set this option to YES to get a
675 # higher quality PDF documentation.
676
677 USE_PDFLATEX = NO
678
679 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
680 # command to the generated LaTeX files. This will instruct LaTeX to keep
681 # running if errors occur, instead of asking the user for help.
682 # This option is also used when generating formulas in HTML.
683
684 LATEX_BATCHMODE = NO
685
686 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
687 # include the index chapters (such as File Index, Compound Index, etc.)
688 # in the output.
689
690 LATEX_HIDE_INDICES = NO
691
692 #---------------------------------------------------------------------------
693 # configuration options related to the RTF output
694 #---------------------------------------------------------------------------
695
696 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
697 # The RTF output is optimised for Word 97 and may not look very pretty with
698 # other RTF readers or editors.
699
700 GENERATE_RTF = NO
701
702 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
703 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
704 # put in front of it. If left blank `rtf' will be used as the default path.
705
706 RTF_OUTPUT = rtf
707
708 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
709 # RTF documents. This may be useful for small projects and may help to
710 # save some trees in general.
711
712 COMPACT_RTF = NO
713
714 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
715 # will contain hyperlink fields. The RTF file will
716 # contain links (just like the HTML output) instead of page references.
717 # This makes the output suitable for online browsing using WORD or other
718 # programs which support those fields.
719 # Note: wordpad (write) and others do not support links.
720
721 RTF_HYPERLINKS = NO
722
723 # Load stylesheet definitions from file. Syntax is similar to doxygen's
724 # config file, i.e. a series of assigments. You only have to provide
725 # replacements, missing definitions are set to their default value.
726
727 RTF_STYLESHEET_FILE =
728
729 # Set optional variables used in the generation of an rtf document.
730 # Syntax is similar to doxygen's config file.
731
732 RTF_EXTENSIONS_FILE =
733
734 #---------------------------------------------------------------------------
735 # configuration options related to the man page output
736 #---------------------------------------------------------------------------
737
738 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
739 # generate man pages
740
741 GENERATE_MAN = NO
742
743 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
744 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
745 # put in front of it. If left blank `man' will be used as the default path.
746
747 MAN_OUTPUT = man
748
749 # The MAN_EXTENSION tag determines the extension that is added to
750 # the generated man pages (default is the subroutine's section .3)
751
752 MAN_EXTENSION = .3
753
754 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
755 # then it will generate one additional man file for each entity
756 # documented in the real man page(s). These additional files
757 # only source the real man page, but without them the man command
758 # would be unable to find the correct page. The default is NO.
759
760 MAN_LINKS = NO
761
762 #---------------------------------------------------------------------------
763 # configuration options related to the XML output
764 #---------------------------------------------------------------------------
765
766 # If the GENERATE_XML tag is set to YES Doxygen will
767 # generate an XML file that captures the structure of
768 # the code including all documentation. Note that this
769 # feature is still experimental and incomplete at the
770 # moment.
771
772 GENERATE_XML = NO
773
774 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
775 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
776 # put in front of it. If left blank `xml' will be used as the default path.
777
778 XML_OUTPUT = xml
779
780 # The XML_SCHEMA tag can be used to specify an XML schema,
781 # which can be used by a validating XML parser to check the
782 # syntax of the XML files.
783
784 XML_SCHEMA =
785
786 # The XML_DTD tag can be used to specify an XML DTD,
787 # which can be used by a validating XML parser to check the
788 # syntax of the XML files.
789
790 XML_DTD =
791
792 #---------------------------------------------------------------------------
793 # configuration options for the AutoGen Definitions output
794 #---------------------------------------------------------------------------
795
796 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
797 # generate an AutoGen Definitions (see autogen.sf.net) file
798 # that captures the structure of the code including all
799 # documentation. Note that this feature is still experimental
800 # and incomplete at the moment.
801
802 GENERATE_AUTOGEN_DEF = NO
803
804 #---------------------------------------------------------------------------
805 # configuration options related to the Perl module output
806 #---------------------------------------------------------------------------
807
808 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
809 # generate a Perl module file that captures the structure of
810 # the code including all documentation. Note that this
811 # feature is still experimental and incomplete at the
812 # moment.
813
814 GENERATE_PERLMOD = NO
815
816 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
817 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
818 # to generate PDF and DVI output from the Perl module output.
819
820 PERLMOD_LATEX = NO
821
822 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
823 # nicely formatted so it can be parsed by a human reader. This is useful
824 # if you want to understand what is going on. On the other hand, if this
825 # tag is set to NO the size of the Perl module output will be much smaller
826 # and Perl will parse it just the same.
827
828 PERLMOD_PRETTY = YES
829
830 # The names of the make variables in the generated doxyrules.make file
831 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
832 # This is useful so different doxyrules.make files included by the same
833 # Makefile don't overwrite each other's variables.
834
835 PERLMOD_MAKEVAR_PREFIX =
836
837 #---------------------------------------------------------------------------
838 # Configuration options related to the preprocessor
839 #---------------------------------------------------------------------------
840
841 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
842 # evaluate all C-preprocessor directives found in the sources and include
843 # files.
844
845 ENABLE_PREPROCESSING = YES
846
847 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
848 # names in the source code. If set to NO (the default) only conditional
849 # compilation will be performed. Macro expansion can be done in a controlled
850 # way by setting EXPAND_ONLY_PREDEF to YES.
851
852 MACRO_EXPANSION = NO
853
854 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
855 # then the macro expansion is limited to the macros specified with the
856 # PREDEFINED and EXPAND_AS_PREDEFINED tags.
857
858 EXPAND_ONLY_PREDEF = NO
859
860 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
861 # in the INCLUDE_PATH (see below) will be search if a #include is found.
862
863 SEARCH_INCLUDES = YES
864
865 # The INCLUDE_PATH tag can be used to specify one or more directories that
866 # contain include files that are not input files but should be processed by
867 # the preprocessor.
868
869 INCLUDE_PATH =
870
871 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
872 # patterns (like *.h and *.hpp) to filter out the header-files in the
873 # directories. If left blank, the patterns specified with FILE_PATTERNS will
874 # be used.
875
876 INCLUDE_FILE_PATTERNS =
877
878 # The PREDEFINED tag can be used to specify one or more macro names that
879 # are defined before the preprocessor is started (similar to the -D option of
880 # gcc). The argument of the tag is a list of macros of the form: name
881 # or name=definition (no spaces). If the definition and the = are
882 # omitted =1 is assumed.
883
884 PREDEFINED =
885
886 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
887 # this tag can be used to specify a list of macro names that should be expanded.
888 # The macro definition that is found in the sources will be used.
889 # Use the PREDEFINED tag if you want to use a different macro definition.
890
891 EXPAND_AS_DEFINED =
892
893 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
894 # doxygen's preprocessor will remove all function-like macros that are alone
895 # on a line, have an all uppercase name, and do not end with a semicolon. Such
896 # function macros are typically used for boiler-plate code, and will confuse the
897 # parser if not removed.
898
899 SKIP_FUNCTION_MACROS = YES
900
901 #---------------------------------------------------------------------------
902 # Configuration::addtions related to external references
903 #---------------------------------------------------------------------------
904
905 # The TAGFILES option can be used to specify one or more tagfiles.
906 # Optionally an initial location of the external documentation
907 # can be added for each tagfile. The format of a tag file without
908 # this location is as follows:
909 # TAGFILES = file1 file2 ...
910 # Adding location for the tag files is done as follows:
911 # TAGFILES = file1=loc1 "file2 = loc2" ...
912 # where "loc1" and "loc2" can be relative or absolute paths or
913 # URLs. If a location is present for each tag, the installdox tool
914 # does not have to be run to correct the links.
915 # Note that each tag file must have a unique name
916 # (where the name does NOT include the path)
917 # If a tag file is not located in the directory in which doxygen
918 # is run, you must also specify the path to the tagfile here.
919
920 TAGFILES =
921
922 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
923 # a tag file that is based on the input files it reads.
924
925 GENERATE_TAGFILE =
926
927 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
928 # in the class index. If set to NO only the inherited external classes
929 # will be listed.
930
931 ALLEXTERNALS = NO
932
933 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
934 # in the modules index. If set to NO, only the current project's groups will
935 # be listed.
936
937 EXTERNAL_GROUPS = YES
938
939 # The PERL_PATH should be the absolute path and name of the perl script
940 # interpreter (i.e. the result of `which perl').
941
942 PERL_PATH = /usr/bin/perl
943
944 #---------------------------------------------------------------------------
945 # Configuration options related to the dot tool
946 #---------------------------------------------------------------------------
947
948 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
949 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or
950 # super classes. Setting the tag to NO turns the diagrams off. Note that this
951 # option is superceded by the HAVE_DOT option below. This is only a fallback. It is
952 # recommended to install and use dot, since it yields more powerful graphs.
953
954 CLASS_DIAGRAMS = YES
955
956 # If set to YES, the inheritance and collaboration graphs will hide
957 # inheritance and usage relations if the target is undocumented
958 # or is not a class.
959
960 HIDE_UNDOC_RELATIONS = YES
961
962 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
963 # available from the path. This tool is part of Graphviz, a graph visualization
964 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
965 # have no effect if this option is set to NO (the default)
966
967 HAVE_DOT = NO
968
969 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
970 # will generate a graph for each documented class showing the direct and
971 # indirect inheritance relations. Setting this tag to YES will force the
972 # the CLASS_DIAGRAMS tag to NO.
973
974 CLASS_GRAPH = YES
975
976 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
977 # will generate a graph for each documented class showing the direct and
978 # indirect implementation dependencies (inheritance, containment, and
979 # class references variables) of the class with other documented classes.
980
981 COLLABORATION_GRAPH = YES
982
983 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
984 # collaboration diagrams in a style similiar to the OMG's Unified Modeling
985 # Language.
986
987 UML_LOOK = NO
988
989 # If set to YES, the inheritance and collaboration graphs will show the
990 # relations between templates and their instances.
991
992 TEMPLATE_RELATIONS = YES
993
994 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
995 # tags are set to YES then doxygen will generate a graph for each documented
996 # file showing the direct and indirect include dependencies of the file with
997 # other documented files.
998
999 INCLUDE_GRAPH = YES
1000
1001 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1002 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1003 # documented header file showing the documented files that directly or
1004 # indirectly include this file.
1005
1006 INCLUDED_BY_GRAPH = YES
1007
1008 # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
1009 # generate a call dependency graph for every global function or class method.
1010 # Note that enabling this option will significantly increase the time of a run.
1011 # So in most cases it will be better to enable call graphs for selected
1012 # functions only using the \callgraph command.
1013
1014 CALL_GRAPH = NO
1015
1016 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1017 # will graphical hierarchy of all classes instead of a textual one.
1018
1019 GRAPHICAL_HIERARCHY = YES
1020
1021 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1022 # generated by dot. Possible values are png, jpg, or gif
1023 # If left blank png will be used.
1024
1025 DOT_IMAGE_FORMAT = gif
1026
1027 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1028 # found. If left blank, it is assumed the dot tool can be found on the path.
1029
1030 DOT_PATH =
1031
1032 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1033 # contain dot files that are included in the documentation (see the
1034 # \dotfile command).
1035
1036 DOTFILE_DIRS =
1037
1038 # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
1039 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
1040 # this value, doxygen will try to truncate the graph, so that it fits within
1041 # the specified constraint. Beware that most browsers cannot cope with very
1042 # large images.
1043
1044 MAX_DOT_GRAPH_WIDTH = 1024
1045
1046 # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
1047 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
1048 # this value, doxygen will try to truncate the graph, so that it fits within
1049 # the specified constraint. Beware that most browsers cannot cope with very
1050 # large images.
1051
1052 MAX_DOT_GRAPH_HEIGHT = 1024
1053
1054 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1055 # graphs generated by dot. A depth value of 3 means that only nodes reachable
1056 # from the root by following a path via at most 3 edges will be shown. Nodes that
1057 # lay further from the root node will be omitted. Note that setting this option to
1058 # 1 or 2 may greatly reduce the computation time needed for large code bases. Also
1059 # note that a graph may be further truncated if the graph's image dimensions are
1060 # not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT).
1061 # If 0 is used for the depth value (the default), the graph is not depth-constrained.
1062
1063 MAX_DOT_GRAPH_DEPTH = 0
1064
1065 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1066 # generate a legend page explaining the meaning of the various boxes and
1067 # arrows in the dot generated graphs.
1068
1069 GENERATE_LEGEND = YES
1070
1071 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1072 # remove the intermediate dot files that are used to generate
1073 # the various graphs.
1074
1075 DOT_CLEANUP = YES
1076
1077 #---------------------------------------------------------------------------
1078 # Configuration::addtions related to the search engine
1079 #---------------------------------------------------------------------------
1080
1081 # The SEARCHENGINE tag specifies whether or not a search engine should be
1082 # used. If set to NO the values of all tags below this one will be ignored.
1083
1084 SEARCHENGINE = NO