projects/build/bsp.dxyfile

3 # This file describes the settings to be used by the documentation system
30 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
36 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
38 # If a relative path is entered, it will be relative to the location
43 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
52 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
54 # information to generate all constant output in the proper language.
65 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
67 # the file and class documentation (similar to JavaDoc).
68 # Set to NO to disable this.
72 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
74 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
80 # that is used to form the text in various listings. Each string
101 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
107 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
114 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
116 # to NO the shortest path that makes the file name unique will be used.
120 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
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.
125 # path to strip.
129 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
131 # the reader which header file to include in order to use a class.
134 # are normally passed to the compiler using the -I flag.
138 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
144 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
146 # comment as the brief description. If set to NO, the JavaDoc
152 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
154 # comment as the brief description. If set to NO, the comments
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.
163 # The new default is to treat a multi-line C++ comment block as a detailed
164 # description. Set this tag to YES if you prefer the old behaviour instead.
168 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
174 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
175 # a new page for each member. If set to NO, the documentation of a member will
180 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
181 # Doxygen uses this value to replace tabs by spaces in code fragments.
185 # This tag can be used to specify a number of aliases that acts
187 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
190 # You can put \n's in the value part of an alias to insert newlines.
194 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
201 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
208 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
214 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
221 # to include (a tag file for) the STL sources as input, then you should
222 # set this tag to YES in order to let doxygen match functions declarations and
229 # If you use Microsoft's C++/CLI language, you should set this option to YES to
234 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
240 # For Microsoft's IDL there are propget and propput attributes to indicate getter
241 # and setter methods for a property. Setting this option to YES (the default)
242 # will make doxygen to replace the get and set methods by a property in the
244 # setting a simple type. If this is not the case, or you want to show the
245 # methods anyway, you should set this option to NO.
250 # tag is set to YES, then doxygen will reuse the documentation of the first
256 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
257 # the same type (for instance a group of public functions) to be put as a
258 # subgroup of that type (e.g. under the Public Functions section). Set it to
259 # NO to prevent subgrouping. Alternatively, this can be done per class using
274 # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
275 # determine which symbols to keep in memory and which to flush to disk.
276 # When the cache is full, less often used symbols will be written to disk.
277 # For small to medium size projects (<1000 input files) the default value is
279 # doxygen to be busy swapping symbols to and from disk most of the time
286 # corresponding to a cache size of 2^16 = 65536 symbols
294 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
297 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
301 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
306 # If the EXTRACT_STATIC tag is set to YES all static members of a file
311 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
313 # If set to NO only classes defined in header files are included.
317 # This flag is only useful for Objective-C code. When set to YES local
320 # If set to NO (the default) only methods in the interface are included.
324 # If this flag is set to YES, the members of anonymous namespaces will be
332 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
334 # If set to NO (the default) these members will be included in the
340 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
342 # If set to NO (the default) these classes will be included in the various
347 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
349 # If set to NO (the default) these declarations will be included in the
354 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
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.
364 # Set it to YES to include the internal documentation.
368 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
369 # file names in lower-case letters. If set to YES upper-case letters are also
372 # and Mac users are advised to set this option to NO.
376 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
378 # documentation. If set to YES the scope will be hidden.
382 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
388 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
393 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
395 # alphabetically by member name. If set to NO the members will appear in
400 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
402 # by member name. If set to NO (the default) the members will appear in
407 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
408 # hierarchy of group names into alphabetical order. If set to NO (the default)
413 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
414 # sorted by fully-qualified names, including namespaces. If set to
417 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
418 # Note: This option applies only to the class list, not to the
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
453 # the initial value of a variable or define consists of for it to appear in
455 # here it will be hidden. Use a value of 0 to hide initializers completely.
462 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
463 # at the bottom of the documentation of classes and structs. If set to YES the
464 # list will mention the files that were used to generate the documentation.
469 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
474 # Set the SHOW_FILES tag to NO to disable the generation of the Files page.
480 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the
486 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
487 # doxygen should invoke to get the current version for each file (typically from
491 # provided by doxygen. Whatever the program writes to standard output
496 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by
506 # configuration options related to warning and progress messages
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
520 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
521 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
526 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
533 # This WARN_NO_PARAMDOC option can be abled to get warnings for
535 # or return value. If set to NO (the default) doxygen will only warn about
550 # The WARN_LOGFILE tag can be used to specify a file to which warning
552 # to stderr.
557 # configuration options related to the input files
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
579 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
580 # and *.h) to filter out the source-files in the directories. If left
617 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
623 # The EXCLUDE tag can be used to specify files and/or directories that should
636 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
638 # against the file with absolute path, so to exclude all test directories
643 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
651 # The EXAMPLE_PATH tag can be used to specify one or more files or
658 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
659 # and *.h) to filter out the source-files in the directories. If left
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
678 # invoke to filter for each input file. Doxygen will invoke the filter program
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
692 # is applied to all files.
696 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
697 # INPUT_FILTER) will be used to filter the input files when producing source
698 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
703 # configuration options related to source browsing
706 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
709 # VERBATIM_HEADERS is set to NO.
713 # Setting the INLINE_SOURCES tag to YES will include the body
718 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
719 # doxygen to hide any special comment blocks from generated source code
724 # If the REFERENCED_BY_RELATION tag is set to YES
730 # If the REFERENCES_RELATION tag is set to YES
736 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
737 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
739 # link to the source code.  Otherwise they will link to the documentstion.
743 # If the USE_HTAGS tag is set to YES then the references to source code
744 # will point to the HTML generated by the htags(1) tool instead of doxygen
751 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
753 # which an include is specified. Set to NO to disable this.
758 # configuration options related to the alphabetical class index
761 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
768 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
775 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
781 # configuration options related to the HTML output
784 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
789 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
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
816 # will generate a default style sheet. Note that doxygen will try to copy
817 # the style sheet file to the HTML output directory, so don't put your own
822 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
823 # files or namespaces will be aligned in HTML using tables. If set to
828 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
830 # page has loaded. For this to work a browser that supports
836 # If the GENERATE_DOCSET tag is set to YES, additional index files
848 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
855 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
858 # will append .docset to the name.
862 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
864 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
869 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
870 # be used to specify the file name of the resulting .chm file. You
872 # written to the html output directory.
876 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
877 # be used to specify the location (absolute path including file name) of
878 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
883 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
889 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
890 # is used to encode HtmlHelp index (hhk), content (hhc) and project file
895 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
901 # The TOC_EXPAND flag can be set to YES to add extra items for group members
902 # to the contents of the HTML help documentation and to the tree view.
906 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER
908 # Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated
914 # be used to specify the file name of the resulting .qch file.
915 # The path specified is relative to the HTML output folder.
919 # The QHP_NAMESPACE tag specifies the namespace to use when generating
925 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
931 # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
932 # be used to specify the location of Qt's qhelpgenerator.
933 # If non-empty doxygen will try to run qhelpgenerator on the generated
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])
949 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
950 # structure should be generated to display hierarchical information.
951 # If the tag value is set to FRAME, a side panel will be generated
953 # is generated for HTML Help). For this to work a browser that supports
961 # releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE
967 # used to set the initial width (in pixels) of the frame in which the tree
972 # Use this tag to change the font size of Latex formulas included
975 # to manually remove any form_*.png images from the HTML output directory
976 # to force them to be regenerated.
981 # configuration options related to the LaTeX output
984 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
989 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
995 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1000 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1006 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
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
1018 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1023 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1030 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1031 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
1037 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1038 # plain latex in the generated Makefile. Set this option to YES to get a
1043 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1044 # command to the generated LaTeX files. This will instruct LaTeX to keep
1050 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
1057 # configuration options related to the RTF output
1060 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1066 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1072 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1073 # RTF documents. This may be useful for small projects and may help to
1078 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1087 # Load stylesheet definitions from file. Syntax is similar to doxygen's
1088 # config file, i.e. a series of assignments. You only have to provide
1089 # replacements, missing definitions are set to their default value.
1094 # Syntax is similar to doxygen's config file.
1099 # configuration options related to the man page output
1102 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1107 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
1113 # The MAN_EXTENSION tag determines the extension that is added to
1118 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1122 # would be unable to find the correct page. The default is NO.
1127 # configuration options related to the XML output
1130 # If the GENERATE_XML tag is set to YES Doxygen will
1136 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
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
1154 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1156 # and cross-referencing information) to the XML output. Note that
1165 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1174 # configuration options related to the Perl module output
1177 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
1185 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1186 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
1187 # to generate PDF and DVI output from the Perl module output.
1191 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1193 # if you want to understand what is going on.  On the other hand, if this
1194 # tag is set to NO the size of the Perl module output will be much smaller
1207 # Configuration options related to the preprocessor
1210 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1216 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1217 # names in the source code. If set to NO (the default) only conditional
1219 # way by setting EXPAND_ONLY_PREDEF to YES.
1223 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1224 # then the macro expansion is limited to the macros specified with the
1229 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1234 # The INCLUDE_PATH tag can be used to specify one or more directories that
1240 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1241 # patterns (like *.h and *.hpp) to filter out the header-files in the
1247 # The PREDEFINED tag can be used to specify one or more macro names that
1248 # are defined before the preprocessor is started (similar to the -D option of
1259 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1260 # this tag can be used to specify a list of macro names that should be expanded.
1262 # Use the PREDEFINED tag if you want to use a different macro definition.
1266 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1275 # Configuration::additions related to external references
1278 # The TAGFILES option can be used to specify one or more tagfiles.
1287 # does not have to be run to correct the links.
1291 # is run, you must also specify the path to the tagfile here.
1300 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1301 # in the class index. If set to NO only the inherited external classes
1306 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1307 # in the modules index. If set to NO, only the current project's groups will
1318 # Configuration options related to the dot tool
1321 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1323 # or super classes. Setting the tag to NO turns the diagrams off. Note that
1325 # fallback. It is recommended to install and use dot, since it yields more
1332 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1333 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
1334 # the mscgen tool resides. If left empty the tool is assumed to be found in the
1339 # If set to YES, the inheritance and collaboration graphs will hide
1345 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1348 # have no effect if this option is set to NO (the default)
1352 # By default doxygen will write a font called FreeSans.ttf to the output
1356 # using DOT_FONTNAME. You need need to make sure dot is able to find the font,
1358 # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
1363 # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1368 # By default doxygen will tell dot to use the output directory to look for the
1375 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1377 # indirect inheritance relations. Setting this tag to YES will force the
1378 # the CLASS_DIAGRAMS tag to NO.
1382 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1389 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1394 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1395 # collaboration diagrams in a style similar to the OMG's Unified Modeling
1400 # If set to YES, the inheritance and collaboration graphs will show the
1406 # tags are set to YES then doxygen will generate a graph for each documented
1413 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1419 # If the CALL_GRAPH and HAVE_DOT options are set to YES then
1422 # the time of a run. So in most cases it will be better to enable call graphs
1427 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1430 # the time of a run. So in most cases it will be better to enable caller
1435 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1440 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1447 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1453 # The tag DOT_PATH can be used to specify the path where the dot tool can be
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
1474 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1478 # option to 1 or 2 may greatly reduce the computation time needed for large
1484 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1486 # seem to support this out of the box. Warning: Depending on the platform used,
1487 # enabling this option may lead to badly anti-aliased labels on the edges of
1488 # a graph (i.e. they become hard to read).
1492 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1499 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1505 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1506 # remove the intermediate dot files that are used to generate
1512 # Configuration::additions related to the search engine
1516 # used. If set to NO the values of all tags below this one will be ignored.