3 PROJECT_NAME = libxdg-basedir
5 OUTPUT_DIRECTORY = libxdg-basedir-doc
6 OUTPUT_LANGUAGE = English
7 USE_WINDOWS_ENCODING = NO
8 ALWAYS_DETAILED_SEC = NO
10 JAVADOC_AUTOBRIEF = YES
12 OPTIMIZE_OUTPUT_FOR_C = YES
17 EXTRACT_LOCAL_CLASSES = YES
18 EXTRACT_LOCAL_METHODS = YES
19 HIDE_UNDOC_MEMBERS = YES
20 HIDE_UNDOC_CLASSES = YES
22 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
23 # documentation blocks found inside the body of a function.
24 # If set to NO (the default) these blocks will be appended to the
25 # function's detailed documentation block.
27 HIDE_IN_BODY_DOCS = NO
29 # The INTERNAL_DOCS tag determines if documentation
30 # that is typed after a \internal command is included. If the tag is set
31 # to NO (the default) then the documentation will be excluded.
32 # Set it to YES to include the internal documentation.
36 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
37 # file names in lower-case letters. If set to YES upper-case letters are also
38 # allowed. This is useful if you have classes or files whose names only differ
39 # in case and if your file system supports case sensitive file names. Windows
40 # and Mac users are advised to set this option to NO.
42 CASE_SENSE_NAMES = YES
44 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
45 # will sort the (detailed) documentation of file and class members
46 # alphabetically by member name. If set to NO the members will appear in
49 SORT_MEMBER_DOCS = YES
51 # The GENERATE_TODOLIST tag can be used to enable (YES) or
52 # disable (NO) the todo list. This list is created by putting \todo
53 # commands in the documentation.
55 GENERATE_TODOLIST = YES
57 # The GENERATE_TESTLIST tag can be used to enable (YES) or
58 # disable (NO) the test list. This list is created by putting \test
59 # commands in the documentation.
61 GENERATE_TESTLIST = YES
63 # The GENERATE_BUGLIST tag can be used to enable (YES) or
64 # disable (NO) the bug list. This list is created by putting \bug
65 # commands in the documentation.
67 GENERATE_BUGLIST = YES
69 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
70 # disable (NO) the deprecated list. This list is created by putting
71 # \deprecated commands in the documentation.
73 GENERATE_DEPRECATEDLIST= YES
75 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
76 # the initial value of a variable or define consists of for it to appear in
77 # the documentation. If the initializer consists of more lines than specified
78 # here it will be hidden. Use a value of 0 to hide initializers completely.
79 # The appearance of the initializer of individual variables and defines in the
80 # documentation can be controlled using \showinitializer or \hideinitializer
81 # command in the documentation regardless of this setting.
83 MAX_INITIALIZER_LINES = 30
85 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
86 # at the bottom of the documentation of classes and structs. If set to YES the
87 # list will mention the files that were used to generate the documentation.
91 # If the sources in your project are distributed over multiple directories
92 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
93 # in the documentation. The default is NO.
97 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
98 # doxygen should invoke to get the current version for each file (typically from the
99 # version control system). Doxygen will invoke the program by executing (via
100 # popen()) the command <command> <input-file>, where <command> is the value of
101 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
102 # provided by doxygen. Whatever the program writes to standard output
103 # is used as the file version. See the manual for examples.
105 FILE_VERSION_FILTER =
107 #---------------------------------------------------------------------------
108 # configuration options related to warning and progress messages
109 #---------------------------------------------------------------------------
112 WARN_IF_UNDOCUMENTED = YES
113 WARN_IF_DOC_ERROR = YES
114 WARN_NO_PARAMDOC = NO
115 WARN_FORMAT = "$file:$line: $text"
117 #---------------------------------------------------------------------------
118 # configuration options related to the input files
119 #---------------------------------------------------------------------------
121 # The INPUT tag can be used to specify the files and/or directories that contain
122 # documented source files. You may enter file names like "myfile.cpp" or
123 # directories like "/usr/src/myproject". Separate the files or directories
128 # If the value of the INPUT tag contains directories, you can use the
129 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
130 # and *.h) to filter out the source-files in the directories. If left
131 # blank the following patterns are tested:
132 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
133 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py
137 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
138 # should be searched for input files as well. Possible values are YES and NO.
139 # If left blank NO is used.
143 # The EXCLUDE tag can be used to specify files and/or directories that should
144 # excluded from the INPUT source files. This way you can easily exclude a
145 # subdirectory from a directory tree whose root is specified with the INPUT tag.
149 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
150 # directories that are symbolic links (a Unix filesystem feature) are excluded
153 EXCLUDE_SYMLINKS = NO
155 # If the value of the INPUT tag contains directories, you can use the
156 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
157 # certain files from those directories. Note that the wildcards are matched
158 # against the file with absolute path, so to exclude all test directories
159 # for example use the pattern */test/*
163 # The EXAMPLE_PATH tag can be used to specify one or more files or
164 # directories that contain example code fragments that are included (see
165 # the \include command).
169 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
170 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
171 # and *.h) to filter out the source-files in the directories. If left
172 # blank all files are included.
176 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
177 # searched for input files to be used with the \include or \dontinclude
178 # commands irrespective of the value of the RECURSIVE tag.
179 # Possible values are YES and NO. If left blank NO is used.
181 EXAMPLE_RECURSIVE = NO
183 # The IMAGE_PATH tag can be used to specify one or more files or
184 # directories that contain image that are included in the documentation (see
185 # the \image command).
189 # The INPUT_FILTER tag can be used to specify a program that doxygen should
190 # invoke to filter for each input file. Doxygen will invoke the filter program
191 # by executing (via popen()) the command <filter> <input-file>, where <filter>
192 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
193 # input file. Doxygen will then use the output that the filter program writes
194 # to standard output. If FILTER_PATTERNS is specified, this tag will be
199 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
200 # basis. Doxygen will compare the file name with each pattern and apply the
201 # filter if there is a match. The filters are a list of the form:
202 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
203 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
204 # is applied to all files.
208 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
209 # INPUT_FILTER) will be used to filter the input files when producing source
210 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
212 FILTER_SOURCE_FILES = NO
214 #---------------------------------------------------------------------------
215 # configuration options related to source browsing
216 #---------------------------------------------------------------------------
220 STRIP_CODE_COMMENTS = YES
221 REFERENCED_BY_RELATION = YES
222 REFERENCES_RELATION = YES
223 REFERENCES_LINK_SOURCE = YES
225 #---------------------------------------------------------------------------
226 # configuration options related to the HTML output
227 #---------------------------------------------------------------------------
231 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
232 # style sheet that is used by each HTML page. It can be used to
233 # fine-tune the look of the HTML output. If the tag is left blank doxygen
234 # will generate a default style sheet. Note that doxygen will try to copy
235 # the style sheet file to the HTML output directory, so don't put your own
236 # stylesheet in the HTML output directory as well, or it will be erased!
240 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
241 # files or namespaces will be aligned in HTML using tables. If set to
242 # NO a bullet list will be used.
244 HTML_ALIGN_MEMBERS = YES
246 # The TOC_EXPAND flag can be set to YES to add extra items for group members
247 # to the contents of the HTML help documentation and to the tree view.
251 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
252 # top of each HTML page. The value NO (the default) enables the index and
253 # the value YES disables it.
257 ENUM_VALUES_PER_LINE = 4
259 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
260 # generated containing a tree-like index structure (just like the one that
261 # is generated for HTML Help). For this to work a browser that supports
262 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
263 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
264 # probably better off using the HTML help feature.
266 GENERATE_TREEVIEW = NO
270 #---------------------------------------------------------------------------
271 # configuration options related to the LaTeX output
272 #---------------------------------------------------------------------------
274 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
275 # generate Latex output.
281 LATEX_CMD_NAME = latex
283 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
284 # generate index for LaTeX. If left blank `makeindex' will be used as the
285 # default command name.
287 MAKEINDEX_CMD_NAME = makeindex
289 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
290 # LaTeX documents. This may be useful for small projects and may help to
291 # save some trees in general.
295 # The PAPER_TYPE tag can be used to set the paper type that is used
296 # by the printer. Possible values are: a4, a4wide, letter, legal and
297 # executive. If left blank a4wide will be used.
305 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
306 # command to the generated LaTeX files. This will instruct LaTeX to keep
307 # running if errors occur, instead of asking the user for help.
308 # This option is also used when generating formulas in HTML.
312 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
313 # include the index chapters (such as File Index, Compound Index, etc.)
316 LATEX_HIDE_INDICES = YES
318 #---------------------------------------------------------------------------
319 # configuration options related to the RTF output
320 #---------------------------------------------------------------------------
324 #---------------------------------------------------------------------------
325 # configuration options related to the man page output
326 #---------------------------------------------------------------------------
328 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
333 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
334 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
335 # put in front of it. If left blank `man' will be used as the default path.
339 # The MAN_EXTENSION tag determines the extension that is added to
340 # the generated man pages (default is the subroutine's section .3)
344 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
345 # then it will generate one additional man file for each entity
346 # documented in the real man page(s). These additional files
347 # only source the real man page, but without them the man command
348 # would be unable to find the correct page. The default is NO.
352 #---------------------------------------------------------------------------
353 # configuration options related to the XML output
354 #---------------------------------------------------------------------------
356 # If the GENERATE_XML tag is set to YES Doxygen will
357 # generate an XML file that captures the structure of
358 # the code including all documentation.
362 # The XML_SCHEMA tag can be used to specify an XML schema,
363 # which can be used by a validating XML parser to check the
364 # syntax of the XML files.
368 # The XML_DTD tag can be used to specify an XML DTD,
369 # which can be used by a validating XML parser to check the
370 # syntax of the XML files.
374 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
375 # dump the program listings (including syntax highlighting
376 # and cross-referencing information) to the XML output. Note that
377 # enabling this will significantly increase the size of the XML output.
379 XML_PROGRAMLISTING = YES
381 #---------------------------------------------------------------------------
382 # configuration options for the AutoGen Definitions output
383 #---------------------------------------------------------------------------
385 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
386 # generate an AutoGen Definitions (see autogen.sf.net) file
387 # that captures the structure of the code including all
388 # documentation. Note that this feature is still experimental
389 # and incomplete at the moment.
391 GENERATE_AUTOGEN_DEF = NO
393 #---------------------------------------------------------------------------
394 # configuration options related to the Perl module output
395 #---------------------------------------------------------------------------
397 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
398 # generate a Perl module file that captures the structure of
399 # the code including all documentation. Note that this
400 # feature is still experimental and incomplete at the
403 GENERATE_PERLMOD = NO
405 #---------------------------------------------------------------------------
406 # Configuration options related to the preprocessor
407 #---------------------------------------------------------------------------
409 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
410 # evaluate all C-preprocessor directives found in the sources and include
413 ENABLE_PREPROCESSING = YES
415 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
416 # names in the source code. If set to NO (the default) only conditional
417 # compilation will be performed. Macro expansion can be done in a controlled
418 # way by setting EXPAND_ONLY_PREDEF to YES.
422 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
423 # then the macro expansion is limited to the macros specified with the
424 # PREDEFINED and EXPAND_AS_DEFINED tags.
426 EXPAND_ONLY_PREDEF = NO
428 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
429 # in the INCLUDE_PATH (see below) will be search if a #include is found.
431 SEARCH_INCLUDES = YES
433 # The INCLUDE_PATH tag can be used to specify one or more directories that
434 # contain include files that are not input files but should be processed by
439 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
440 # patterns (like *.h and *.hpp) to filter out the header-files in the
441 # directories. If left blank, the patterns specified with FILE_PATTERNS will
444 INCLUDE_FILE_PATTERNS =
446 # The PREDEFINED tag can be used to specify one or more macro names that
447 # are defined before the preprocessor is started (similar to the -D option of
448 # gcc). The argument of the tag is a list of macros of the form: name
449 # or name=definition (no spaces). If the definition and the = are
450 # omitted =1 is assumed. To prevent a macro definition from being
451 # undefined via #undef or recursively expanded use the := operator
452 # instead of the = operator.
456 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
457 # this tag can be used to specify a list of macro names that should be expanded.
458 # The macro definition that is found in the sources will be used.
459 # Use the PREDEFINED tag if you want to use a different macro definition.
463 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
464 # doxygen's preprocessor will remove all function-like macros that are alone
465 # on a line, have an all uppercase name, and do not end with a semicolon. Such
466 # function macros are typically used for boiler-plate code, and will confuse
467 # the parser if not removed.
469 SKIP_FUNCTION_MACROS = YES
471 #---------------------------------------------------------------------------
472 # Configuration::additions related to external references
473 #---------------------------------------------------------------------------
475 # The TAGFILES option can be used to specify one or more tagfiles.
476 # Optionally an initial location of the external documentation
477 # can be added for each tagfile. The format of a tag file without
478 # this location is as follows:
479 # TAGFILES = file1 file2 ...
480 # Adding location for the tag files is done as follows:
481 # TAGFILES = file1=loc1 "file2 = loc2" ...
482 # where "loc1" and "loc2" can be relative or absolute paths or
483 # URLs. If a location is present for each tag, the installdox tool
484 # does not have to be run to correct the links.
485 # Note that each tag file must have a unique name
486 # (where the name does NOT include the path)
487 # If a tag file is not located in the directory in which doxygen
488 # is run, you must also specify the path to the tagfile here.
492 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
493 # a tag file that is based on the input files it reads.
497 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
498 # in the class index. If set to NO only the inherited external classes
503 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
504 # in the modules index. If set to NO, only the current project's groups will
507 EXTERNAL_GROUPS = YES
509 # The PERL_PATH should be the absolute path and name of the perl script
510 # interpreter (i.e. the result of `which perl').
512 PERL_PATH = /usr/bin/perl
514 #---------------------------------------------------------------------------
515 # Configuration options related to the dot tool
516 #---------------------------------------------------------------------------
518 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
519 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
520 # or super classes. Setting the tag to NO turns the diagrams off. Note that
521 # this option is superseded by the HAVE_DOT option below. This is only a
522 # fallback. It is recommended to install and use dot, since it yields more
527 # If set to YES, the inheritance and collaboration graphs will hide
528 # inheritance and usage relations if the target is undocumented
531 HIDE_UNDOC_RELATIONS = YES
533 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
534 # available from the path. This tool is part of Graphviz, a graph visualization
535 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
536 # have no effect if this option is set to NO (the default)
540 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
541 # will generate a graph for each documented class showing the direct and
542 # indirect inheritance relations. Setting this tag to YES will force the
543 # the CLASS_DIAGRAMS tag to NO.
547 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
548 # will generate a graph for each documented class showing the direct and
549 # indirect implementation dependencies (inheritance, containment, and
550 # class references variables) of the class with other documented classes.
552 COLLABORATION_GRAPH = YES
554 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
555 # will generate a graph for groups, showing the direct groups dependencies
559 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
560 # collaboration diagrams in a style similar to the OMG's Unified Modeling
565 # If set to YES, the inheritance and collaboration graphs will show the
566 # relations between templates and their instances.
568 TEMPLATE_RELATIONS = NO
570 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
571 # tags are set to YES then doxygen will generate a graph for each documented
572 # file showing the direct and indirect include dependencies of the file with
573 # other documented files.
577 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
578 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
579 # documented header file showing the documented files that directly or
580 # indirectly include this file.
582 INCLUDED_BY_GRAPH = YES
584 # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
585 # generate a call dependency graph for every global function or class method.
586 # Note that enabling this option will significantly increase the time of a run.
587 # So in most cases it will be better to enable call graphs for selected
588 # functions only using the \callgraph command.
592 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then doxygen will
593 # generate a caller dependency graph for every global function or class method.
594 # Note that enabling this option will significantly increase the time of a run.
595 # So in most cases it will be better to enable caller graphs for selected
596 # functions only using the \callergraph command.
600 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
601 # will graphical hierarchy of all classes instead of a textual one.
603 GRAPHICAL_HIERARCHY = YES
605 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
606 # then doxygen will show the dependencies a directory has on other directories
607 # in a graphical way. The dependency relations are determined by the #include
608 # relations between the files in the directories.
610 DIRECTORY_GRAPH = YES
612 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
613 # generated by dot. Possible values are png, jpg, or gif
614 # If left blank png will be used.
616 DOT_IMAGE_FORMAT = png
618 # The tag DOT_PATH can be used to specify the path where the dot tool can be
619 # found. If left blank, it is assumed the dot tool can be found in the path.
623 # The DOTFILE_DIRS tag can be used to specify one or more directories that
624 # contain dot files that are included in the documentation (see the
629 # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
630 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
631 # this value, doxygen will try to truncate the graph, so that it fits within
632 # the specified constraint. Beware that most browsers cannot cope with very
635 MAX_DOT_GRAPH_WIDTH = 1024
637 # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
638 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
639 # this value, doxygen will try to truncate the graph, so that it fits within
640 # the specified constraint. Beware that most browsers cannot cope with very
643 MAX_DOT_GRAPH_HEIGHT = 1024
645 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
646 # graphs generated by dot. A depth value of 3 means that only nodes reachable
647 # from the root by following a path via at most 3 edges will be shown. Nodes
648 # that lay further from the root node will be omitted. Note that setting this
649 # option to 1 or 2 may greatly reduce the computation time needed for large
650 # code bases. Also note that a graph may be further truncated if the graph's
651 # image dimensions are not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH
652 # and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the depth value (the default),
653 # the graph is not depth-constrained.
655 MAX_DOT_GRAPH_DEPTH = 0
657 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
658 # background. This is disabled by default, which results in a white background.
659 # Warning: Depending on the platform used, enabling this option may lead to
660 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
665 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
666 # files in one run (i.e. multiple -o and -T options on the command line). This
667 # makes dot run faster, but since only newer versions of dot (>1.8.10)
668 # support this, this feature is disabled by default.
670 DOT_MULTI_TARGETS = NO
672 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
673 # generate a legend page explaining the meaning of the various boxes and
674 # arrows in the dot generated graphs.
676 GENERATE_LEGEND = YES
678 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
679 # remove the intermediate dot files that are used to generate
680 # the various graphs.
684 #---------------------------------------------------------------------------
685 # Configuration::additions related to the search engine
686 #---------------------------------------------------------------------------
688 # The SEARCHENGINE tag specifies whether or not a search engine should be
689 # used. If set to NO the values of all tags below this one will be ignored.