projects/build/bsp.dxyfile

3 # This file describes the settings to be used by the documentation system
6 # All text after a hash (#) is considered a comment and will be ignored
9 # For lists items can also be appended using:
11 # Values that contain spaces should be placed between quotes (" ")
30 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
31 # This could be handy for archiving the generated documentation or
37 # base path where the generated documentation will be put.
38 # If a relative path is entered, it will be relative to the location
39 # where doxygen was started. If left blank the current directory will be used.
46 # Enabling this option can be useful when feeding doxygen a huge amount of
75 # brief descriptions will be completely suppressed.
81 # in this list, if found as the leading text of the brief description, will be
110 # operators of the base classes will not be shown.
116 # to NO the shortest path that makes the file name unique will be used.
121 # can be used to strip a user-defined part of the path. Stripping is
123 # the path. The tag can be used to show relative paths in the file list.
129 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
139 # (but less readable) file names. This can be useful is your file systems
160 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
162 # comments) as a brief description. This used to be the default behaviour.
176 # be part of the file/class/namespace that contains it.
180 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
185 # This tag can be used to specify a number of aliases that acts
196 # For instance, some of the names that are used will be different. The list
197 # of all members will be omitted, etc.
203 # Java. For instance, namespaces will be presented as packages, qualified
252 # all members of a group must be documented explicitly.
257 # the same type (for instance a group of public functions) to be put as a
259 # NO to prevent subgrouping. Alternatively, this can be done per class using
268 # namespace, or class. And the struct will be named TypeS. This can typically
269 # be useful for C code in case the coding convention dictates that all compound
276 # When the cache is full, less often used symbols will be written to disk.
279 # doxygen to be busy swapping symbols to and from disk most of the time
296 # Private class members and static file members will be hidden unless
302 # will be included in the documentation.
307 # will be included in the documentation.
312 # defined locally in source files will be included in the documentation.
324 # If this flag is set to YES, the members of anonymous namespaces will be
326 # 'anonymous_namespace{file}', where file will be replaced with the base
334 # If set to NO (the default) these members will be included in the
342 # If set to NO (the default) these classes will be included in the various
349 # If set to NO (the default) these declarations will be included in the
356 # If set to NO (the default) these blocks will be appended to the
363 # to NO (the default) then the documentation will be excluded.
378 # documentation. If set to YES the scope will be hidden.
413 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
415 # NO (the default), the class list will be sorted only by class name,
423 # The GENERATE_TODOLIST tag can be used to enable (YES) or
429 # The GENERATE_TESTLIST tag can be used to enable (YES) or
435 # The GENERATE_BUGLIST tag can be used to enable (YES) or
441 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
447 # The ENABLED_SECTIONS tag can be used to enable conditional
455 # here it will be hidden. Use a value of 0 to hide initializers completely.
457 # documentation can be controlled using \showinitializer or \hideinitializer
486 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
496 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by
500 # file name after the option, if omitted DoxygenLayout.xml will be used as the name
509 # The QUIET tag can be used to turn on/off the messages that are generated
514 # The WARNINGS tag can be used to turn on/off the warning messages that are
522 # automatically be disabled.
533 # This WARN_NO_PARAMDOC option can be abled to get warnings for
543 # tags, which will be replaced by the file and line number from which the
545 # $version, which will be replaced by the version of the file (if it could
546 # be obtained via FILE_VERSION_FILTER)
550 # The WARN_LOGFILE tag can be used to specify a file to which warning
551 # and error messages should be written. If left blank the output is written
560 # The INPUT tag can be used to specify the files and/or directories that contain
570 # This tag can be used to specify the character encoding of the source files
617 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
618 # should be searched for input files as well. Possible values are YES and NO.
623 # The EXCLUDE tag can be used to specify files and/or directories that should
629 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
643 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
644 # (namespaces, classes, functions, etc.) that should be excluded from the
645 # output. The symbol name can be a fully qualified name, a word, or if the
651 # The EXAMPLE_PATH tag can be used to specify one or more files or
664 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
665 # searched for input files to be used with the \include or \dontinclude
671 # The IMAGE_PATH tag can be used to specify one or more files or
677 # The INPUT_FILTER tag can be used to specify a program that doxygen should
682 # to standard output.  If FILTER_PATTERNS is specified, this tag will be
687 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
697 # INPUT_FILTER) will be used to filter the input files when producing source
707 # be generated. Documented entities will be cross-referenced with these sources.
726 # functions referencing it will be listed.
732 # called/used by that function will be listed.
762 # of all compounds will be generated. Enable this if the project
768 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
769 # in which this list will be split (can be a number in the range [1..20])
774 # classes will be put under the same header in the alphabetical index.
775 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
776 # should be ignored while generating the index headers.
789 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
790 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
791 # put in front of it. If left blank `html' will be used as the default path.
795 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
801 # The HTML_HEADER tag can be used to specify a personal HTML header for
807 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
813 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
814 # style sheet that is used by each HTML page. It can be used to
818 # stylesheet in the HTML output directory as well, or it will be erased!
823 # files or namespaces will be aligned in HTML using tables. If set to
824 # NO a bullet list will be used.
829 # documentation will contain sections that can be hidden and shown after the
837 # will be generated that can be used as input for Apple's Xcode 3
851 # can be grouped.
856 # should uniquely identify the documentation set bundle. This should be a
863 # will be generated that can be used as input for tools like the
870 # be used to specify the file name of the resulting .chm file. You
871 # can add a path in front of the file if the result should not be
877 # be used to specify the location (absolute path including file name) of
885 # it should be included in the master .chm file (NO).
901 # The TOC_EXPAND flag can be set to YES to add extra items for group members
907 # are set, an additional index file will be generated that can be used as input for
914 # be used to specify the file name of the resulting .qch file.
932 # be used to specify the location of Qt's qhelpgenerator.
938 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
944 # This tag can be used to set the number of enum values (range [1..20])
950 # structure should be generated to display hierarchical information.
951 # If the tag value is set to FRAME, a side panel will be generated
966 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
976 # to force them to be regenerated.
989 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
990 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
991 # put in front of it. If left blank `latex' will be used as the default path.
995 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
996 # invoked. If left blank `latex' will be used as the default command name.
1000 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1001 # generate index for LaTeX. If left blank `makeindex' will be used as the
1007 # LaTeX documents. This may be useful for small projects and may help to
1012 # The PAPER_TYPE tag can be used to set the paper type that is used
1014 # executive. If left blank a4wide will be used.
1018 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1019 # packages that should be included in the LaTeX output.
1023 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1037 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1066 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1067 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1068 # put in front of it. If left blank `rtf' will be used as the default path.
1073 # RTF documents. This may be useful for small projects and may help to
1107 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
1108 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1109 # put in front of it. If left blank `man' will be used as the default path.
1122 # would be unable to find the correct page. The default is NO.
1136 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
1137 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1138 # put in front of it. If left blank `xml' will be used as the default path.
1142 # The XML_SCHEMA tag can be used to specify an XML schema,
1143 # which can be used by a validating XML parser to check the
1148 # The XML_DTD tag can be used to specify an XML DTD,
1149 # which can be used by a validating XML parser to check the
1186 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
1191 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1192 # nicely formatted so it can be parsed by a human reader.  This is useful
1194 # tag is set to NO the size of the Perl module output will be much smaller
1218 # compilation will be performed. Macro expansion can be done in a controlled
1230 # in the INCLUDE_PATH (see below) will be search if a #include is found.
1234 # The INCLUDE_PATH tag can be used to specify one or more directories that
1235 # contain include files that are not input files but should be processed by
1243 # be used.
1247 # The PREDEFINED tag can be used to specify one or more macro names that
1260 # this tag can be used to specify a list of macro names that should be expanded.
1261 # The macro definition that is found in the sources will be used.
1278 # The TAGFILES option can be used to specify one or more tagfiles.
1280 # can be added for each tagfile. The format of a tag file without
1285 # where "loc1" and "loc2" can be relative or absolute paths or
1287 # does not have to be run to correct the links.
1300 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1302 # will be listed.
1306 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1308 # be listed.
1312 # The PERL_PATH should be the absolute path and name of the perl script
1334 # the mscgen tool resides. If left empty the tool is assumed to be found in the
1357 # which can be done by putting it in a standard location or by setting the
1363 # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1422 # the time of a run. So in most cases it will be better to enable call graphs
1430 # the time of a run. So in most cases it will be better to enable caller
1447 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1449 # If left blank png will be used.
1453 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1454 # found. If left blank, it is assumed the dot tool can be found in the path.
1458 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1464 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1465 # nodes that will be shown in the graph. If the number of nodes in a graph
1469 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1470 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1474 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1476 # from the root by following a path via at most 3 edges will be shown. Nodes
1477 # that lay further from the root node will be omitted. Note that setting this
1479 # code bases. Also note that the size of a graph can be further restricted by
1515 # The SEARCHENGINE tag specifies whether or not a search engine should be
1516 # used. If set to NO the values of all tags below this one will be ignored.