| Geant4 Cross Reference |
1 # Doxyfile 1.3.4
2
3 # This file describes the settings to be used
4 # doxygen (www.doxygen.org) for a project
5 #
6 # All text after a hash (#) is considered a co
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
12
13 #---------------------------------------------
14 # Project related configuration options
15 #---------------------------------------------
16
17 # The PROJECT_NAME tag is a single word (or a
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
23 # This could be handy for archiving the genera
24 # if some version control system is used.
25
26 PROJECT_NUMBER =
27
28 # The OUTPUT_DIRECTORY tag is used to specify
29 # base path where the generated documentation
30 # If a relative path is entered, it will be re
31 # where doxygen was started. If left blank the
32
33 OUTPUT_DIRECTORY = $(G4WORKDIR)/tmp/$(G4
34
35 # The OUTPUT_LANGUAGE tag is used to specify t
36 # documentation generated by doxygen is writte
37 # information to generate all constant output
38 # The default language is English, other suppo
39 # Brazilian, Catalan, Chinese, Chinese-Traditi
40 # Finnish, French, German, Greek, Hungarian, I
41 # (Japanese with English messages), Korean, No
42 # Romanian, Russian, Serbian, Slovak, Slovene,
43
44 OUTPUT_LANGUAGE = English
45
46 # This tag can be used to specify the encoding
47 # The encoding is not always determined by the
48 # but also whether or not the output is meant
49 # In case there is a difference, setting the U
50 # forces the Windows encoding (this is the def
51 # whereas setting the tag to NO uses a Unix-st
52 # all platforms other than Windows).
53
54 USE_WINDOWS_ENCODING = NO
55
56 # If the BRIEF_MEMBER_DESC tag is set to YES (
57 # include brief member descriptions after the
58 # the file and class documentation (similar to
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 d
64 # the brief description of a member or functio
65 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_M
66 # brief descriptions will be completely suppre
67
68 REPEAT_BRIEF = YES
69
70 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF
71 # Doxygen will generate a detailed section eve
72 # description.
73
74 ALWAYS_DETAILED_SEC = NO
75
76 # If the INLINE_INHERITED_MEMB tag is set to Y
77 # members of a class in the documentation of t
78 # ordinary class members. Constructors, destru
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 the
84 # path before files name in the file list and
85 # to NO the shortest path that makes the file
86
87 FULL_PATH_NAMES = NO
88
89 # If the FULL_PATH_NAMES tag is set to YES the
90 # can be used to strip a user-defined part of
91 # only done if one of the specified strings ma
92 # the path. It is allowed to use relative path
93
94 STRIP_FROM_PATH =
95
96 # If the SHORT_NAMES tag is set to YES, doxyge
97 # (but less readable) file names. This can be
98 # doesn't support long names like on DOS, Mac,
99
100 SHORT_NAMES = NO
101
102 # If the JAVADOC_AUTOBRIEF tag is set to YES t
103 # will interpret the first line (until the fir
104 # comment as the brief description. If set to
105 # comments will behave just like the Qt-style
106 # explict @brief command for a brief descripti
107
108 JAVADOC_AUTOBRIEF = NO
109
110 # The MULTILINE_CPP_IS_BRIEF tag can be set to
111 # treat a multi-line C++ special comment block
112 # comments) as a brief description. This used
113 # The new default is to treat a multi-line C++
114 # description. Set this tag to YES if you pref
115
116 MULTILINE_CPP_IS_BRIEF = NO
117
118 # If the DETAILS_AT_TOP tag is set to YES then
119 # will output the detailed description near th
120 # If set to NO, the detailed description appea
121 # documentation.
122
123 DETAILS_AT_TOP = NO
124
125 # If the INHERIT_DOCS tag is set to YES (the d
126 # member inherits the documentation from any d
127 # reimplements.
128
129 INHERIT_DOCS = YES
130
131 # If member grouping is used in the documentat
132 # tag is set to YES, then doxygen will reuse t
133 # member in the group (if any) for the other m
134 # all members of a group must be documented ex
135
136 DISTRIBUTE_GROUP_DOC = NO
137
138 # The TAB_SIZE tag can be used to set the numb
139 # Doxygen uses this value to replace tabs by s
140
141 TAB_SIZE = 8
142
143 # This tag can be used to specify a number of
144 # as commands in the documentation. An alias h
145 # For example adding "sideeffect=\par Side Eff
146 # put the command \sideeffect (or @sideeffect)
147 # will result in a user-defined paragraph with
148 # You can put \n's in the value part of an ali
149
150 ALIASES =
151
152 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if
153 # only. Doxygen will then generate output that
154 # For instance, some of the names that are use
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 y
160 # only. Doxygen will then generate output that
161 # For instance, namespaces will be presented a
162 # will look different, etc.
163
164 OPTIMIZE_OUTPUT_JAVA = NO
165
166 # Set the SUBGROUPING tag to YES (the default)
167 # the same type (for instance a group of publi
168 # subgroup of that type (e.g. under the Public
169 # NO to prevent subgrouping. Alternatively, th
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
179 # documentation are documented, even if no doc
180 # Private class members and static file member
181 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags
182
183 EXTRACT_ALL = YES
184
185 # If the EXTRACT_PRIVATE tag is set to YES all
186 # will be included in the documentation.
187
188 EXTRACT_PRIVATE = NO
189
190 # If the EXTRACT_STATIC tag is set to YES all
191 # will be included in the documentation.
192
193 EXTRACT_STATIC = NO
194
195 # If the EXTRACT_LOCAL_CLASSES tag is set to Y
196 # defined locally in source files will be incl
197 # If set to NO only classes defined in header
198
199 EXTRACT_LOCAL_CLASSES = YES
200
201 # If the HIDE_UNDOC_MEMBERS tag is set to YES,
202 # undocumented members of documented classes,
203 # If set to NO (the default) these members wil
204 # various overviews, but no documentation sect
205 # This option has no effect if EXTRACT_ALL is
206
207 HIDE_UNDOC_MEMBERS = NO
208
209 # If the HIDE_UNDOC_CLASSES tag is set to YES,
210 # undocumented classes that are normally visib
211 # If set to NO (the default) these classes wil
212 # overviews. This option has no effect if EXTR
213
214 HIDE_UNDOC_CLASSES = NO
215
216 # If the HIDE_FRIEND_COMPOUNDS tag is set to Y
217 # friend (class|struct|union) declarations.
218 # If set to NO (the default) these declaration
219 # documentation.
220
221 HIDE_FRIEND_COMPOUNDS = NO
222
223 # If the HIDE_IN_BODY_DOCS tag is set to YES,
224 # documentation blocks found inside the body o
225 # If set to NO (the default) these blocks will
226 # function's detailed documentation block.
227
228 HIDE_IN_BODY_DOCS = NO
229
230 # The INTERNAL_DOCS tag determines if document
231 # that is typed after a \internal command is i
232 # to NO (the default) then the documentation w
233 # Set it to YES to include the internal docume
234
235 INTERNAL_DOCS = NO
236
237 # If the CASE_SENSE_NAMES tag is set to NO the
238 # file names in lower-case letters. If set to
239 # allowed. This is useful if you have classes
240 # in case and if your file system supports cas
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 (th
246 # will show members with their full class and
247 # documentation. If set to YES the scope will
248
249 HIDE_SCOPE_NAMES = NO
250
251 # If the SHOW_INCLUDE_FILES tag is set to YES
252 # will put a list of the files that are includ
253 # of that file.
254
255 SHOW_INCLUDE_FILES = YES
256
257 # If the INLINE_INFO tag is set to YES (the de
258 # is inserted in the documentation for inline
259
260 INLINE_INFO = YES
261
262 # If the SORT_MEMBER_DOCS tag is set to YES (t
263 # will sort the (detailed) documentation of fi
264 # alphabetically by member name. If set to NO
265 # declaration order.
266
267 SORT_MEMBER_DOCS = YES
268
269 # The GENERATE_TODOLIST tag can be used to ena
270 # disable (NO) the todo list. This list is cre
271 # commands in the documentation.
272
273 GENERATE_TODOLIST = YES
274
275 # The GENERATE_TESTLIST tag can be used to ena
276 # disable (NO) the test list. This list is cre
277 # commands in the documentation.
278
279 GENERATE_TESTLIST = YES
280
281 # The GENERATE_BUGLIST tag can be used to enab
282 # disable (NO) the bug list. This list is crea
283 # commands in the documentation.
284
285 GENERATE_BUGLIST = YES
286
287 # The GENERATE_DEPRECATEDLIST tag can be used
288 # disable (NO) the deprecated list. This list
289 # \deprecated commands in the documentation.
290
291 GENERATE_DEPRECATEDLIST= YES
292
293 # The ENABLED_SECTIONS tag can be used to enab
294 # documentation sections, marked by \if sectio
295
296 ENABLED_SECTIONS =
297
298 # The MAX_INITIALIZER_LINES tag determines the
299 # the initial value of a variable or define co
300 # the documentation. If the initializer consis
301 # here it will be hidden. Use a value of 0 to
302 # The appearance of the initializer of individ
303 # documentation can be controlled using \showi
304 # command in the documentation regardless of t
305
306 MAX_INITIALIZER_LINES = 30
307
308 # Set the SHOW_USED_FILES tag to NO to disable
309 # at the bottom of the documentation of classe
310 # list will mention the files that were used t
311
312 SHOW_USED_FILES = YES
313
314 #---------------------------------------------
315 # configuration options related to warning and
316 #---------------------------------------------
317
318 # The QUIET tag can be used to turn on/off the
319 # by doxygen. Possible values are YES and NO.
320
321 QUIET = YES
322
323 # The WARNINGS tag can be used to turn on/off
324 # generated by doxygen. Possible values are YE
325 # NO is used.
326
327 WARNINGS = YES
328
329 # If WARN_IF_UNDOCUMENTED is set to YES, then
330 # for undocumented members. If EXTRACT_ALL is
331 # automatically be disabled.
332
333 WARN_IF_UNDOCUMENTED = YES
334
335 # If WARN_IF_DOC_ERROR is set to YES, doxygen
336 # potential errors in the documentation, such
337 # parameters in a documented function, or docu
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
343 # doxygen can produce. The string should conta
344 # tags, which will be replaced by the file and
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
350 # and error messages should be written. If lef
351 # to stderr.
352
353 WARN_LOGFILE =
354
355 #---------------------------------------------
356 # configuration options related to the input f
357 #---------------------------------------------
358
359 # The INPUT tag can be used to specify the fil
360 # documented source files. You may enter file
361 # directories like "/usr/src/myproject". Separ
362 # with spaces.
363
364 INPUT = include \
365 src \
366 ../modeling/include \
367 ../modeling/src \
368 ../../graphics_reps/i
369 ../../graphics_reps/i
370 ../../graphics_reps/s
371
372 # If the value of the INPUT tag contains direc
373 # FILE_PATTERNS tag to specify one or more wil
374 # and *.h) to filter out the source-files in t
375 # blank the following patterns are tested:
376 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx
377 # *.h++ *.idl *.odl *.cs *.php *.php3 *.inc
378
379 FILE_PATTERNS =
380
381 # The RECURSIVE tag can be used to turn specif
382 # should be searched for input files as well.
383 # If left blank NO is used.
384
385 RECURSIVE = NO
386
387 # The EXCLUDE tag can be used to specify files
388 # excluded from the INPUT source files. This w
389 # subdirectory from a directory tree whose roo
390
391 EXCLUDE =
392
393 # The EXCLUDE_SYMLINKS tag can be used select
394 # that are symbolic links (a Unix filesystem f
395
396 EXCLUDE_SYMLINKS = NO
397
398 # If the value of the INPUT tag contains direc
399 # EXCLUDE_PATTERNS tag to specify one or more
400 # certain files from those directories.
401
402 EXCLUDE_PATTERNS =
403
404 # The EXAMPLE_PATH tag can be used to specify
405 # directories that contain example code fragme
406 # the \include command).
407
408 EXAMPLE_PATH =
409
410 # If the value of the EXAMPLE_PATH tag contain
411 # EXAMPLE_PATTERNS tag to specify one or more
412 # and *.h) to filter out the source-files in t
413 # blank all files are included.
414
415 EXAMPLE_PATTERNS =
416
417 # If the EXAMPLE_RECURSIVE tag is set to YES t
418 # searched for input files to be used with the
419 # commands irrespective of the value of the RE
420 # Possible values are YES and NO. If left blan
421
422 EXAMPLE_RECURSIVE = NO
423
424 # The IMAGE_PATH tag can be used to specify on
425 # directories that contain image that are incl
426 # the \image command).
427
428 IMAGE_PATH =
429
430 # The INPUT_FILTER tag can be used to specify
431 # invoke to filter for each input file. Doxyge
432 # by executing (via popen()) the command <filt
433 # is the value of the INPUT_FILTER tag, and <i
434 # input file. Doxygen will then use the output
435 # to standard output.
436
437 INPUT_FILTER =
438
439 # If the FILTER_SOURCE_FILES tag is set to YES
440 # INPUT_FILTER) will be used to filter the inp
441 # files to browse (i.e. when SOURCE_BROWSER is
442
443 FILTER_SOURCE_FILES = NO
444
445 #---------------------------------------------
446 # configuration options related to source brow
447 #---------------------------------------------
448
449 # If the SOURCE_BROWSER tag is set to YES then
450 # be generated. Documented entities will be cr
451
452 SOURCE_BROWSER = YES
453
454 # Setting the INLINE_SOURCES tag to YES will i
455 # of functions and classes directly in the doc
456
457 INLINE_SOURCES = NO
458
459 # Setting the STRIP_CODE_COMMENTS tag to YES (
460 # doxygen to hide any special comment blocks f
461 # fragments. Normal C and C++ comments will al
462
463 STRIP_CODE_COMMENTS = YES
464
465 # If the REFERENCED_BY_RELATION tag is set to
466 # then for each documented function all docume
467 # functions referencing it will be listed.
468
469 REFERENCED_BY_RELATION = YES
470
471 # If the REFERENCES_RELATION tag is set to YES
472 # then for each documented function all docume
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 (t
478 # will generate a verbatim copy of the header
479 # which an include is specified. Set to NO to
480
481 VERBATIM_HEADERS = YES
482
483 #---------------------------------------------
484 # configuration options related to the alphabe
485 #---------------------------------------------
486
487 # If the ALPHABETICAL_INDEX tag is set to YES,
488 # of all compounds will be generated. Enable t
489 # contains a lot of classes, structs, unions o
490
491 ALPHABETICAL_INDEX = NO
492
493 # If the alphabetical index is enabled (see AL
494 # the COLS_IN_ALPHA_INDEX tag can be used to s
495 # in which this list will be split (can be a n
496
497 COLS_IN_ALPHA_INDEX = 5
498
499 # In case all classes in a project start with
500 # classes will be put under the same header in
501 # The IGNORE_PREFIX tag can be used to specify
502 # should be ignored while generating the index
503
504 IGNORE_PREFIX =
505
506 #---------------------------------------------
507 # configuration options related to the HTML ou
508 #---------------------------------------------
509
510 # If the GENERATE_HTML tag is set to YES (the
511 # generate HTML output.
512
513 GENERATE_HTML = YES
514
515 # The HTML_OUTPUT tag is used to specify where
516 # If a relative path is entered the value of O
517 # put in front of it. If left blank `html' wil
518
519 HTML_OUTPUT = html
520
521 # The HTML_FILE_EXTENSION tag can be used to s
522 # each generated HTML page (for example: .htm,
523 # doxygen will generate files with .html exten
524
525 HTML_FILE_EXTENSION = .html
526
527 # The HTML_HEADER tag can be used to specify a
528 # each generated HTML page. If it is left blan
529 # standard header.
530
531 HTML_HEADER =
532
533 # The HTML_FOOTER tag can be used to specify a
534 # each generated HTML page. If it is left blan
535 # standard footer.
536
537 HTML_FOOTER =
538
539 # The HTML_STYLESHEET tag can be used to speci
540 # style sheet that is used by each HTML page.
541 # fine-tune the look of the HTML output. If th
542 # will generate a default style sheet
543
544 HTML_STYLESHEET =
545
546 # If the HTML_ALIGN_MEMBERS tag is set to YES,
547 # files or namespaces will be aligned in HTML
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,
553 # will be generated that can be used as input
554 # Microsoft HTML help workshop to generate a c
555 # of the generated HTML documentation.
556
557 GENERATE_HTMLHELP = NO
558
559 # If the GENERATE_HTMLHELP tag is set to YES,
560 # be used to specify the file name of the resu
561 # can add a path in front of the file if the r
562 # written to the html output dir.
563
564 CHM_FILE =
565
566 # If the GENERATE_HTMLHELP tag is set to YES,
567 # be used to specify the location (absolute pa
568 # the HTML help compiler (hhc.exe). If non-emp
569 # the HTML help compiler on the generated inde
570
571 HHC_LOCATION =
572
573 # If the GENERATE_HTMLHELP tag is set to YES,
574 # controls if a separate .chi index file is ge
575 # it should be included in the master .chm fil
576
577 GENERATE_CHI = NO
578
579 # If the GENERATE_HTMLHELP tag is set to YES,
580 # controls whether a binary table of contents
581 # normal table of contents (NO) in the .chm fi
582
583 BINARY_TOC = NO
584
585 # The TOC_EXPAND flag can be set to YES to add
586 # to the contents of the HTML help documentati
587
588 TOC_EXPAND = NO
589
590 # The DISABLE_INDEX tag can be used to turn on
591 # top of each HTML page. The value NO (the def
592 # the value YES disables it.
593
594 DISABLE_INDEX = NO
595
596 # This tag can be used to set the number of en
597 # that doxygen will group on one line in the g
598
599 ENUM_VALUES_PER_LINE = 4
600
601 # If the GENERATE_TREEVIEW tag is set to YES,
602 # generated containing a tree-like index struc
603 # is generated for HTML Help). For this to wor
604 # JavaScript, DHTML, CSS and frames is require
605 # Netscape 6.0+, Internet explorer 5.0+, or Ko
606 # probably better off using the HTML help feat
607
608 GENERATE_TREEVIEW = NO
609
610 # If the treeview is enabled (see GENERATE_TRE
611 # used to set the initial width (in pixels) of
612 # is shown.
613
614 TREEVIEW_WIDTH = 250
615
616 #---------------------------------------------
617 # configuration options related to the LaTeX o
618 #---------------------------------------------
619
620 # If the GENERATE_LATEX tag is set to YES (the
621 # generate Latex output.
622
623 GENERATE_LATEX = YES
624
625 # The LATEX_OUTPUT tag is used to specify wher
626 # If a relative path is entered the value of O
627 # put in front of it. If left blank `latex' wi
628
629 LATEX_OUTPUT = latex
630
631 # The LATEX_CMD_NAME tag can be used to specif
632 # invoked. If left blank `latex' will be used
633
634 LATEX_CMD_NAME = latex
635
636 # The MAKEINDEX_CMD_NAME tag can be used to sp
637 # generate index for LaTeX. If left blank `mak
638 # default command name.
639
640 MAKEINDEX_CMD_NAME = makeindex
641
642 # If the COMPACT_LATEX tag is set to YES Doxyg
643 # LaTeX documents. This may be useful for smal
644 # save some trees in general.
645
646 COMPACT_LATEX = NO
647
648 # The PAPER_TYPE tag can be used to set the pa
649 # by the printer. Possible values are: a4, a4w
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
655 # packages that should be included in the LaTe
656
657 EXTRA_PACKAGES =
658
659 # The LATEX_HEADER tag can be used to specify
660 # the generated latex document. The header sho
661 # the first chapter. If it is left blank doxyg
662 # standard header. Notice: only use this tag i
663
664 LATEX_HEADER =
665
666 # If the PDF_HYPERLINKS tag is set to YES, the
667 # is prepared for conversion to pdf (using ps2
668 # contain links (just like the HTML output) in
669 # This makes the output suitable for online br
670
671 PDF_HYPERLINKS = NO
672
673 # If the USE_PDFLATEX tag is set to YES, pdfla
674 # plain latex in the generated Makefile. Set t
675 # higher quality PDF documentation.
676
677 USE_PDFLATEX = NO
678
679 # If the LATEX_BATCHMODE tag is set to YES, do
680 # command to the generated LaTeX files. This w
681 # running if errors occur, instead of asking t
682 # This option is also used when generating for
683
684 LATEX_BATCHMODE = NO
685
686 # If LATEX_HIDE_INDICES is set to YES then dox
687 # include the index chapters (such as File Ind
688 # in the output.
689
690 LATEX_HIDE_INDICES = NO
691
692 #---------------------------------------------
693 # configuration options related to the RTF out
694 #---------------------------------------------
695
696 # If the GENERATE_RTF tag is set to YES Doxyge
697 # The RTF output is optimised for Word 97 and
698 # other RTF readers or editors.
699
700 GENERATE_RTF = NO
701
702 # The RTF_OUTPUT tag is used to specify where
703 # If a relative path is entered the value of O
704 # put in front of it. If left blank `rtf' will
705
706 RTF_OUTPUT = rtf
707
708 # If the COMPACT_RTF tag is set to YES Doxygen
709 # RTF documents. This may be useful for small
710 # save some trees in general.
711
712 COMPACT_RTF = NO
713
714 # If the RTF_HYPERLINKS tag is set to YES, the
715 # will contain hyperlink fields. The RTF file
716 # contain links (just like the HTML output) in
717 # This makes the output suitable for online br
718 # programs which support those fields.
719 # Note: wordpad (write) and others do not supp
720
721 RTF_HYPERLINKS = NO
722
723 # Load stylesheet definitions from file. Synta
724 # config file, i.e. a series of assigments. Yo
725 # replacements, missing definitions are set to
726
727 RTF_STYLESHEET_FILE =
728
729 # Set optional variables used in the generatio
730 # Syntax is similar to doxygen's config file.
731
732 RTF_EXTENSIONS_FILE =
733
734 #---------------------------------------------
735 # configuration options related to the man pag
736 #---------------------------------------------
737
738 # If the GENERATE_MAN tag is set to YES (the d
739 # generate man pages
740
741 GENERATE_MAN = NO
742
743 # The MAN_OUTPUT tag is used to specify where
744 # If a relative path is entered the value of O
745 # put in front of it. If left blank `man' will
746
747 MAN_OUTPUT = man
748
749 # The MAN_EXTENSION tag determines the extensi
750 # the generated man pages (default is the subr
751
752 MAN_EXTENSION = .3
753
754 # If the MAN_LINKS tag is set to YES and Doxyg
755 # then it will generate one additional man fil
756 # documented in the real man page(s). These ad
757 # only source the real man page, but without t
758 # would be unable to find the correct page. Th
759
760 MAN_LINKS = NO
761
762 #---------------------------------------------
763 # configuration options related to the XML out
764 #---------------------------------------------
765
766 # If the GENERATE_XML tag is set to YES Doxyge
767 # generate an XML file that captures the struc
768 # the code including all documentation. Note t
769 # feature is still experimental and incomplete
770 # moment.
771
772 GENERATE_XML = NO
773
774 # The XML_OUTPUT tag is used to specify where
775 # If a relative path is entered the value of O
776 # put in front of it. If left blank `xml' will
777
778 XML_OUTPUT = xml
779
780 # The XML_SCHEMA tag can be used to specify an
781 # which can be used by a validating XML parser
782 # syntax of the XML files.
783
784 XML_SCHEMA =
785
786 # The XML_DTD tag can be used to specify an XM
787 # which can be used by a validating XML parser
788 # syntax of the XML files.
789
790 XML_DTD =
791
792 #---------------------------------------------
793 # configuration options for the AutoGen Defini
794 #---------------------------------------------
795
796 # If the GENERATE_AUTOGEN_DEF tag is set to YE
797 # generate an AutoGen Definitions (see autogen
798 # that captures the structure of the code incl
799 # documentation. Note that this feature is sti
800 # and incomplete at the moment.
801
802 GENERATE_AUTOGEN_DEF = NO
803
804 #---------------------------------------------
805 # configuration options related to the Perl mo
806 #---------------------------------------------
807
808 # If the GENERATE_PERLMOD tag is set to YES Do
809 # generate a Perl module file that captures th
810 # the code including all documentation. Note t
811 # feature is still experimental and incomplete
812 # moment.
813
814 GENERATE_PERLMOD = NO
815
816 # If the PERLMOD_LATEX tag is set to YES Doxyg
817 # the necessary Makefile rules, Perl scripts a
818 # to generate PDF and DVI output from the Perl
819
820 PERLMOD_LATEX = NO
821
822 # If the PERLMOD_PRETTY tag is set to YES the
823 # nicely formatted so it can be parsed by a hu
824 # if you want to understand what is going on.
825 # tag is set to NO the size of the Perl module
826 # and Perl will parse it just the same.
827
828 PERLMOD_PRETTY = YES
829
830 # The names of the make variables in the gener
831 # are prefixed with the string contained in PE
832 # This is useful so different doxyrules.make f
833 # Makefile don't overwrite each other's variab
834
835 PERLMOD_MAKEVAR_PREFIX =
836
837 #---------------------------------------------
838 # Configuration options related to the preproc
839 #---------------------------------------------
840
841 # If the ENABLE_PREPROCESSING tag is set to YE
842 # evaluate all C-preprocessor directives found
843 # files.
844
845 ENABLE_PREPROCESSING = YES
846
847 # If the MACRO_EXPANSION tag is set to YES Dox
848 # names in the source code. If set to NO (the
849 # compilation will be performed. Macro expansi
850 # way by setting EXPAND_ONLY_PREDEF to YES.
851
852 MACRO_EXPANSION = NO
853
854 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSIO
855 # then the macro expansion is limited to the m
856 # PREDEFINED and EXPAND_AS_PREDEFINED tags.
857
858 EXPAND_ONLY_PREDEF = NO
859
860 # If the SEARCH_INCLUDES tag is set to YES (th
861 # in the INCLUDE_PATH (see below) will be sear
862
863 SEARCH_INCLUDES = YES
864
865 # The INCLUDE_PATH tag can be used to specify
866 # contain include files that are not input fil
867 # the preprocessor.
868
869 INCLUDE_PATH =
870
871 # You can use the INCLUDE_FILE_PATTERNS tag to
872 # patterns (like *.h and *.hpp) to filter out
873 # directories. If left blank, the patterns spe
874 # be used.
875
876 INCLUDE_FILE_PATTERNS =
877
878 # The PREDEFINED tag can be used to specify on
879 # are defined before the preprocessor is start
880 # gcc). The argument of the tag is a list of m
881 # or name=definition (no spaces). If the defin
882 # omitted =1 is assumed.
883
884 PREDEFINED =
885
886 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDE
887 # this tag can be used to specify a list of ma
888 # The macro definition that is found in the so
889 # Use the PREDEFINED tag if you want to use a
890
891 EXPAND_AS_DEFINED =
892
893 # If the SKIP_FUNCTION_MACROS tag is set to YE
894 # doxygen's preprocessor will remove all funct
895 # on a line, have an all uppercase name, and d
896 # function macros are typically used for boile
897 # parser if not removed.
898
899 SKIP_FUNCTION_MACROS = YES
900
901 #---------------------------------------------
902 # Configuration::addtions related to external
903 #---------------------------------------------
904
905 # The TAGFILES option can be used to specify o
906 # Optionally an initial location of the extern
907 # can be added for each tagfile. The format of
908 # this location is as follows:
909 # TAGFILES = file1 file2 ...
910 # Adding location for the tag files is done as
911 # TAGFILES = file1=loc1 "file2 = loc2" ...
912 # where "loc1" and "loc2" can be relative or a
913 # URLs. If a location is present for each tag,
914 # does not have to be run to correct the links
915 # Note that each tag file must have a unique n
916 # (where the name does NOT include the path)
917 # If a tag file is not located in the director
918 # is run, you must also specify the path to th
919
920 TAGFILES =
921
922 # When a file name is specified after GENERATE
923 # a tag file that is based on the input files
924
925 GENERATE_TAGFILE =
926
927 # If the ALLEXTERNALS tag is set to YES all ex
928 # in the class index. If set to NO only the in
929 # will be listed.
930
931 ALLEXTERNALS = NO
932
933 # If the EXTERNAL_GROUPS tag is set to YES all
934 # in the modules index. If set to NO, only the
935 # be listed.
936
937 EXTERNAL_GROUPS = YES
938
939 # The PERL_PATH should be the absolute path an
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 too
946 #---------------------------------------------
947
948 # If the CLASS_DIAGRAMS tag is set to YES (the
949 # generate a inheritance diagram (in HTML, RTF
950 # super classes. Setting the tag to NO turns t
951 # option is superceded by the HAVE_DOT option
952 # recommended to install and use dot, since it
953
954 CLASS_DIAGRAMS = YES
955
956 # If set to YES, the inheritance and collabora
957 # inheritance and usage relations if the targe
958 # or is not a class.
959
960 HIDE_UNDOC_RELATIONS = YES
961
962 # If you set the HAVE_DOT tag to YES then doxy
963 # available from the path. This tool is part o
964 # toolkit from AT&T and Lucent Bell Labs. The
965 # have no effect if this option is set to NO (
966
967 HAVE_DOT = NO
968
969 # If the CLASS_GRAPH and HAVE_DOT tags are set
970 # will generate a graph for each documented cl
971 # indirect inheritance relations. Setting this
972 # the CLASS_DIAGRAMS tag to NO.
973
974 CLASS_GRAPH = YES
975
976 # If the COLLABORATION_GRAPH and HAVE_DOT tags
977 # will generate a graph for each documented cl
978 # indirect implementation dependencies (inheri
979 # class references variables) of the class wit
980
981 COLLABORATION_GRAPH = YES
982
983 # If the UML_LOOK tag is set to YES doxygen wi
984 # collaboration diagrams in a style similiar t
985 # Language.
986
987 UML_LOOK = NO
988
989 # If set to YES, the inheritance and collabora
990 # relations between templates and their instan
991
992 TEMPLATE_RELATIONS = YES
993
994 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES
995 # tags are set to YES then doxygen will genera
996 # file showing the direct and indirect include
997 # other documented files.
998
999 INCLUDE_GRAPH = YES
1000
1001 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDE
1002 # HAVE_DOT tags are set to YES then doxygen w
1003 # documented header file showing the document
1004 # indirectly include this file.
1005
1006 INCLUDED_BY_GRAPH = YES
1007
1008 # If the CALL_GRAPH and HAVE_DOT tags are set
1009 # generate a call dependency graph for every
1010 # Note that enabling this option will signifi
1011 # So in most cases it will be better to enabl
1012 # functions only using the \callgraph command
1013
1014 CALL_GRAPH = NO
1015
1016 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tag
1017 # will graphical hierarchy of all classes ins
1018
1019 GRAPHICAL_HIERARCHY = YES
1020
1021 # The DOT_IMAGE_FORMAT tag can be used to set
1022 # generated by dot. Possible values are png,
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
1028 # found. If left blank, it is assumed the dot
1029
1030 DOT_PATH =
1031
1032 # The DOTFILE_DIRS tag can be used to specify
1033 # contain dot files that are included in the
1034 # \dotfile command).
1035
1036 DOTFILE_DIRS =
1037
1038 # The MAX_DOT_GRAPH_WIDTH tag can be used to
1039 # (in pixels) of the graphs generated by dot.
1040 # this value, doxygen will try to truncate th
1041 # the specified constraint. Beware that most
1042 # large images.
1043
1044 MAX_DOT_GRAPH_WIDTH = 1024
1045
1046 # The MAX_DOT_GRAPH_HEIGHT tag can be used to
1047 # (in pixels) of the graphs generated by dot.
1048 # this value, doxygen will try to truncate th
1049 # the specified constraint. Beware that most
1050 # large images.
1051
1052 MAX_DOT_GRAPH_HEIGHT = 1024
1053
1054 # The MAX_DOT_GRAPH_DEPTH tag can be used to
1055 # graphs generated by dot. A depth value of 3
1056 # from the root by following a path via at mo
1057 # lay further from the root node will be omit
1058 # 1 or 2 may greatly reduce the computation t
1059 # note that a graph may be further truncated
1060 # not sufficient to fit the graph (see MAX_DO
1061 # If 0 is used for the depth value (the defau
1062
1063 MAX_DOT_GRAPH_DEPTH = 0
1064
1065 # If the GENERATE_LEGEND tag is set to YES (t
1066 # generate a legend page explaining the meani
1067 # arrows in the dot generated graphs.
1068
1069 GENERATE_LEGEND = YES
1070
1071 # If the DOT_CLEANUP tag is set to YES (the d
1072 # remove the intermediate dot files that are
1073 # the various graphs.
1074
1075 DOT_CLEANUP = YES
1076
1077 #--------------------------------------------
1078 # Configuration::addtions related to the sear
1079 #--------------------------------------------
1080
1081 # The SEARCHENGINE tag specifies whether or n
1082 # used. If set to NO the values of all tags b
1083
1084 SEARCHENGINE = NO