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
7 # TAG = value [value, ...]
8 # For lists items can also be appended using:
9 # TAG += value [value, ...]
10 # Values that contain spaces should be placed between quotes (" ")
12 #---------------------------------------------------------------------------
13 # General configuration options
14 #---------------------------------------------------------------------------
16 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
17 # by quotes) that should identify the project.
19 PROJECT_NAME = "OpenBeOS Support Kit"
21 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
22 # This could be handy for archiving the generated documentation or
23 # if some version control system is used.
27 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
28 # base path where the generated documentation will be put.
29 # If a relative path is entered, it will be relative to the location
30 # where doxygen was started. If left blank the current directory will be used.
34 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
35 # documentation generated by doxygen is written. Doxygen will use this
36 # information to generate all constant output in the proper language.
37 # The default language is English, other supported languages are:
38 # Dutch, French, Italian, Czech, Swedish, German, Finnish, Japanese,
39 # Spanish, Russian, Croatian, Polish, and Portuguese.
41 OUTPUT_LANGUAGE = English
43 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
44 # documentation are documented, even if no documentation was available.
45 # Private class members and static file members will be hidden unless
46 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
50 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
51 # will be included in the documentation.
55 # If the EXTRACT_STATIC tag is set to YES all static members of a file
56 # will be included in the documentation.
60 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
61 # undocumented members of documented classes, files or namespaces.
62 # If set to NO (the default) these members will be included in the
63 # various overviews, but no documentation section is generated.
64 # This option has no effect if EXTRACT_ALL is enabled.
66 HIDE_UNDOC_MEMBERS = NO
68 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
69 # undocumented classes that are normally visible in the class hierarchy.
70 # If set to NO (the default) these class will be included in the various
71 # overviews. This option has no effect if EXTRACT_ALL is enabled.
73 HIDE_UNDOC_CLASSES = NO
75 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
76 # include brief member descriptions after the members that are listed in
77 # the file and class documentation (similar to JavaDoc).
78 # Set to NO to disable this.
80 BRIEF_MEMBER_DESC = YES
82 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
83 # the brief description of a member or function before the detailed description.
84 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
85 # brief descriptions will be completely suppressed.
89 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
90 # Doxygen will generate a detailed section even if there is only a brief
93 ALWAYS_DETAILED_SEC = NO
95 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
96 # path before files name in the file list and in the header files. If set
97 # to NO the shortest path that makes the file name unique will be used.
101 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
102 # can be used to strip a user defined part of the path. Stripping is
103 # only done if one of the specified strings matches the left-hand part of
104 # the path. It is allowed to use relative paths in the argument list.
106 STRIP_FROM_PATH = /cvsroot/open-beos/current
108 # The INTERNAL_DOCS tag determines if documentation
109 # that is typed after a \internal command is included. If the tag is set
110 # to NO (the default) then the documentation will be excluded.
111 # Set it to YES to include the internal documentation.
115 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
116 # generate a class diagram (in Html and LaTeX) for classes with base or
117 # super classes. Setting the tag to NO turns the diagrams off.
121 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
122 # be generated. Documented entities will be cross-referenced with these sources.
126 # Setting the INLINE_SOURCES tag to YES will include the body
127 # of functions and classes directly in the documentation.
131 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
132 # doxygen to hide any special comment blocks from generated source code
133 # fragments. Normal C and C++ comments will always remain visible.
135 STRIP_CODE_COMMENTS = YES
137 # If the CASE_SENSE_NAMES tag is set to NO (the default) then Doxygen
138 # will only generate file names in lower case letters. If set to
139 # YES upper case letters are also allowed. This is useful if you have
140 # classes or files whose names only differ in case and if your file system
141 # supports case sensitive file names.
143 CASE_SENSE_NAMES = YES
145 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
146 # will show members with their full class and namespace scopes in the
147 # documentation. If set to YES the scope will be hidden.
149 HIDE_SCOPE_NAMES = NO
151 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
152 # will generate a verbatim copy of the header file for each class for
153 # which an include is specified. Set to NO to disable this.
155 VERBATIM_HEADERS = YES
157 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
158 # will put list of the files that are included by a file in the documentation
161 SHOW_INCLUDE_FILES = YES
163 # If the JAVADOC_AUTOBRIEF tag is set to YES (the default) then Doxygen
164 # will interpret the first line (until the first dot) of a JavaDoc-style
165 # comment as the brief description. If set to NO, the Javadoc-style will
166 # behave just like the Qt-style comments.
168 JAVADOC_AUTOBRIEF = YES
170 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
171 # member inherits the documentation from any documented member that it
176 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
177 # is inserted in the documentation for inline members.
181 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
182 # will sort the (detailed) documentation of file and class members
183 # alphabetically by member name. If set to NO the members will appear in
186 SORT_MEMBER_DOCS = YES
188 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
189 # Doxygen uses this value to replace tabs by spaces in code fragments.
193 # The ENABLE_SECTIONS tag can be used to enable conditional
194 # documentation sections, marked by \if sectionname ... \endif.
198 # The GENERATE_TODOLIST tag can be used to enable (YES) or
199 # disable (NO) the todo list. This list is created by putting \todo
200 # commands in the documentation.
202 GENERATE_TODOLIST = YES
204 # The GENERATE_TESTLIST tag can be used to enable (YES) or
205 # disable (NO) the test list. This list is created by putting \test
206 # commands in the documentation.
208 GENERATE_TESTLIST = YES
210 #---------------------------------------------------------------------------
211 # configuration options related to warning and progress messages
212 #---------------------------------------------------------------------------
214 # The QUIET tag can be used to turn on/off the messages that are generated
215 # by doxygen. Possible values are YES and NO. If left blank NO is used.
219 # The WARNINGS tag can be used to turn on/off the warning messages that are
220 # generated by doxygen. Possible values are YES and NO. If left blank
225 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
226 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
227 # automatically be disabled.
229 WARN_IF_UNDOCUMENTED = YES
231 # The WARN_FORMAT tag determines the format of the warning messages that
232 # doxygen can produce. The string should contain the $file, $line, and $text
233 # tags, which will be replaced by the file and line number from which the
234 # warning originated and the warning text.
236 WARN_FORMAT = "$file:$line: $text"
238 #---------------------------------------------------------------------------
239 # configuration options related to the input files
240 #---------------------------------------------------------------------------
242 # The INPUT tag can be used to specify the files and/or directories that contain
243 # documented source files. You may enter file names like "myfile.cpp" or
244 # directories like "/usr/src/myproject". Separate the files or directories
247 INPUT = ../../../src/kits/support ../../../headers/os/support
249 # If the value of the INPUT tag contains directories, you can use the
250 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
251 # and *.h) to filter out the source-files in the directories. If left
252 # blank all files are included.
254 FILE_PATTERNS = *.cpp *.h
256 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
257 # should be searched for input files as well. Possible values are YES and NO.
258 # If left blank NO is used.
262 # The EXCLUDE tag can be used to specify files and/or directories that should
263 # excluded from the INPUT source files. This way you can easily exclude a
264 # subdirectory from a directory tree whose root is specified with the INPUT tag.
268 # If the value of the INPUT tag contains directories, you can use the
269 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
270 # certain files from those directories.
274 # The EXAMPLE_PATH tag can be used to specify one or more files or
275 # directories that contain example code fragments that are included (see
276 # the \include command).
280 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
281 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
282 # and *.h) to filter out the source-files in the directories. If left
283 # blank all files are included.
287 # The IMAGE_PATH tag can be used to specify one or more files or
288 # directories that contain image that are included in the documentation (see
289 # the \image command).
293 # The INPUT_FILTER tag can be used to specify a program that doxygen should
294 # invoke to filter for each input file. Doxygen will invoke the filter program
295 # by executing (via popen()) the command <filter> <input-file>, where <filter>
296 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
297 # input file. Doxygen will then use the output that the filter program writes
298 # to standard output.
302 #---------------------------------------------------------------------------
303 # configuration options related to the alphabetical class index
304 #---------------------------------------------------------------------------
306 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
307 # of all compounds will be generated. Enable this if the project
308 # contains a lot of classes, structs, unions or interfaces.
310 ALPHABETICAL_INDEX = NO
312 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
313 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
314 # in which this list will be split (can be a number in the range [1..20])
316 COLS_IN_ALPHA_INDEX = 5
318 # In case all classes in a project start with a common prefix, all
319 # classes will be put under the same header in the alphabetical index.
320 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
321 # should be ignored while generating the index headers.
325 #---------------------------------------------------------------------------
326 # configuration options related to the HTML output
327 #---------------------------------------------------------------------------
329 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
330 # generate HTML output.
334 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
335 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
336 # put in front of it. If left blank `html' will be used as the default path.
340 # The HTML_HEADER tag can be used to specify a personal HTML header for
341 # each generated HTML page. If it is left blank doxygen will generate a
346 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
347 # each generated HTML page. If it is left blank doxygen will generate a
352 # The HTML_STYLESHEET tag can be used to specify a user defined cascading
353 # style sheet that is used by each HTML page. It can be used to
354 # fine-tune the look of the HTML output. If the tag is left blank doxygen
355 # will generate a default style sheet
359 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
360 # files or namespaces will be aligned in HTML using tables. If set to
361 # NO a bullet list will be used.
363 HTML_ALIGN_MEMBERS = YES
365 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
366 # will be generated that can be used as input for tools like the
367 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
368 # of the generated HTML documentation.
370 GENERATE_HTMLHELP = NO
372 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
373 # top of each HTML page. The value NO (the default) enables the index and
374 # the value YES disables it.
378 #---------------------------------------------------------------------------
379 # configuration options related to the LaTeX output
380 #---------------------------------------------------------------------------
382 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
383 # generate Latex output.
387 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
388 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
389 # put in front of it. If left blank `latex' will be used as the default path.
393 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
394 # LaTeX documents. This may be useful for small projects and may help to
395 # save some trees in general.
399 # The PAPER_TYPE tag can be used to set the paper type that is used
400 # by the printer. Possible values are: a4, a4wide, letter, legal and
401 # executive. If left blank a4wide will be used.
405 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
406 # packages that should be included in the LaTeX output.
410 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
411 # the generated latex document. The header should contain everything until
412 # the first chapter. If it is left blank doxygen will generate a
413 # standard header. Notice: only use this tag if you know what you are doing!
417 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
418 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
419 # contain links (just like the HTML output) instead of page references
420 # This makes the output suitable for online browsing using a pdf viewer.
424 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
425 # plain latex in the generated Makefile. Set this option to YES to get a
426 # higher quality PDF documentation.
430 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
431 # command to the generated LaTeX files. This will instruct LaTeX to keep
432 # running if errors occur, instead of asking the user for help.
433 # This option is also used when generating formulas in HTML.
437 #---------------------------------------------------------------------------
438 # configuration options related to the RTF output
439 #---------------------------------------------------------------------------
441 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
442 # The RTF output is optimised for Word 97 and may not look very pretty with
443 # other RTF readers or editors.
447 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
448 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
449 # put in front of it. If left blank `rtf' will be used as the default path.
453 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
454 # RTF documents. This may be useful for small projects and may help to
455 # save some trees in general.
459 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
460 # will contain hyperlink fields. The RTF file will
461 # contain links (just like the HTML output) instead of page references.
462 # This makes the output suitable for online browsing using a WORD or other.
463 # programs which support those fields.
464 # Note: wordpad (write) and others do not support links.
468 # Load stylesheet definitions from file. Syntax is similar to doxygen's
469 # config file, i.e. a series of assigments. You only have to provide
470 # replacements, missing definitions are set to their default value.
472 RTF_STYLESHEET_FILE =
474 #---------------------------------------------------------------------------
475 # configuration options related to the man page output
476 #---------------------------------------------------------------------------
478 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
483 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
484 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
485 # put in front of it. If left blank `man' will be used as the default path.
489 # The MAN_EXTENSION tag determines the extension that is added to
490 # the generated man pages (default is the subroutine's section .3)
494 #---------------------------------------------------------------------------
495 # configuration options related to the XML output
496 #---------------------------------------------------------------------------
498 # If the GENERATE_XML tag is set to YES Doxygen will
499 # generate an XML file that captures the structure of
500 # the code including all documentation. Warning: This feature
501 # is still experimental and very incomplete.
505 #---------------------------------------------------------------------------
506 # Configuration options related to the preprocessor
507 #---------------------------------------------------------------------------
509 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
510 # evaluate all C-preprocessor directives found in the sources and include
513 ENABLE_PREPROCESSING = YES
515 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
516 # names in the source code. If set to NO (the default) only conditional
517 # compilation will be performed. Macro expansion can be done in a controlled
518 # way by setting EXPAND_ONLY_PREDEF to YES.
522 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
523 # then the macro expansion is limited to the macros specified with the
524 # PREDEFINED and EXPAND_AS_PREDEFINED tags.
526 EXPAND_ONLY_PREDEF = NO
528 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
529 # in the INCLUDE_PATH (see below) will be search if a #include is found.
531 SEARCH_INCLUDES = YES
533 # The INCLUDE_PATH tag can be used to specify one or more directories that
534 # contain include files that are not input files but should be processed by
539 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
540 # patterns (like *.h and *.hpp) to filter out the header-files in the
541 # directories. If left blank, the patterns specified with FILE_PATTERNS will
544 INCLUDE_FILE_PATTERNS =
546 # The PREDEFINED tag can be used to specify one or more macro names that
547 # are defined before the preprocessor is started (similar to the -D option of
548 # gcc). The argument of the tag is a list of macros of the form: name
549 # or name=definition (no spaces). If the definition and the = are
550 # omitted =1 is assumed.
554 # If the MACRO_EXPANSION and EXPAND_PREDEF_ONLY tags are set to YES then
555 # this tag can be used to specify a list of macro names that should be expanded.
556 # The macro definition that is found in the sources will be used.
557 # Use the PREDEFINED tag if you want to use a different macro definition.
561 #---------------------------------------------------------------------------
562 # Configuration::addtions related to external references
563 #---------------------------------------------------------------------------
565 # The TAGFILES tag can be used to specify one or more tagfiles.
569 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
570 # a tag file that is based on the input files it reads.
574 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
575 # in the class index. If set to NO only the inherited external classes
580 # The PERL_PATH should be the absolute path and name of the perl script
581 # interpreter (i.e. the result of `which perl').
583 PERL_PATH = /usr/bin/perl
585 #---------------------------------------------------------------------------
586 # Configuration options related to the dot tool
587 #---------------------------------------------------------------------------
589 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
590 # available from the path. This tool is part of Graphviz, a graph visualization
591 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
592 # have no effect if this option is set to NO (the default)
596 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
597 # will generate a graph for each documented class showing the direct and
598 # indirect inheritance relations. Setting this tag to YES will force the
599 # the CLASS_DIAGRAMS tag to NO.
603 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
604 # will generate a graph for each documented class showing the direct and
605 # indirect implementation dependencies (inheritance, containment, and
606 # class references variables) of the class with other documented classes.
608 COLLABORATION_GRAPH = YES
610 # If the ENABLE_PREPROCESSING, INCLUDE_GRAPH, and HAVE_DOT tags are set to
611 # YES then doxygen will generate a graph for each documented file showing
612 # the direct and indirect include dependencies of the file with other
617 # If the ENABLE_PREPROCESSING, INCLUDED_BY_GRAPH, and HAVE_DOT tags are set to
618 # YES then doxygen will generate a graph for each documented header file showing
619 # the documented files that directly or indirectly include this file
621 INCLUDED_BY_GRAPH = YES
623 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
624 # will graphical hierarchy of all classes instead of a textual one.
626 GRAPHICAL_HIERARCHY = YES
628 # The tag DOT_PATH can be used to specify the path where the dot tool can be
629 # found. If left blank, it is assumed the dot tool can be found on the path.
633 # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
634 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
635 # this value, doxygen will try to truncate the graph, so that it fits within
636 # the specified constraint. Beware that most browsers cannot cope with very
639 MAX_DOT_GRAPH_WIDTH = 1024
641 # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
642 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
643 # this value, doxygen will try to truncate the graph, so that it fits within
644 # the specified constraint. Beware that most browsers cannot cope with very
647 MAX_DOT_GRAPH_HEIGHT = 1024
649 #---------------------------------------------------------------------------
650 # Configuration::addtions related to the search engine
651 #---------------------------------------------------------------------------
653 # The SEARCHENGINE tag specifies whether or not a search engine should be
654 # used. If set to NO the values of all tags below this one will be ignored.
658 # The CGI_NAME tag should be the name of the CGI script that
659 # starts the search engine (doxysearch) with the correct parameters.
660 # A script with this name will be generated by doxygen.
662 CGI_NAME = search.cgi
664 # The CGI_URL tag should be the absolute URL to the directory where the
665 # cgi binaries are located. See the documentation of your http daemon for
670 # The DOC_URL tag should be the absolute URL to the directory where the
671 # documentation is located. If left blank the absolute path to the
672 # documentation, with file:// prepended to it, will be used.
676 # The DOC_ABSPATH tag should be the absolute path to the directory where the
677 # documentation is located. If left blank the directory on the local machine
682 # The BIN_ABSPATH tag must point to the directory where the doxysearch binary
685 BIN_ABSPATH = /usr/local/bin/
687 # The EXT_DOC_PATHS tag can be used to specify one or more paths to
688 # documentation generated for other projects. This allows doxysearch to search
689 # the documentation for these projects as well.