Doxyfile - OpenGrok cross reference for /src/contrib/libcbor/Doxyfile

9 # All text after a single hash (#) is considered a comment and will be ignored.
61 # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
67 # into which the generated documentation will be written. If a relative path is
68 # entered, it will be relative to the location where doxygen was started. If
69 # left blank the current directory will be used.
73 # If the CREATE_SUBDIRS tag is set to YES then doxygen will create up to 4096
75 # and will distribute the generated files over these directories. Enabling this
84 # Controls the number of sub-directories that will be created when
95 # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
97 # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
104 # documentation generated by doxygen is written. Doxygen will use this
118 # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
125 # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
129 # brief descriptions will be completely suppressed.
136 # as the leading text of the brief description, will be stripped from the text
146 # doxygen will generate a detailed section even if there is only a brief
152 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
155 # operators of the base classes will not be shown.
160 # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
162 # shortest path that makes the file name unique will be used
174 # will be relative from the directory where doxygen is started.
188 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
195 # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
197 # description. If set to NO, the Javadoc-style will behave just like regular Qt-
204 # If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line
208 # Javadoc-style will behave just like regular comments and it will not be
214 # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
216 # set to NO, the Qt-style will behave just like regular Qt-style comments (thus
248 # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
249 # page for each member. If set to NO, the documentation of a member will be part
266 # will allow you to put the command \sideeffect (or @sideeffect) in the
267 # documentation, which will result in a user-defined paragraph with heading
280 # only. Doxygen will then generate output that is more tailored for C. For
281 # instance, some of the names that are used will be different. The list of all
282 # members will be omitted, etc.
288 # Python sources only. Doxygen will then generate output that is more tailored
289 # for that language. For instance, namespaces will be presented as packages,
290 # qualified scopes will look different, etc.
296 # sources. Doxygen will then generate output that is tailored for Fortran.
302 # sources. Doxygen will then generate output that is tailored for VHDL.
308 # sources only. Doxygen will then generate output that is more tailored for that
309 # language. For instance, namespaces will be presented as modules, types will be
383 # will parse them like normal C++ but will assume all classes use public instead
390 # getter and setter methods for a property. Setting this option to YES will make
392 # This will only work if the methods are indeed getting or setting a simple
400 # tag is set to YES then doxygen will reuse the documentation of the first
435 # with only public data fields or simple typedef fields will be shown inline in
446 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
447 # with name TypeT. When disabled the typedef will appear as a member of a file,
448 # namespace, or class. And the struct will be named TypeS. This can typically be
459 # doxygen will become slower. If the cache is too large, memory is wasted. The
462 # symbols. At the end of a run doxygen will report the cache usage and suggest
469 # during processing. When set to 0 doxygen will based this on the number of
485 # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
487 # class members and static file members will be hidden unless the
489 # Note: This will also disable the warnings about undocumented members that are
495 # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
502 # methods of a class will be included in the documentation.
508 # scope will be included in the documentation.
513 # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
520 # locally in source files will be included in the documentation. If set to NO,
535 # If this flag is set to YES, the members of anonymous namespaces will be
537 # 'anonymous_namespace{file}', where file will be replaced with the base name of
545 # will be determined by the corresponding definition. By default unnamed
551 # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
553 # members will be included in the various overviews, but no documentation
559 # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
561 # to NO, these classes will be included in the various overviews. This option
562 # will also hide undocumented C++ concepts if enabled. This option has no effect
568 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
569 # declarations. If set to NO, these declarations will be included in the
575 # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
577 # blocks will be appended to the function's detailed documentation block.
584 # will be excluded. Set it to YES to include the internal documentation.
589 # With the correct setting of option CASE_SENSE_NAMES doxygen will better be
606 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
608 # scope will be hidden.
613 # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
615 # YES the compound reference will be hidden.
621 # will show which file needs to be included to use the class.
626 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
632 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
639 # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
651 # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
653 # name. If set to NO, the members will appear in declaration order.
658 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
660 # name. If set to NO, the members will appear in declaration order. Note that
661 # this will also influence the order of the classes in the class list.
666 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
668 # destructors are listed first. If set to NO the constructors will appear in the
678 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
679 # of group names into alphabetical order. If set to NO the group names will
685 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
686 # fully-qualified names, including namespaces. If set to NO, the class list will
696 # type resolution of all parameters of a function it will reject a match between
699 # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
739 # it will be hidden. Use a value of 0 to hide initializers completely. The
749 # list will mention the files that were used to generate the documentation.
755 # will remove the Files entry from the Quick Index and from the Folder Tree View
762 # page. This will remove the Namespaces entry from the Quick Index and from the
770 # the version control system). Doxygen will invoke the program by executing (via
778 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
783 # will be used as the name of the layout file. See also section "Changing the
787 # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
822 # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
824 # will automatically be disabled.
829 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
837 # If WARN_IF_INCOMPLETE_DOC is set to YES, doxygen will warn about incomplete
838 # function parameter documentation. If set to NO, doxygen will accept that some
846 # value. If set to NO, doxygen will only warn about wrong parameter
848 # set to YES then this flag will automatically be disabled. See also
854 # If WARN_IF_UNDOC_ENUM_VAL option is set to YES, doxygen will warn about
855 # undocumented enumeration values. If set to NO, doxygen will accept
857 # will automatically be disabled.
862 # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
864 # then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but
865 # at the end of the doxygen process doxygen will return with a non-zero status.
873 # will be replaced by the file and line number from which the warning originated
874 # and the warning text. Optionally the format may contain $version, which will
926 # character encoding on a per file pattern basis. Doxygen will compare the file
1009 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
1023 # invoke to filter for each input file. Doxygen will invoke the filter program
1029 # name of an input file. Doxygen will then use the output that the filter
1031 # will be ignored.
1035 # or removed, the anchors will not be placed correctly.
1037 # Note that doxygen will use the data processed and written to standard output
1049 # basis. Doxygen will compare the file name with each pattern and apply the
1062 # INPUT_FILTER) will also be used to filter the input files that are used for
1069 # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
1077 # is part of the input, its contents will be placed on the main page
1086 # setting FORTRAN_COMMENT_AFTER will also make it possible that longer lines can
1096 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
1097 # generated. Documented entities will be cross-referenced with these sources.
1105 # Setting the INLINE_SOURCES tag to YES will include the body of functions,
1111 # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
1113 # Fortran comments will always remain visible.
1119 # entity all documented functions referencing it will be listed.
1125 # all documented entities called/used by that function will be listed.
1132 # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
1139 # source code will show a tooltip with additional information such as prototype,
1141 # will make the HTML file larger and loading of large files a bit slower, you
1148 # If the USE_HTAGS tag is set to YES then the references to source code will
1151 # (see https://www.gnu.org/software/global/global.html). You will need version
1160 # Doxygen will invoke htags (and that will in turn invoke gtags), so these
1164 # source code will now point to the output of htags.
1170 # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
1183 # compounds will be generated. Enable this if the project contains a lot of
1191 # tag works for classes, function and member names. The entity will be placed in
1202 # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
1207 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1208 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1223 # each generated HTML page. If the tag is left blank doxygen will generate a
1243 # generated HTML page. If the tag is left blank doxygen will generate a standard
1254 # the HTML output. If left blank doxygen will generate a default style sheet.
1258 # it is more robust and this tag (HTML_STYLESHEET) will in the future become
1269 # Doxygen will copy the style sheet files to the output directory.
1274 # Webkit/Chromium, the styling will be left out of the default doxygen.css if
1284 # that these files will be copied to the base HTML output directory. Use the
1287 # files will be copied as-is; there are no commands or markers available.
1306 # will adjust the colors in the style sheet and background images according to
1317 # in the HTML output. For a value of 0 the output will use gray-scales only. A
1318 # value of 255 will produce the most vivid colors.
1336 # page will contain the date and time when the page was generated. Setting this
1345 # documentation will contain a main index with vertical navigation menus that
1346 # are dynamically created via JavaScript. If disabled, the navigation index will
1356 # documentation will contain sections that can be hidden and shown after the
1365 # and collapse entries dynamically later on. Doxygen will expand the tree to
1368 # entries 1 will produce a full collapsed tree by default. 0 is a special value
1369 # representing an infinite number of entries and will result in a full expanded
1376 # If the GENERATE_DOCSET tag is set to YES, additional index files will be
1380 # create a documentation set, doxygen will generate a Makefile in the HTML
1381 # output directory. Running make will produce the docset in that directory and
1382 # running make install will install the docset in
1383 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1408 # com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1440 # files are now used as the Windows 98 help format, and will replace the old
1459 # doxygen will try to run the HTML help compiler on the generated index.hhp.
1494 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1551 # including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to
1557 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1590 # value is set to YES, a side panel will be generated containing a tree-like
1618 # doxygen will group on one line in the generated HTML documentation.
1620 # Note that a value of 0 will completely suppress the enum values from appearing
1634 # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
1641 # If the OBFUSCATE_EMAILS tag is set to YES, doxygen will obfuscate email
1648 # If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg
1651 # the HTML output. These images will generally look nicer at scaled resolutions.
1704 # this will be translated into chtml), NativeMML (i.e. MathML. Only supported
1705 # for NathJax 2. For MathJax version 3 chtml will be used instead.), chtml (This
1706 # is the name for Mathjax version 3, for MathJax version 2 this will be
1740 # of code that will be used on startup of the MathJax code. See the MathJax site
1748 # When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1769 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1772 # setting. When disabled, doxygen will generate a PHP script for searching and
1781 # When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1783 # which needs to be processed by an external indexer. Doxygen will invoke an
1799 # which will return the search results when EXTERNAL_SEARCH is enabled.
1840 # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
1845 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1846 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1877 # it will be automatically added in the LaTeX code.
1909 # If left blank no extra packages will be included.
1916 # first chapter. If it is left blank doxygen will generate a standard header. It
1933 # last chapter. If it is left blank doxygen will generate a standard footer. See
1946 # will copy the style sheet files to the output directory.
1956 # directory. Note that the files will be copied as-is; there are no commands or
1963 # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
1971 # If the USE_PDFLATEX tag is set to YES, doxygen will use the engine as
1981 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1982 # command to the generated LaTeX files. This will instruct LaTeX to keep running
1989 # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
2005 # page will contain the date and time when the page was generated. Setting this
2013 # path from which the emoji images will be read. If a relative path is entered,
2014 # it will be relative to the LATEX_OUTPUT directory. If left blank the
2015 # LATEX_OUTPUT directory will be used.
2024 # If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
2031 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
2032 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2047 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
2048 # contain hyperlink fields. The RTF file will contain links (just like the HTML
2080 # If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
2086 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
2087 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2088 # it. A directory man3 will be created inside the directory specified by
2112 # will generate one additional man file for each entity documented in the real
2124 # If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
2130 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
2131 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2138 # If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
2140 # the XML output. Note that enabling this will significantly increase the size
2147 # If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include
2158 # If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
2164 # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
2165 # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
2176 # If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
2188 # If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
2196 # If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
2204 # If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
2207 # size of the Perl module output will be much smaller and Perl will parse it
2226 # If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
2232 # If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
2233 # in the source code. If set to NO, only conditional compilation will be
2250 # INCLUDE_PATH will be searched if a #include is found.
2266 # directories. If left blank, the patterns specified with FILE_PATTERNS will be
2286 # macro definition that is found in the sources will be used. Use the PREDEFINED
2293 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
2296 # are typically used for boiler-plate code, and will confuse the parser if not
2322 # When a file name is specified after GENERATE_TAGFILE, doxygen will create a
2328 # If the ALLEXTERNALS tag is set to YES, all external class will be listed in
2329 # the class index. If set to NO, only the inherited external classes will be
2335 # If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
2336 # in the modules index. If set to NO, only the current project's groups will be
2342 # If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
2343 # the related pages index. If set to NO, only the current project's pages will
2353 # You can include diagrams made with dia in doxygen documentation. Doxygen will
2360 # If set to YES the inheritance and collaboration graphs will hide inheritance
2366 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2376 # to run in parallel. When set to 0 doxygen will base this on the number of
2421 # If the CLASS_GRAPH tag is set to YES (or GRAPH) then doxygen will generate a
2423 # relations. In case HAVE_DOT is set as well dot will be used to draw the graph,
2424 # otherwise the built-in generator will be used. If the CLASS_GRAPH tag is set
2425 # to TEXT the direct and indirect inheritance relations will be shown as texts /
2432 # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2441 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2449 # If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
2470 # If the DOT_UML_DETAILS tag is set to NO, doxygen will show attributes and
2472 # tag is set to YES, doxygen will add type and arguments for attributes and
2474 # will not generate fields with class member information in the UML graphs. The
2475 # class diagrams will look similar to the default class diagrams but using UML
2485 # significantly it will wrapped across multiple lines. Some heuristics are apply
2493 # collaboration graphs will show the relations between templates and their
2501 # YES then doxygen will generate a graph for each documented file showing the
2510 # set to YES then doxygen will generate a graph for each documented file showing
2518 # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2521 # Note that enabling this option will significantly increase the time of a run.
2522 # So in most cases it will be better to enable call graphs for selected
2530 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2533 # Note that enabling this option will significantly increase the time of a run.
2534 # So in most cases it will be better to enable caller graphs for selected
2542 # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2549 # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2620 # a preprocessing step. Doxygen will generate a warning when it encounters a
2621 # \startuml command in this case and will not generate output for the diagram.
2636 # that will be shown in the graph. If the number of nodes in a graph becomes
2637 # larger than this value, doxygen will truncate the graph, which is visualized
2640 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2649 # root by following a path via at most 3 edges will be shown. Nodes that lay
2650 # further from the root node will be omitted. Note that setting this option to 1
2668 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2678 # If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate