Fixed running tests in seperate build directory (e.g. during distcheck).
[libxdg-basedir.git] / doxygen.cfg
blob71a29bee6a406f98ec68065944c419279a542e3b
1 # Doxyfile 1.5.3
3 # NOTE: These are taken from the configure.ac file. The output looks better
4 # when placing the version in the PROJECT_NAME. Thje PROJECT_NUMBER seems
5 # intended more for things like the RCS version.
6 PROJECT_NAME           = $(PROJECT)-$(VERSION)
7 PROJECT_NUMBER         = $(VERSION)
8 # NOTE: This is taken from the DX_DOCDIR variable (set by calling
9 # DX_INIT_DOXYGEN). The Makefile relies on it being there.
10 OUTPUT_DIRECTORY       = $(DOCDIR)
11 OUTPUT_LANGUAGE        = English
12 ALWAYS_DETAILED_SEC    = NO
13 FULL_PATH_NAMES        = YES
14 # NOTE: This is taken from the srcdir variable, which "make distcheck" plays
15 # with. You may need to add subdirectory(s) here, depending on your directory
16 # structure. But you almost certainly want the SRCDIR itself to be stripped.
17 STRIP_FROM_PATH        = $(SRCDIR)
18 JAVADOC_AUTOBRIEF      = YES
19 TAB_SIZE               = 4
20 OPTIMIZE_OUTPUT_FOR_C  = YES
22 EXTRACT_ALL            = NO
23 EXTRACT_PRIVATE        = NO
24 EXTRACT_STATIC         = YES
25 EXTRACT_LOCAL_CLASSES  = NO
26 EXTRACT_LOCAL_METHODS  = NO
27 HIDE_UNDOC_MEMBERS     = YES
28 HIDE_UNDOC_CLASSES     = YES
30 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 
31 # documentation blocks found inside the body of a function. 
32 # If set to NO (the default) these blocks will be appended to the 
33 # function's detailed documentation block.
35 HIDE_IN_BODY_DOCS      = NO
37 # The INTERNAL_DOCS tag determines if documentation 
38 # that is typed after a \internal command is included. If the tag is set 
39 # to NO (the default) then the documentation will be excluded. 
40 # Set it to YES to include the internal documentation.
42 INTERNAL_DOCS          = NO
44 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 
45 # file names in lower-case letters. If set to YES upper-case letters are also 
46 # allowed. This is useful if you have classes or files whose names only differ 
47 # in case and if your file system supports case sensitive file names. Windows 
48 # and Mac users are advised to set this option to NO.
50 CASE_SENSE_NAMES       = YES
52 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 
53 # will sort the (detailed) documentation of file and class members 
54 # alphabetically by member name. If set to NO the members will appear in 
55 # declaration order.
57 SORT_MEMBER_DOCS       = YES
59 # The GENERATE_TODOLIST tag can be used to enable (YES) or 
60 # disable (NO) the todo list. This list is created by putting \todo 
61 # commands in the documentation.
63 GENERATE_TODOLIST      = YES
65 # The GENERATE_TESTLIST tag can be used to enable (YES) or 
66 # disable (NO) the test list. This list is created by putting \test 
67 # commands in the documentation.
69 GENERATE_TESTLIST      = YES
71 # The GENERATE_BUGLIST tag can be used to enable (YES) or 
72 # disable (NO) the bug list. This list is created by putting \bug 
73 # commands in the documentation.
75 GENERATE_BUGLIST       = YES
77 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 
78 # disable (NO) the deprecated list. This list is created by putting 
79 # \deprecated commands in the documentation.
81 GENERATE_DEPRECATEDLIST= YES
83 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines 
84 # the initial value of a variable or define consists of for it to appear in 
85 # the documentation. If the initializer consists of more lines than specified 
86 # here it will be hidden. Use a value of 0 to hide initializers completely. 
87 # The appearance of the initializer of individual variables and defines in the 
88 # documentation can be controlled using \showinitializer or \hideinitializer 
89 # command in the documentation regardless of this setting.
91 MAX_INITIALIZER_LINES  = 30
93 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated 
94 # at the bottom of the documentation of classes and structs. If set to YES the 
95 # list will mention the files that were used to generate the documentation.
97 SHOW_USED_FILES        = YES
99 # If the sources in your project are distributed over multiple directories 
100 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy 
101 # in the documentation. The default is NO.
103 SHOW_DIRECTORIES       = NO
105 # The FILE_VERSION_FILTER tag can be used to specify a program or script that 
106 # doxygen should invoke to get the current version for each file (typically from the 
107 # version control system). Doxygen will invoke the program by executing (via 
108 # popen()) the command <command> <input-file>, where <command> is the value of 
109 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file 
110 # provided by doxygen. Whatever the program writes to standard output 
111 # is used as the file version. See the manual for examples.
113 FILE_VERSION_FILTER    = 
115 #---------------------------------------------------------------------------
116 # configuration options related to warning and progress messages
117 #---------------------------------------------------------------------------
119 WARNINGS               = YES
120 WARN_IF_UNDOCUMENTED   = YES
121 WARN_IF_DOC_ERROR      = YES
122 WARN_NO_PARAMDOC       = NO
123 WARN_FORMAT            = "$file:$line: $text"
125 #---------------------------------------------------------------------------
126 # configuration options related to the input files
127 #---------------------------------------------------------------------------
129 # The INPUT tag can be used to specify the files and/or directories that contain 
130 # documented source files. You may enter file names like "myfile.cpp" or 
131 # directories like "/usr/src/myproject". Separate the files or directories 
132 # with spaces.
134 # NOTE: You do want to limit the search for specific sub-directories.
135 # If you "make distcheck" and things go wrong, there's a leftover
136 # ($PROJECT)-$VERSION) file containing a copy of all the sources. If you don't
137 # limit the search, and forget to clean up, then doxygen start seeing double...
138 # It is important to root all paths with SRCDIR - again, because of "make
139 # distcheck". So usually this would be something like "$(SRCDIR)/src".
140 INPUT                  = $(SRCDIR)/src $(SRCDIR)/include
142 # If the value of the INPUT tag contains directories, you can use the 
143 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
144 # and *.h) to filter out the source-files in the directories. If left 
145 # blank the following patterns are tested: 
146 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx 
147 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py
149 FILE_PATTERNS          = 
151 # The RECURSIVE tag can be used to turn specify whether or not subdirectories 
152 # should be searched for input files as well. Possible values are YES and NO. 
153 # If left blank NO is used.
155 RECURSIVE              = NO
157 # The EXCLUDE tag can be used to specify files and/or directories that should 
158 # excluded from the INPUT source files. This way you can easily exclude a 
159 # subdirectory from a directory tree whose root is specified with the INPUT tag.
161 EXCLUDE                = 
163 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or 
164 # directories that are symbolic links (a Unix filesystem feature) are excluded 
165 # from the input.
167 EXCLUDE_SYMLINKS       = NO
169 # If the value of the INPUT tag contains directories, you can use the 
170 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 
171 # certain files from those directories. Note that the wildcards are matched 
172 # against the file with absolute path, so to exclude all test directories 
173 # for example use the pattern */test/*
175 EXCLUDE_PATTERNS       = 
177 # The EXAMPLE_PATH tag can be used to specify one or more files or 
178 # directories that contain example code fragments that are included (see 
179 # the \include command).
181 EXAMPLE_PATH           = 
183 # If the value of the EXAMPLE_PATH tag contains directories, you can use the 
184 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
185 # and *.h) to filter out the source-files in the directories. If left 
186 # blank all files are included.
188 EXAMPLE_PATTERNS       = 
190 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 
191 # searched for input files to be used with the \include or \dontinclude 
192 # commands irrespective of the value of the RECURSIVE tag. 
193 # Possible values are YES and NO. If left blank NO is used.
195 EXAMPLE_RECURSIVE      = NO
197 # The IMAGE_PATH tag can be used to specify one or more files or 
198 # directories that contain image that are included in the documentation (see 
199 # the \image command).
201 IMAGE_PATH             = 
203 # The INPUT_FILTER tag can be used to specify a program that doxygen should 
204 # invoke to filter for each input file. Doxygen will invoke the filter program 
205 # by executing (via popen()) the command <filter> <input-file>, where <filter> 
206 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an 
207 # input file. Doxygen will then use the output that the filter program writes 
208 # to standard output.  If FILTER_PATTERNS is specified, this tag will be 
209 # ignored.
211 INPUT_FILTER           = 
213 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 
214 # basis.  Doxygen will compare the file name with each pattern and apply the 
215 # filter if there is a match.  The filters are a list of the form: 
216 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 
217 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER 
218 # is applied to all files.
220 FILTER_PATTERNS        = 
222 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 
223 # INPUT_FILTER) will be used to filter the input files when producing source 
224 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
226 FILTER_SOURCE_FILES    = NO
228 #---------------------------------------------------------------------------
229 # configuration options related to source browsing
230 #---------------------------------------------------------------------------
232 SOURCE_BROWSER         = YES
233 INLINE_SOURCES         = NO
234 STRIP_CODE_COMMENTS    = YES
235 REFERENCED_BY_RELATION = NO
236 REFERENCES_RELATION    = NO
237 REFERENCES_LINK_SOURCE = NO
239 #---------------------------------------------------------------------------
240 # configuration options related to the HTML output
241 #---------------------------------------------------------------------------
243 GENERATE_HTML          = $(GENERATE_HTML)
245 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading 
246 # style sheet that is used by each HTML page. It can be used to 
247 # fine-tune the look of the HTML output. If the tag is left blank doxygen 
248 # will generate a default style sheet. Note that doxygen will try to copy 
249 # the style sheet file to the HTML output directory, so don't put your own 
250 # stylesheet in the HTML output directory as well, or it will be erased!
252 HTML_STYLESHEET        = 
254 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 
255 # files or namespaces will be aligned in HTML using tables. If set to 
256 # NO a bullet list will be used.
258 HTML_ALIGN_MEMBERS     = YES
260 # If the GENERATE_HTMLHELP tag is set to YES, additional index files 
261 # will be generated that can be used as input for tools like the 
262 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm) 
263 # of the generated HTML documentation.
264 # NOTE: You can generate the CHM by running "configure --doxygen-enable-chm"
265 GENERATE_HTMLHELP      = $(GENERATE_HTMLHELP)
267 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 
268 # be used to specify the file name of the resulting .chm file. You 
269 # can add a path in front of the file if the result should not be 
270 # written to the html output directory.
271 # NOTE: This seems to be relative to the HTML directory. The Makefile depends
272 # on it ending up being directly in the OUTPUT_DIRECTORY. Since DOCDIR is
273 # relative, using '..' seems the only safe way to specify this.
274 CHM_FILE               = ../$(PROJECT).chm
276 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 
277 # be used to specify the location (absolute path including file name) of 
278 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 
279 # the HTML help compiler on the generated index.hhp.
280 # NOTE: configure finds HHC automatically for you; if it can't, it will turn
281 # CHM generation off.
282 HHC_LOCATION           = $(HHC_PATH)
284 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 
285 # controls if a separate .chi index file is generated (YES) or that 
286 # it should be included in the master .chm file (NO).
287 # NOTE: You can generate the CHI by running "configure # --doxygen-enable-chi"
288 GENERATE_CHI           = $(GENERATE_CHI)
290 # The TOC_EXPAND flag can be set to YES to add extra items for group members 
291 # to the contents of the HTML help documentation and to the tree view.
293 TOC_EXPAND             = YES
295 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at 
296 # top of each HTML page. The value NO (the default) enables the index and 
297 # the value YES disables it.
299 DISABLE_INDEX          = NO
301 ENUM_VALUES_PER_LINE   = 4
303 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
304 # generated containing a tree-like index structure (just like the one that 
305 # is generated for HTML Help). For this to work a browser that supports 
306 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, 
307 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are 
308 # probably better off using the HTML help feature.
310 GENERATE_TREEVIEW      = NO
312 TREEVIEW_WIDTH         = 250
314 #---------------------------------------------------------------------------
315 # configuration options related to the LaTeX output
316 #---------------------------------------------------------------------------
318 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 
319 # generate Latex output.
320 # NOTE: This is automatically YES if you generate PS or PDF output. You can
321 # disable it by running "configure --disable-doxygen-ps --disable-doxygen-pdf"
322 GENERATE_LATEX         = $(GENERATE_LATEX)
324 # NOTE: The Makefile depends on this being 'latex'.
325 LATEX_OUTPUT           = latex
327 LATEX_CMD_NAME         = latex
329 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 
330 # generate index for LaTeX. If left blank `makeindex' will be used as the 
331 # default command name.
333 MAKEINDEX_CMD_NAME     = makeindex
335 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 
336 # LaTeX documents. This may be useful for small projects and may help to 
337 # save some trees in general.
339 COMPACT_LATEX          = NO
341 # The PAPER_TYPE tag can be used to set the paper type that is used 
342 # by the printer. Possible values are: a4, a4wide, letter, legal and 
343 # executive. If left blank a4wide will be used.
345 PAPER_TYPE             = $(PAPER_SIZE)
347 PDF_HYPERLINKS         = YES
349 USE_PDFLATEX           = $(GENERATE_PDF)
351 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 
352 # command to the generated LaTeX files. This will instruct LaTeX to keep 
353 # running if errors occur, instead of asking the user for help. 
354 # This option is also used when generating formulas in HTML.
356 LATEX_BATCHMODE        = YES
358 # If LATEX_HIDE_INDICES is set to YES then doxygen will not 
359 # include the index chapters (such as File Index, Compound Index, etc.) 
360 # in the output.
362 LATEX_HIDE_INDICES     = YES
364 #---------------------------------------------------------------------------
365 # configuration options related to the RTF output
366 #---------------------------------------------------------------------------
368 GENERATE_RTF           = $(GENERATE_RTF)
370 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 
371 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
372 # put in front of it. If left blank `rtf' will be used as the default path.
373 # NOTE: The Makefile depends on this being 'rtf'.
374 RTF_OUTPUT             = rtf
376 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact 
377 # RTF documents. This may be useful for small projects and may help to 
378 # save some trees in general.
379 COMPACT_RTF            = YES
381 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 
382 # will contain hyperlink fields. The RTF file will 
383 # contain links (just like the HTML output) instead of page references. 
384 # This makes the output suitable for online browsing using WORD or other 
385 # programs which support those fields. 
386 # Note: wordpad (write) and others do not support links.
387 RTF_HYPERLINKS         = NO
389 # Load stylesheet definitions from file. Syntax is similar to doxygen's 
390 # config file, i.e. a series of assignments. You only have to provide 
391 # replacements, missing definitions are set to their default value.
392 RTF_STYLESHEET_FILE    = 
394 # Set optional variables used in the generation of an rtf document. 
395 # Syntax is similar to doxygen's config file.
396 RTF_EXTENSIONS_FILE    = 
398 #---------------------------------------------------------------------------
399 # configuration options related to the man page output
400 #---------------------------------------------------------------------------
402 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will 
403 # generate man pages
405 GENERATE_MAN           = $(GENERATE_MAN)
407 # The MAN_OUTPUT tag is used to specify where the man pages will be put. 
408 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
409 # put in front of it. If left blank `man' will be used as the default path.
411 MAN_OUTPUT             = man
413 # The MAN_EXTENSION tag determines the extension that is added to 
414 # the generated man pages (default is the subroutine's section .3)
416 MAN_EXTENSION          = .3
418 # If the MAN_LINKS tag is set to YES and Doxygen generates man output, 
419 # then it will generate one additional man file for each entity 
420 # documented in the real man page(s). These additional files 
421 # only source the real man page, but without them the man command 
422 # would be unable to find the correct page. The default is NO.
424 MAN_LINKS              = NO
426 #---------------------------------------------------------------------------
427 # configuration options related to the XML output
428 #---------------------------------------------------------------------------
430 # If the GENERATE_XML tag is set to YES Doxygen will 
431 # generate an XML file that captures the structure of 
432 # the code including all documentation.
433 # NOTE: You can enable this by running "configure --enable-doxygen-xml"
434 GENERATE_XML           = $(GENERATE_XML)
436 # The XML_OUTPUT tag is used to specify where the XML pages will be put. 
437 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
438 # put in front of it. If left blank `xml' will be used as the default path.
439 # NOTE: The Makefile depends on this being 'xml'.
440 XML_OUTPUT             = xml
442 # The XML_SCHEMA tag can be used to specify an XML schema, 
443 # which can be used by a validating XML parser to check the 
444 # syntax of the XML files.
445 XML_SCHEMA             = 
447 # The XML_DTD tag can be used to specify an XML DTD, 
448 # which can be used by a validating XML parser to check the 
449 # syntax of the XML files.
450 XML_DTD                = 
452 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will 
453 # dump the program listings (including syntax highlighting 
454 # and cross-referencing information) to the XML output. Note that 
455 # enabling this will significantly increase the size of the XML output.
456 XML_PROGRAMLISTING     = YES
458 #---------------------------------------------------------------------------
459 # configuration options for the AutoGen Definitions output
460 #---------------------------------------------------------------------------
462 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 
463 # generate an AutoGen Definitions (see autogen.sf.net) file 
464 # that captures the structure of the code including all 
465 # documentation. Note that this feature is still experimental 
466 # and incomplete at the moment.
467 # NOTE: There's no support for this in the Makefile yet.
468 GENERATE_AUTOGEN_DEF   = NO
470 #---------------------------------------------------------------------------
471 # configuration options related to the Perl module output
472 #---------------------------------------------------------------------------
474 # If the GENERATE_PERLMOD tag is set to YES Doxygen will 
475 # generate a Perl module file that captures the structure of 
476 # the code including all documentation. Note that this 
477 # feature is still experimental and incomplete at the 
478 # moment.
479 # NOTE: There's no support for this in the Makefile yet.
480 GENERATE_PERLMOD       = NO
482 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate 
483 # the necessary Makefile rules, Perl scripts and LaTeX code to be able 
484 # to generate PDF and DVI output from the Perl module output.
485 # NOTE: There's no support for this in the Makefile yet.
486 PERLMOD_LATEX          = NO
488 #---------------------------------------------------------------------------
489 # Configuration options related to the preprocessor   
490 #---------------------------------------------------------------------------
492 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 
493 # evaluate all C-preprocessor directives found in the sources and include 
494 # files.
496 ENABLE_PREPROCESSING   = YES
498 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 
499 # names in the source code. If set to NO (the default) only conditional 
500 # compilation will be performed. Macro expansion can be done in a controlled 
501 # way by setting EXPAND_ONLY_PREDEF to YES.
503 MACRO_EXPANSION        = YES
505 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 
506 # then the macro expansion is limited to the macros specified with the 
507 # PREDEFINED and EXPAND_AS_DEFINED tags.
509 EXPAND_ONLY_PREDEF     = YES
511 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 
512 # in the INCLUDE_PATH (see below) will be search if a #include is found.
514 SEARCH_INCLUDES        = YES
516 # The INCLUDE_PATH tag can be used to specify one or more directories that 
517 # contain include files that are not input files but should be processed by 
518 # the preprocessor.
520 INCLUDE_PATH           = .
522 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 
523 # patterns (like *.h and *.hpp) to filter out the header-files in the 
524 # directories. If left blank, the patterns specified with FILE_PATTERNS will 
525 # be used.
527 INCLUDE_FILE_PATTERNS  = 
529 # The PREDEFINED tag can be used to specify one or more macro names that 
530 # are defined before the preprocessor is started (similar to the -D option of 
531 # gcc). The argument of the tag is a list of macros of the form: name 
532 # or name=definition (no spaces). If the definition and the = are 
533 # omitted =1 is assumed. To prevent a macro definition from being 
534 # undefined via #undef or recursively expanded use the := operator 
535 # instead of the = operator.
537 PREDEFINED             = _DOXYGEN
539 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 
540 # this tag can be used to specify a list of macro names that should be expanded. 
541 # The macro definition that is found in the sources will be used. 
542 # Use the PREDEFINED tag if you want to use a different macro definition.
544 EXPAND_AS_DEFINED      = EASY_TYPE EASY_DESTRUCTOR EASY_METHOD
546 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 
547 # doxygen's preprocessor will remove all function-like macros that are alone 
548 # on a line, have an all uppercase name, and do not end with a semicolon. Such 
549 # function macros are typically used for boiler-plate code, and will confuse 
550 # the parser if not removed.
552 SKIP_FUNCTION_MACROS   = YES
554 #---------------------------------------------------------------------------
555 # Configuration::additions related to external references   
556 #---------------------------------------------------------------------------
558 # The TAGFILES option can be used to specify one or more tagfiles. 
559 # Optionally an initial location of the external documentation 
560 # can be added for each tagfile. The format of a tag file without 
561 # this location is as follows: 
562 #   TAGFILES = file1 file2 ... 
563 # Adding location for the tag files is done as follows: 
564 #   TAGFILES = file1=loc1 "file2 = loc2" ... 
565 # where "loc1" and "loc2" can be relative or absolute paths or 
566 # URLs. If a location is present for each tag, the installdox tool 
567 # does not have to be run to correct the links.
568 # Note that each tag file must have a unique name
569 # (where the name does NOT include the path)
570 # If a tag file is not located in the directory in which doxygen 
571 # is run, you must also specify the path to the tagfile here.
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.
577 # NOTE: The Makefile relies on this file, and it is good practice to provide it
578 # anyway.
579 GENERATE_TAGFILE       = $(DOCDIR)/$(PROJECT).tag
581 # If the ALLEXTERNALS tag is set to YES all external classes will be listed 
582 # in the class index. If set to NO only the inherited external classes 
583 # will be listed.
585 ALLEXTERNALS           = NO
587 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 
588 # in the modules index. If set to NO, only the current project's groups will 
589 # be listed.
591 EXTERNAL_GROUPS        = YES
593 # The PERL_PATH should be the absolute path and name of the perl script 
594 # interpreter (i.e. the result of `which perl').
596 PERL_PATH              = /usr/bin/perl
598 #---------------------------------------------------------------------------
599 # Configuration options related to the dot tool   
600 #---------------------------------------------------------------------------
602 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 
603 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base 
604 # or super classes. Setting the tag to NO turns the diagrams off. Note that 
605 # this option is superseded by the HAVE_DOT option below. This is only a 
606 # fallback. It is recommended to install and use dot, since it yields more 
607 # powerful graphs.
609 CLASS_DIAGRAMS         = YES
611 # If set to YES, the inheritance and collaboration graphs will hide 
612 # inheritance and usage relations if the target is undocumented 
613 # or is not a class.
615 HIDE_UNDOC_RELATIONS   = YES
617 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 
618 # available from the path. This tool is part of Graphviz, a graph visualization 
619 # toolkit from AT&T and Lucent Bell Labs. The other options in this section 
620 # have no effect if this option is set to NO (the default)
621 # NOTE: This is computed automatically by "configure". Use the --disable-dot
622 # flag if you have it but don't want to use it.
623 HAVE_DOT               = $(HAVE_DOT)
625 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 
626 # will generate a graph for each documented class showing the direct and 
627 # indirect inheritance relations. Setting this tag to YES will force the 
628 # the CLASS_DIAGRAMS tag to NO.
630 CLASS_GRAPH            = YES
632 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 
633 # will generate a graph for each documented class showing the direct and 
634 # indirect implementation dependencies (inheritance, containment, and 
635 # class references variables) of the class with other documented classes.
637 COLLABORATION_GRAPH    = YES
639 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen 
640 # will generate a graph for groups, showing the direct groups dependencies
642 GROUP_GRAPHS           = YES
644 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and 
645 # collaboration diagrams in a style similar to the OMG's Unified Modeling 
646 # Language.
648 UML_LOOK               = NO
650 # If set to YES, the inheritance and collaboration graphs will show the 
651 # relations between templates and their instances.
653 TEMPLATE_RELATIONS     = YES
655 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 
656 # tags are set to YES then doxygen will generate a graph for each documented 
657 # file showing the direct and indirect include dependencies of the file with 
658 # other documented files.
660 INCLUDE_GRAPH          = YES
662 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 
663 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each 
664 # documented header file showing the documented files that directly or 
665 # indirectly include this file.
667 INCLUDED_BY_GRAPH      = YES
669 # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will 
670 # generate a call dependency graph for every global function or class method. 
671 # Note that enabling this option will significantly increase the time of a run. 
672 # So in most cases it will be better to enable call graphs for selected 
673 # functions only using the \callgraph command.
675 CALL_GRAPH             = NO
677 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 
678 # will graphical hierarchy of all classes instead of a textual one.
680 GRAPHICAL_HIERARCHY    = YES
682 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 
683 # generated by dot. Possible values are png, jpg, or gif
684 # If left blank png will be used.
686 DOT_IMAGE_FORMAT       = png
688 # The tag DOT_PATH can be used to specify the path where the dot tool can be 
689 # found. If left blank, it is assumed the dot tool can be found on the path.
690 # NOTE: Computed automatically by "configure". If not found, HAVE_DOT is
691 # automatically set to NO.
692 DOT_PATH               = $(DOT_PATH)
694 # The DOTFILE_DIRS tag can be used to specify one or more directories that 
695 # contain dot files that are included in the documentation (see the 
696 # \dotfile command).
698 DOTFILE_DIRS           = 
700 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 
701 # graphs generated by dot. A depth value of 3 means that only nodes reachable 
702 # from the root by following a path via at most 3 edges will be shown. Nodes that 
703 # lay further from the root node will be omitted. Note that setting this option to 
704 # 1 or 2 may greatly reduce the computation time needed for large code bases. Also 
705 # note that a graph may be further truncated if the graph's image dimensions are 
706 # not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT). 
707 # If 0 is used for the depth value (the default), the graph is not depth-constrained.
709 MAX_DOT_GRAPH_DEPTH    = 0
711 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 
712 # generate a legend page explaining the meaning of the various boxes and 
713 # arrows in the dot generated graphs.
715 GENERATE_LEGEND        = YES
717 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 
718 # remove the intermediate dot files that are used to generate 
719 # the various graphs.
721 DOT_CLEANUP            = YES
723 #---------------------------------------------------------------------------
724 # Configuration::additions related to the search engine
725 #---------------------------------------------------------------------------
727 # The SEARCHENGINE tag specifies whether or not a search engine should be 
728 # used. If set to NO the values of all tags below this one will be ignored.
730 SEARCHENGINE           = NO