Updated formatting of documentation plus a little reorganization.
[cmake.git] / doxygen.config
blobc22f2650d7760d92b196272fcf1681ad196e2aa5
1 # Doxyfile 1.1.4-20000625
3 # This file describes the settings to be used by doxygen for a project
5 # All text after a hash (#) is considered a comment and will be ignored
6 # The format is:
7 #       TAG = value [value, ...]
8 # Values that contain spaces should be placed between quotes (" ")
10 #---------------------------------------------------------------------------
11 # General configuration options
12 #---------------------------------------------------------------------------
14 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded 
15 # by quotes) that should identify the project. 
17 PROJECT_NAME          = CMAKE
19 # The PROJECT_NUMBER tag can be used to enter a project or revision number. 
20 # This could be handy for archiving the generated documentation or 
21 # if some version control system is used.
23 PROJECT_NUMBER        = 0.0.1
25 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 
26 # base path where the generated documentation will be put. 
27 # If a relative path is entered, it will be relative to the location 
28 # where doxygen was started. If left blank the current directory will be used.
30 OUTPUT_DIRECTORY      = ./Doxygen
32 # The OUTPUT_LANGUAGE tag is used to specify the language in which all 
33 # documentation generated by doxygen is written. Doxygen will use this 
34 # information to generate all constant output in the proper language. 
35 # The default language is English, other supported languages are: 
36 # Dutch, French, Italian, Czech, Swedish, German, Finnish, Japanese, 
37 # Spanish and Russian
39 OUTPUT_LANGUAGE       = English
41 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at 
42 # top of each HTML page. The value NO (the default) enables the index and 
43 # the value YES disables it. 
45 DISABLE_INDEX         = NO
47 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 
48 # documentation are documented, even if no documentation was available. 
49 # Private class members and static file members will be hidden unless 
50 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES 
52 EXTRACT_ALL           = YES
54 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class 
55 # will be included in the documentation. 
57 EXTRACT_PRIVATE       = NO
59 # If the EXTRACT_STATIC tag is set to YES all static members of a file 
60 # will be included in the documentation. 
62 EXTRACT_STATIC        = YES
64 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 
65 # undocumented members of documented classes, files or namespaces. 
66 # If set to NO (the default) these members will be included in the 
67 # various overviews, but no documentation section is generated. 
68 # This option has no effect if EXTRACT_ALL is enabled. 
70 HIDE_UNDOC_MEMBERS    = NO
72 # If the HIDE_UNDOC_CLASSESS tag is set to YES, Doxygen will hide all 
73 # undocumented classes that are normally visible in the class hierarchy. 
74 # If set to NO (the default) these class will be included in the various 
75 # overviews. This option has no effect if EXTRACT_ALL is enabled. 
77 HIDE_UNDOC_CLASSES    = NO
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. 
84 BRIEF_MEMBER_DESC     = YES
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. 
91 REPEAT_BRIEF          = YES
93 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 
94 # Doxygen will generate a detailed section even if there is only a brief 
95 # description. 
97 ALWAYS_DETAILED_SEC   = NO
99 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 
100 # path before files name in the file list and in the header files. If set 
101 # to NO the shortest path that makes the file name unique will be used. 
103 FULL_PATH_NAMES       = NO
105 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 
106 # can be used to strip a user defined part of the path. Stripping is 
107 # only done if one of the specified strings matches the left-hand part of 
108 # the path. 
110 STRIP_FROM_PATH       = 
112 # The INTERNAL_DOCS tag determines if documentation 
113 # that is typed after a \internal command is included. If the tag is set 
114 # to NO (the default) then the documentation will be excluded. 
115 # Set it to YES to include the internal documentation. 
117 INTERNAL_DOCS         = NO
119 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 
120 # generate a class diagram (in Html and LaTeX) for classes with base or 
121 # super classes. Setting the tag to NO turns the diagrams off. 
123 CLASS_DIAGRAMS        = YES
125 # If the SOURCE_BROWSER tag is set to YES then a list of source files will 
126 # be generated. Documented entities will be cross-referenced with these sources. 
128 SOURCE_BROWSER        = YES
130 # Setting the INLINE_SOURCES tag to YES will include the body 
131 # of functions and classes directly in the documentation. 
133 INLINE_SOURCES        = NO
135 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 
136 # doxygen to hide any special comment blocks from generated source code 
137 # fragments. Normal C and C++ comments will always remain visible. 
139 STRIP_CODE_COMMENTS   = YES
141 # If the CASE_SENSE_NAMES tag is set to NO (the default) then Doxygen 
142 # will only generate file names in lower case letters. If set to 
143 # YES upper case letters are also allowed. This is useful if you have 
144 # classes or files whose names only differ in case and if your file system 
145 # supports case sensitive file names. 
147 CASE_SENSE_NAMES      = YES
149 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 
150 # will show members with their full class and namespace scopes in the 
151 # documentation. If set to YES the scope will be hidden. 
153 HIDE_SCOPE_NAMES      = NO
155 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 
156 # will generate a verbatim copy of the header file for each class for 
157 # which an include is specified. Set to NO to disable this. 
159 VERBATIM_HEADERS      = YES
161 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 
162 # will put list of the files that are included by a file in the documentation 
163 # of that file. 
165 SHOW_INCLUDE_FILES    = YES
167 # If the JAVADOC_AUTOBRIEF tag is set to YES (the default) then Doxygen 
168 # will interpret the first line (until the first dot) of a JavaDoc-style 
169 # comment as the brief description. If set to NO, the Javadoc-style will 
170 # behave just like the Qt-style comments. 
172 JAVADOC_AUTOBRIEF     = NO
174 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 
175 # member inherits the documentation from any documented member that it 
176 # reimplements. 
178 INHERIT_DOCS          = YES
180 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 
181 # is inserted in the documentation for inline members. 
183 INLINE_INFO           = YES
185 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 
186 # will sort the (detailed) documentation of file and class members 
187 # alphabetically by member name. If set to NO the members will appear in 
188 # declaration order. 
190 SORT_MEMBER_DOCS      = YES
192 # The TAB_SIZE tag can be used to set the number of spaces in a tab. 
193 # Doxygen uses this value to replace tabs by spaces in code fragments. 
195 TAB_SIZE              = 8
197 # The ENABLE_SECTIONS tag can be used to enable conditional 
198 # documentation sections, marked by \if sectionname ... \endif. 
200 ENABLED_SECTIONS      = 
202 #---------------------------------------------------------------------------
203 # configuration options related to warning and progress messages
204 #---------------------------------------------------------------------------
206 # The QUIET tag can be used to turn on/off the messages that are generated 
207 # by doxygen. Possible values are YES and NO. If left blank NO is used. 
209 QUIET                 = NO
211 # The WARNINGS tag can be used to turn on/off the warning messages that are 
212 # generated by doxygen. Possible values are YES and NO. If left blank 
213 # NO is used. 
215 WARNINGS              = YES
217 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 
218 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will 
219 # automatically be disabled. 
221 WARN_IF_UNDOCUMENTED  = YES
223 # The WARN_FORMAT tag determines the format of the warning messages that 
224 # doxygen can produce. The string should contain the $file, $line, and $text 
225 # tags, which will be replaced by the file and line number from which the 
226 # warning originated and the warning text. 
228 WARN_FORMAT           = "$file:$line: $text"
230 #---------------------------------------------------------------------------
231 # configuration options related to the input files
232 #---------------------------------------------------------------------------
234 # The INPUT tag can be used to specify the files and/or directories that contain 
235 # documented source files. You may enter file names like "myfile.cpp" or 
236 # directories like "/usr/src/myproject". Separate the files or directories 
237 # with spaces. 
239 INPUT                 = "Source"
241 # If the value of the INPUT tag contains directories, you can use the 
242 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
243 # and *.h) to filter out the source-files in the directories. If left 
244 # blank all files are included. 
246 FILE_PATTERNS         = *.h *.txx *.cxx
248 # The RECURSIVE tag can be used to turn specify whether or not subdirectories 
249 # should be searched for input files as well. Possible values are YES and NO. 
250 # If left blank NO is used. 
252 RECURSIVE             = YES
254 # The EXCLUDE tag can be used to specify files and/or directories that should 
255 # excluded from the INPUT source files. This way you can easily exclude a 
256 # subdirectory from a directory tree whose root is specified with the INPUT tag. 
258 EXCLUDE               = 
259                         
260 # If the value of the INPUT tag contains directories, you can use the 
261 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 
262 # certain files from those directories. 
264 EXCLUDE_PATTERNS      = 
266 # The EXAMPLE_PATH tag can be used to specify one or more files or 
267 # directories that contain example code fragments that are included (see 
268 # the \include command). 
270 EXAMPLE_PATH          = 
272 # If the value of the EXAMPLE_PATH tag contains directories, you can use the 
273 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
274 # and *.h) to filter out the source-files in the directories. If left 
275 # blank all files are included. 
277 EXAMPLE_PATTERNS      = 
279 # The IMAGE_PATH tag can be used to specify one or more files or 
280 # directories that contain image that are included in the documentation (see 
281 # the \image command). 
283 IMAGE_PATH            = 
285 # The INPUT_FILTER tag can be used to specify a program that doxygen should 
286 # invoke to filter for each input file. Doxygen will invoke the filter program 
287 # by executing (via popen()) the command <filter> <input-file>, where <filter> 
288 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an 
289 # input file. Doxygen will then use the output that the filter program writes 
290 # to standard output. 
292 INPUT_FILTER          = 
294 #---------------------------------------------------------------------------
295 # configuration options related to the alphabetical class index
296 #---------------------------------------------------------------------------
298 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 
299 # of all compounds will be generated. Enable this if the project 
300 # contains a lot of classes, structs, unions or interfaces. 
302 ALPHABETICAL_INDEX    = YES
304 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 
305 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 
306 # in which this list will be split (can be a number in the range [1..20]) 
308 COLS_IN_ALPHA_INDEX   = 3
310 # In case all classes in a project start with a common prefix, all 
311 # classes will be put under the same header in the alphabetical index. 
312 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that 
313 # should be ignored while generating the index headers. 
315 IGNORE_PREFIX         = 
317 #---------------------------------------------------------------------------
318 # configuration options related to the HTML output
319 #---------------------------------------------------------------------------
321 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will 
322 # generate HTML output. 
324 GENERATE_HTML         = YES
326 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 
327 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
328 # put in front of it. If left blank `html' will be used as the default path. 
330 HTML_OUTPUT           = html
332 # The HTML_HEADER tag can be used to specify a personal HTML header for 
333 # each generated HTML page. If it is left blank doxygen will generate a 
334 # standard header.
336 HTML_HEADER           = 
338 # The HTML_FOOTER tag can be used to specify a personal HTML footer for 
339 # each generated HTML page. If it is left blank doxygen will generate a 
340 # standard footer.
342 HTML_FOOTER           = 
344 # The HTML_STYLESHEET tag can be used to specify a user defined cascading 
345 # style sheet that is used by each HTML page. It can be used to 
346 # fine-tune the look of the HTML output. If the tag is left blank doxygen 
347 # will generate a default style sheet 
349 HTML_STYLESHEET       = 
351 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 
352 # files or namespaces will be aligned in HTML using tables. If set to 
353 # NO a bullet list will be used. 
355 HTML_ALIGN_MEMBERS    = YES
357 # If the GENERATE_HTMLHELP tag is set to YES, additional index files 
358 # will be generated that can be used as input for tools like the 
359 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm) 
360 # of the generated HTML documentation. 
362 GENERATE_HTMLHELP     = NO
364 #---------------------------------------------------------------------------
365 # configuration options related to the LaTeX output
366 #---------------------------------------------------------------------------
368 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 
369 # generate Latex output. 
371 GENERATE_LATEX        = YES
373 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 
374 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
375 # put in front of it. If left blank `latex' will be used as the default path. 
377 LATEX_OUTPUT          = latex
379 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 
380 # LaTeX documents. This may be useful for small projects and may help to 
381 # save some trees in general. 
383 COMPACT_LATEX         = NO
385 # The PAPER_TYPE tag can be used to set the paper type that is used 
386 # by the printer. Possible values are: a4, a4wide, letter, legal and 
387 # executive. If left blank a4wide will be used. 
389 PAPER_TYPE            = a4wide
391 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 
392 # packages that should be included in the LaTeX output. 
394 EXTRA_PACKAGES        = 
396 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for 
397 # the generated latex document. The header should contain everything until 
398 # the first chapter. If it is left blank doxygen will generate a 
399 # standard header. Notice: only use this tag if you know what you are doing! 
401 LATEX_HEADER          = 
403 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 
404 # is prepared for conversion to pdf (using ps2pdf). The pdf file will 
405 # contain links (just like the HTML output) instead of page references 
406 # This makes the output suitable for online browsing using a pdf viewer. 
408 PDF_HYPERLINKS        = NO
410 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 
411 # command to the generated LaTeX files. This will instruct LaTeX to keep 
412 # running if errors occur, instead of asking the user for help. 
413 # This option is also used when generating formulas in HTML. 
415 LATEX_BATCHMODE       = NO
417 #---------------------------------------------------------------------------
418 # configuration options related to the RTF output
419 #---------------------------------------------------------------------------
421 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 
422 # For now this is experimental and is disabled by default. The RTF output 
423 # is optimised for Word 97 and may not look too pretty with other readers 
424 # or editors.
426 GENERATE_RTF          = YES
428 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 
429 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
430 # put in front of it. If left blank `rtf' will be used as the default path. 
432 RTF_OUTPUT            = rtf
434 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact 
435 # RTF documents. This may be useful for small projects and may help to 
436 # save some trees in general. 
438 COMPACT_RTF           = NO
440 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 
441 # will contain hyperlink fields. The RTF file will 
442 # contain links (just like the HTML output) instead of page references. 
443 # This makes the output suitable for online browsing using a WORD or other. 
444 # programs which support those fields. 
445 # Note: wordpad (write) and others do not support links. 
447 RTF_HYPERLINKS        = NO
449 #---------------------------------------------------------------------------
450 # configuration options related to the man page output
451 #---------------------------------------------------------------------------
453 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will 
454 # generate man pages 
456 GENERATE_MAN          = YES
458 # The MAN_OUTPUT tag is used to specify where the man pages will be put. 
459 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
460 # put in front of it. If left blank `man' will be used as the default path. 
462 MAN_OUTPUT            = man
464 # The MAN_EXTENSION tag determines the extension that is added to 
465 # the generated man pages (default is the subroutine's section .3) 
467 MAN_EXTENSION         = .3
469 #---------------------------------------------------------------------------
470 # Configuration options related to the preprocessor   
471 #---------------------------------------------------------------------------
473 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 
474 # evaluate all C-preprocessor directives found in the sources and include 
475 # files. 
477 ENABLE_PREPROCESSING  = YES
479 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 
480 # names in the source code. If set to NO (the default) only conditional 
481 # compilation will be performed. 
483 MACRO_EXPANSION       = YES
485 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 
486 # in the INCLUDE_PATH (see below) will be search if a #include is found. 
488 SEARCH_INCLUDES       = NO
490 # The INCLUDE_PATH tag can be used to specify one or more directories that 
491 # contain include files that are not input files but should be processed by 
492 # the preprocessor. 
494 INCLUDE_PATH          = 
496 # The PREDEFINED tag can be used to specify one or more macro names that 
497 # are defined before the preprocessor is started (similar to the -D option of 
498 # gcc). The argument of the tag is a list of macros of the form: name 
499 # or name=definition (no spaces). If the definition and the = are 
500 # omitted =1 is assumed. 
502 PREDEFINED  =  "itkNotUsed(x)="\
503                "itkSetMacro(name,type)= \
504                   virtual void Set##name (type _arg);" \
505                "itkGetMacro(name,type)= \
506                   virtual type Get##name ();" \
507                "itkGetConstMacro(name,type)= \
508                   virtual type Get##name () const;" \
509                "itkSetStringMacro(name)= \
510                   virtual void Set##name (const char* _arg);" \
511                "itkGetStringMacro(name)= \
512                   virtual const char* Get##name () const;" \
513                "itkSetClampMacro(name,type,min,max)= \
514                   virtual void Set##name (type _arg);" \
515                "itkSetObjectMacro(name,type)= \
516                   virtual void Set##name (type* _arg);" \
517                "itkGetObjectMacro(name,type)= \
518                   virtual type* Get##name ();" \
519                "itkBooleanMacro(name)= \
520                   virtual void name##On (); \
521                   virtual void name##Off ();" \
522                "itkSetVector2Macro(name,type)= \
523                   virtual void Set##name (type _arg1, type _arg2) \
524                   virtual void Set##name (type _arg[2]);" \
525                "itkGetVector2Macro(name,type)= \
526                   virtual type* Get##name () const; \
527                   virtual void Get##name (type& _arg1, type& _arg2) const; \
528                   virtual void Get##name (type _arg[2]) const;" \
529                "itkSetVector3Macro(name,type)= \
530                   virtual void Set##name (type _arg1, type _arg2, type _arg3) \
531                   virtual void Set##name (type _arg[3]);" \
532                "itkGetVector3Macro(name,type)= \
533                   virtual type* Get##name () const; \
534                   virtual void Get##name (type& _arg1, type& _arg2, type& _arg3) const; \
535                   virtual void Get##name (type _arg[3]) const;" \
536                "itkSetVector4Macro(name,type)= \
537                   virtual void Set##name (type _arg1, type _arg2, type _arg3, type _arg4) \
538                   virtual void Set##name (type _arg[4]);" \
539                "itkGetVector4Macro(name,type)= \
540                   virtual type* Get##name () const; \
541                   virtual void Get##name (type& _arg1, type& _arg2, type& _arg3, type& _arg4) const; \
542                   virtual void Get##name (type _arg[4]) const;" \
543                "itkSetVector6Macro(name,type)= \
544                   virtual void Set##name (type _arg1, type _arg2, type _arg3, type _arg4, type _arg5, type _arg6) \
545                   virtual void Set##name (type _arg[6]);" \
546                "itkGetVector6Macro(name,type)= \
547                   virtual type* Get##name () const; \
548                   virtual void Get##name (type& _arg1, type& _arg2, type& _arg3, type& _arg4, type& _arg5, type& _arg6) const; \
549                   virtual void Get##name (type _arg[6]) const;" \
550                "itkSetVectorMacro(name,type,count)= \
551                   virtual void Set##name(type data[]);" \
552                "itkGetVectorMacro(name,type,count)= \
553                   virtual type* Get##name () const;" \
554                "itkNewMacro(type)= \
555                   static Pointer New();" \
556                "itkTypeMacro(thisClass,superclass)= \
557                   virtual const char *GetClassName() const;" \
558                "ITK_NUMERIC_LIMITS= \
559                   std::numeric_limits"
561 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 
562 # then the macro expansion is limited to the macros specified with the 
563 # PREDEFINED tag. 
565 EXPAND_ONLY_PREDEF    = YES
567 #---------------------------------------------------------------------------
568 # Configuration::addtions related to external references   
569 #---------------------------------------------------------------------------
571 # The TAGFILES tag can be used to specify one or more tagfiles. 
573 TAGFILES              = 
575 # When a file name is specified after GENERATE_TAGFILE, doxygen will create 
576 # a tag file that is based on the input files it reads. 
578 GENERATE_TAGFILE      = 
580 # If the ALLEXTERNALS tag is set to YES all external classes will be listed 
581 # in the class index. If set to NO only the inherited external classes 
582 # will be listed. 
584 ALLEXTERNALS          = NO
586 # The PERL_PATH should be the absolute path and name of the perl script 
587 # interpreter (i.e. the result of `which perl'). 
589 PERL_PATH             = /usr/bin/perl
591 #---------------------------------------------------------------------------
592 # Configuration options related to the dot tool   
593 #---------------------------------------------------------------------------
595 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 
596 # available from the path. This tool is part of Graphviz, a graph visualization 
597 # toolkit from AT&T and Lucent Bell Labs. The other options in this section 
598 # have no effect if this option is set to NO (the default) 
600 HAVE_DOT              = YES
602 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 
603 # will generate a graph for each documented class showing the direct and 
604 # indirect inheritance relations. Setting this tag to YES will force the 
605 # the CLASS_DIAGRAMS tag to NO.
607 CLASS_GRAPH           = YES
609 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 
610 # will generate a graph for each documented class showing the direct and 
611 # indirect implementation dependencies (inheritance, containment, and 
612 # class references variables) of the class with other documented classes. 
614 COLLABORATION_GRAPH   = YES
616 # If the ENABLE_PREPROCESSING, INCLUDE_GRAPH, and HAVE_DOT tags are set to 
617 # YES then doxygen will generate a graph for each documented file showing 
618 # the direct and indirect include dependencies of the file with other 
619 # documented files. 
621 INCLUDE_GRAPH         = YES
623 # If the ENABLE_PREPROCESSING, INCLUDED_BY_GRAPH, and HAVE_DOT tags are set to 
624 # YES then doxygen will generate a graph for each documented header file showing 
625 # the documented files that directly or indirectly include this file 
627 INCLUDED_BY_GRAPH     = YES
629 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 
630 # will graphical hierarchy of all classes instead of a textual one. 
632 GRAPHICAL_HIERARCHY   = YES
634 # The tag DOT_PATH can be used to specify the path where the dot tool can be 
635 # found. If left blank, it is assumed the dot tool can be found on the path. 
637 DOT_PATH              =
639 # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width 
640 # (in pixels) of the graphs generated by dot. If a graph becomes larger than 
641 # this value, doxygen will try to truncate the graph, so that it fits within 
642 # the specified constraint. Beware that most browsers cannot cope with very 
643 # large images. 
645 MAX_DOT_GRAPH_WIDTH   = 1024
647 # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height 
648 # (in pixels) of the graphs generated by dot. If a graph becomes larger than 
649 # this value, doxygen will try to truncate the graph, so that it fits within 
650 # the specified constraint. Beware that most browsers cannot cope with very 
651 # large images. 
653 MAX_DOT_GRAPH_HEIGHT  = 1024
655 #---------------------------------------------------------------------------
656 # Configuration::addtions related to the search engine   
657 #---------------------------------------------------------------------------
659 # The SEARCHENGINE tag specifies whether or not a search engine should be 
660 # used. If set to NO the values of all tags below this one will be ignored. 
662 SEARCHENGINE          = NO
664 # The CGI_NAME tag should be the name of the CGI script that 
665 # starts the search engine (doxysearch) with the correct parameters. 
666 # A script with this name will be generated by doxygen. 
668 CGI_NAME              = search.cgi
670 # The CGI_URL tag should be the absolute URL to the directory where the 
671 # cgi binaries are located. See the documentation of your http daemon for 
672 # details. 
674 CGI_URL               = 
676 # The DOC_URL tag should be the absolute URL to the directory where the 
677 # documentation is located. If left blank the absolute path to the 
678 # documentation, with file:// prepended to it, will be used. 
680 DOC_URL               = 
682 # The DOC_ABSPATH tag should be the absolute path to the directory where the 
683 # documentation is located. If left blank the directory on the local machine 
684 # will be used. 
686 DOC_ABSPATH           = 
688 # The BIN_ABSPATH tag must point to the directory where the doxysearch binary 
689 # is installed. 
691 BIN_ABSPATH           = /usr/local/bin/
693 # The EXT_DOC_PATHS tag can be used to specify one or more paths to 
694 # documentation generated for other projects. This allows doxysearch to search 
695 # the documentation for these projects as well. 
697 EXT_DOC_PATHS         =