projects/build/bspOneUtopia.dxyfile

3 # This file describes the settings to be used by the documentation system
31 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
37 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
39 # If a relative path is entered, it will be relative to the location
44 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
53 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
55 # information to generate all constant output in the proper language.
66 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
68 # the file and class documentation (similar to JavaDoc).
69 # Set to NO to disable this.
73 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
75 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
81 # that is used to form the text in various listings. Each string
102 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
108 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
115 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
117 # to NO the shortest path that makes the file name unique will be used.
121 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
122 # can be used to strip a user-defined part of the path. Stripping is
124 # the path. The tag can be used to show relative paths in the file list.
126 # path to strip.
130 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
132 # the reader which header file to include in order to use a class.
135 # are normally passed to the compiler using the -I flag.
139 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
145 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
147 # comment as the brief description. If set to NO, the JavaDoc
153 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
155 # comment as the brief description. If set to NO, the comments
161 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
163 # comments) as a brief description. This used to be the default behaviour.
164 # The new default is to treat a multi-line C++ comment block as a detailed
165 # description. Set this tag to YES if you prefer the old behaviour instead.
169 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
175 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
176 # a new page for each member. If set to NO, the documentation of a member will
181 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
182 # Doxygen uses this value to replace tabs by spaces in code fragments.
186 # This tag can be used to specify a number of aliases that acts
188 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
191 # You can put \n's in the value part of an alias to insert newlines.
195 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
202 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
209 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
215 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
222 # to include (a tag file for) the STL sources as input, then you should
223 # set this tag to YES in order to let doxygen match functions declarations and
230 # If you use Microsoft's C++/CLI language, you should set this option to YES to
235 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
241 # For Microsoft's IDL there are propget and propput attributes to indicate getter
242 # and setter methods for a property. Setting this option to YES (the default)
243 # will make doxygen to replace the get and set methods by a property in the
245 # setting a simple type. If this is not the case, or you want to show the
246 # methods anyway, you should set this option to NO.
251 # tag is set to YES, then doxygen will reuse the documentation of the first
257 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
258 # the same type (for instance a group of public functions) to be put as a
259 # subgroup of that type (e.g. under the Public Functions section). Set it to
260 # NO to prevent subgrouping. Alternatively, this can be done per class using
275 # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
276 # determine which symbols to keep in memory and which to flush to disk.
277 # When the cache is full, less often used symbols will be written to disk.
278 # For small to medium size projects (<1000 input files) the default value is
280 # doxygen to be busy swapping symbols to and from disk most of the time
287 # corresponding to a cache size of 2^16 = 65536 symbols
295 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
298 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
302 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
307 # If the EXTRACT_STATIC tag is set to YES all static members of a file
312 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
314 # If set to NO only classes defined in header files are included.
318 # This flag is only useful for Objective-C code. When set to YES local
321 # If set to NO (the default) only methods in the interface are included.
325 # If this flag is set to YES, the members of anonymous namespaces will be
333 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
335 # If set to NO (the default) these members will be included in the
341 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
343 # If set to NO (the default) these classes will be included in the various
348 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
350 # If set to NO (the default) these declarations will be included in the
355 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
357 # If set to NO (the default) these blocks will be appended to the
364 # to NO (the default) then the documentation will be excluded.
365 # Set it to YES to include the internal documentation.
369 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
370 # file names in lower-case letters. If set to YES upper-case letters are also
373 # and Mac users are advised to set this option to NO.
377 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
379 # documentation. If set to YES the scope will be hidden.
383 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
389 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
394 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
396 # alphabetically by member name. If set to NO the members will appear in
401 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
403 # by member name. If set to NO (the default) the members will appear in
408 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
409 # hierarchy of group names into alphabetical order. If set to NO (the default)
414 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
415 # sorted by fully-qualified names, including namespaces. If set to
418 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
419 # Note: This option applies only to the class list, not to the
424 # The GENERATE_TODOLIST tag can be used to enable (YES) or
430 # The GENERATE_TESTLIST tag can be used to enable (YES) or
436 # The GENERATE_BUGLIST tag can be used to enable (YES) or
442 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
448 # The ENABLED_SECTIONS tag can be used to enable conditional
454 # the initial value of a variable or define consists of for it to appear in
456 # here it will be hidden. Use a value of 0 to hide initializers completely.
463 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
464 # at the bottom of the documentation of classes and structs. If set to YES the
465 # list will mention the files that were used to generate the documentation.
470 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
475 # Set the SHOW_FILES tag to NO to disable the generation of the Files page.
481 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the
487 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
488 # doxygen should invoke to get the current version for each file (typically from
492 # provided by doxygen. Whatever the program writes to standard output
497 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by
507 # configuration options related to warning and progress messages
510 # The QUIET tag can be used to turn on/off the messages that are generated
515 # The WARNINGS tag can be used to turn on/off the warning messages that are
521 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
522 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
527 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
534 # This WARN_NO_PARAMDOC option can be abled to get warnings for
536 # or return value. If set to NO (the default) doxygen will only warn about
551 # The WARN_LOGFILE tag can be used to specify a file to which warning
553 # to stderr.
558 # configuration options related to the input files
561 # The INPUT tag can be used to specify the files and/or directories that contain
571 # This tag can be used to specify the character encoding of the source files
580 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
581 # and *.h) to filter out the source-files in the directories. If left
618 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
624 # The EXCLUDE tag can be used to specify files and/or directories that should
637 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
639 # against the file with absolute path, so to exclude all test directories
644 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
652 # The EXAMPLE_PATH tag can be used to specify one or more files or
659 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
660 # and *.h) to filter out the source-files in the directories. If left
665 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
666 # searched for input files to be used with the \include or \dontinclude
672 # The IMAGE_PATH tag can be used to specify one or more files or
678 # The INPUT_FILTER tag can be used to specify a program that doxygen should
679 # invoke to filter for each input file. Doxygen will invoke the filter program
683 # to standard output.  If FILTER_PATTERNS is specified, this tag will be
688 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
693 # is applied to all files.
697 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
698 # INPUT_FILTER) will be used to filter the input files when producing source
699 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
704 # configuration options related to source browsing
707 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
710 # VERBATIM_HEADERS is set to NO.
714 # Setting the INLINE_SOURCES tag to YES will include the body
719 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
720 # doxygen to hide any special comment blocks from generated source code
725 # If the REFERENCED_BY_RELATION tag is set to YES
731 # If the REFERENCES_RELATION tag is set to YES
737 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
738 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
740 # link to the source code.  Otherwise they will link to the documentstion.
744 # If the USE_HTAGS tag is set to YES then the references to source code
745 # will point to the HTML generated by the htags(1) tool instead of doxygen
752 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
754 # which an include is specified. Set to NO to disable this.
759 # configuration options related to the alphabetical class index
762 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
769 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
776 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
782 # configuration options related to the HTML output
785 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
790 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
796 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
802 # The HTML_HEADER tag can be used to specify a personal HTML header for
808 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
814 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
815 # style sheet that is used by each HTML page. It can be used to
817 # will generate a default style sheet. Note that doxygen will try to copy
818 # the style sheet file to the HTML output directory, so don't put your own
823 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
824 # files or namespaces will be aligned in HTML using tables. If set to
829 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
831 # page has loaded. For this to work a browser that supports
837 # If the GENERATE_DOCSET tag is set to YES, additional index files
849 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
856 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
859 # will append .docset to the name.
863 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
865 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
870 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
871 # be used to specify the file name of the resulting .chm file. You
873 # written to the html output directory.
877 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
878 # be used to specify the location (absolute path including file name) of
879 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
884 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
890 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
891 # is used to encode HtmlHelp index (hhk), content (hhc) and project file
896 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
902 # The TOC_EXPAND flag can be set to YES to add extra items for group members
903 # to the contents of the HTML help documentation and to the tree view.
907 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER
909 # Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated
915 # be used to specify the file name of the resulting .qch file.
916 # The path specified is relative to the HTML output folder.
920 # The QHP_NAMESPACE tag specifies the namespace to use when generating
926 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
932 # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
933 # be used to specify the location of Qt's qhelpgenerator.
934 # If non-empty doxygen will try to run qhelpgenerator on the generated
939 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
945 # This tag can be used to set the number of enum values (range [1..20])
950 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
951 # structure should be generated to display hierarchical information.
952 # If the tag value is set to FRAME, a side panel will be generated
954 # is generated for HTML Help). For this to work a browser that supports
962 # releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE
968 # used to set the initial width (in pixels) of the frame in which the tree
973 # Use this tag to change the font size of Latex formulas included
976 # to manually remove any form_*.png images from the HTML output directory
977 # to force them to be regenerated.
982 # configuration options related to the LaTeX output
985 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
990 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
996 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1001 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1007 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1008 # LaTeX documents. This may be useful for small projects and may help to
1013 # The PAPER_TYPE tag can be used to set the paper type that is used
1019 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1024 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1031 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1032 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
1038 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1039 # plain latex in the generated Makefile. Set this option to YES to get a
1044 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1045 # command to the generated LaTeX files. This will instruct LaTeX to keep
1051 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
1058 # configuration options related to the RTF output
1061 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1067 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1073 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1074 # RTF documents. This may be useful for small projects and may help to
1079 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1088 # Load stylesheet definitions from file. Syntax is similar to doxygen's
1089 # config file, i.e. a series of assignments. You only have to provide
1090 # replacements, missing definitions are set to their default value.
1095 # Syntax is similar to doxygen's config file.
1100 # configuration options related to the man page output
1103 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1108 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
1114 # The MAN_EXTENSION tag determines the extension that is added to
1119 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1123 # would be unable to find the correct page. The default is NO.
1128 # configuration options related to the XML output
1131 # If the GENERATE_XML tag is set to YES Doxygen will
1137 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
1143 # The XML_SCHEMA tag can be used to specify an XML schema,
1144 # which can be used by a validating XML parser to check the
1149 # The XML_DTD tag can be used to specify an XML DTD,
1150 # which can be used by a validating XML parser to check the
1155 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1157 # and cross-referencing information) to the XML output. Note that
1166 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1175 # configuration options related to the Perl module output
1178 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
1186 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1187 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
1188 # to generate PDF and DVI output from the Perl module output.
1192 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1194 # if you want to understand what is going on.  On the other hand, if this
1195 # tag is set to NO the size of the Perl module output will be much smaller
1208 # Configuration options related to the preprocessor
1211 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1217 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1218 # names in the source code. If set to NO (the default) only conditional
1220 # way by setting EXPAND_ONLY_PREDEF to YES.
1224 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1225 # then the macro expansion is limited to the macros specified with the
1230 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1235 # The INCLUDE_PATH tag can be used to specify one or more directories that
1241 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1242 # patterns (like *.h and *.hpp) to filter out the header-files in the
1248 # The PREDEFINED tag can be used to specify one or more macro names that
1249 # are defined before the preprocessor is started (similar to the -D option of
1260 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1261 # this tag can be used to specify a list of macro names that should be expanded.
1263 # Use the PREDEFINED tag if you want to use a different macro definition.
1267 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1276 # Configuration::additions related to external references
1279 # The TAGFILES option can be used to specify one or more tagfiles.
1288 # does not have to be run to correct the links.
1292 # is run, you must also specify the path to the tagfile here.
1301 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1302 # in the class index. If set to NO only the inherited external classes
1307 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1308 # in the modules index. If set to NO, only the current project's groups will
1319 # Configuration options related to the dot tool
1322 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1324 # or super classes. Setting the tag to NO turns the diagrams off. Note that
1326 # fallback. It is recommended to install and use dot, since it yields more
1333 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1334 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
1335 # the mscgen tool resides. If left empty the tool is assumed to be found in the
1340 # If set to YES, the inheritance and collaboration graphs will hide
1346 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1349 # have no effect if this option is set to NO (the default)
1353 # By default doxygen will write a font called FreeSans.ttf to the output
1357 # using DOT_FONTNAME. You need need to make sure dot is able to find the font,
1359 # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
1364 # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1369 # By default doxygen will tell dot to use the output directory to look for the
1376 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1378 # indirect inheritance relations. Setting this tag to YES will force the
1379 # the CLASS_DIAGRAMS tag to NO.
1383 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1390 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1395 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1396 # collaboration diagrams in a style similar to the OMG's Unified Modeling
1401 # If set to YES, the inheritance and collaboration graphs will show the
1407 # tags are set to YES then doxygen will generate a graph for each documented
1414 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1420 # If the CALL_GRAPH and HAVE_DOT options are set to YES then
1423 # the time of a run. So in most cases it will be better to enable call graphs
1428 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1431 # the time of a run. So in most cases it will be better to enable caller
1436 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1441 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1448 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1454 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1459 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1465 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1475 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1479 # option to 1 or 2 may greatly reduce the computation time needed for large
1485 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1487 # seem to support this out of the box. Warning: Depending on the platform used,
1488 # enabling this option may lead to badly anti-aliased labels on the edges of
1489 # a graph (i.e. they become hard to read).
1493 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1500 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1506 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1507 # remove the intermediate dot files that are used to generate
1513 # Configuration::additions related to the search engine
1517 # used. If set to NO the values of all tags below this one will be ignored.