xref: /AliOS-Things-master/components/jsoncpp/doc/doxyfile.in

14 # Values that contain spaces should be placed between quotes (\" \").
21 # that follow. The default is UTF-8 which is also the encoding used for all text
30 # double-quotes, unless you are using Doxywizard) that should identify the
44 # for a project that appears at the top of each page and should give viewer a
49 # With the PROJECT_LOGO tag one can specify an logo or icon that is included in
87 # descriptions after the members that are listed in the file and class
102 # This tag implements a quasi-intelligent brief description abbreviator that is
131 # inherited members of a class in the documentation of that class as if those
140 # shortest path that makes the file name unique will be used
151 # Note that you can specify absolute paths here, but also relative paths, which
153 # This tag requires that the tag FULL_PATH_NAMES is set to YES.
161 # specify the list of include paths that are normally passed to the compiler
196 # Note that setting this tag to YES also means that rational rose comments are
203 # documentation from any documented member that it re-implements.
210 # part of the file/class/namespace that contains it.
221 # This tag can be used to specify a number of aliases that act as commands in
243 # only. Doxygen will then generate output that is more tailored for C. For
244 # instance, some of the names that are used will be different. The list of all
251 # Python sources only. Doxygen will then generate output that is more tailored
252 # for that language. For instance, namespaces will be presented as packages,
259 # sources. Doxygen will then generate output that is tailored for Fortran.
265 # sources. Doxygen will then generate output that is tailored for VHDL.
281 # Note that for custom extensions you also need to set FILE_PATTERNS otherwise
296 # When enabled doxygen tries to link words that correspond to documented
309 # diagrams that involve STL classes more complete and accurate.
347 # (for instance a group of public functions) to be put as a subgroup of that
360 # Note that this feature does not work in combination with
381 # useful for C code in case the coding convention dictates that all compound
408 # Note: This will also disable the warnings about undocumented members that are
451 # the file that contains the anonymous namespace. By default anonymous namespace
466 # undocumented classes that are normally visible in the class hierarchy. If set
487 # The INTERNAL_DOCS tag determines if documentation that is typed after a
511 # the files that are included by a file in the documentation of that file.
543 # (brief and detailed) documentation of class members so that constructors and
614 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
627 # will mention the files that were used to generate the documentation.
646 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
659 # that represents doxygen's defaults, run doxygen with the -l option. You can
663 # Note that if you run doxygen from a directory containing a file called
684 # The QUIET tag can be used to turn on/off the messages that are generated to
685 # standard output by doxygen. If QUIET is set to YES this implies that the
691 # The WARNINGS tag can be used to turn on/off the warning messages that are
693 # this implies that the warnings are on.
709 # in a documented function, or documenting parameters that don't exist or using
715 # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
723 # The WARN_FORMAT tag determines the format of the warning messages that doxygen
743 # The INPUT tag is used to specify the files and/or directories that contain
754 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
782 # The EXCLUDE tag can be used to specify files and/or directories that should be
786 # Note that relative paths are relative to the directory from which doxygen is
792 # directories that are symbolic links (a Unix file system feature) are excluded
802 # Note that the wildcards are matched against the file with absolute path, so to
808 # (namespaces, classes, functions, etc.) that should be excluded from the
813 # Note that the wildcards are matched against the file with absolute path, so to
819 # that contain example code fragments that are included (see the \include
839 # that contain images that are to be included in the documentation (see the
844 # The INPUT_FILTER tag can be used to specify a program that doxygen should
851 # name of an input file. Doxygen will then use the output that the filter
855 # Note that the filter must not add or remove lines; it is applied before the
871 # INPUT_FILTER ) will also be used to filter the input files that are used for
881 # This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
885 # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
899 # Note: To get rid of all source code in the generated output, make sure that
925 # all documented entities called/used by that function will be listed.
944 # This tag requires that the tag SOURCE_BROWSER is set to YES.
960 # Doxygen will invoke htags (and that will in turn invoke gtags), so these
966 # This tag requires that the tag SOURCE_BROWSER is set to YES.
993 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
999 # can be used to specify a prefix (or a list of prefixes) that should be ignored
1001 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1018 # This tag requires that the tag GENERATE_HTML is set to YES.
1025 # This tag requires that the tag GENERATE_HTML is set to YES.
1033 # To get valid HTML the header file that includes any scripts and style sheets
1034 # that doxygen needs, which is dependent on the configuration options used (e.g.
1040 # for information on how to generate the default header that doxygen normally
1045 # This tag requires that the tag GENERATE_HTML is set to YES.
1054 # that doxygen normally uses.
1055 # This tag requires that the tag GENERATE_HTML is set to YES.
1060 # sheet that is used by each HTML page. It can be used to fine-tune the look of
1063 # sheet that doxygen normally uses.
1067 # This tag requires that the tag GENERATE_HTML is set to YES.
1072 # defined cascading style sheet that is included after the standard style sheets
1078 # This tag requires that the tag GENERATE_HTML is set to YES.
1084 # that these files will be copied to the base HTML output directory. Use the
1086 # files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1088 # This tag requires that the tag GENERATE_HTML is set to YES.
1099 # This tag requires that the tag GENERATE_HTML is set to YES.
1107 # This tag requires that the tag GENERATE_HTML is set to YES.
1118 # This tag requires that the tag GENERATE_HTML is set to YES.
1126 # This tag requires that the tag GENERATE_HTML is set to YES.
1131 # documentation will contain sections that can be hidden and shown after the
1134 # This tag requires that the tag GENERATE_HTML is set to YES.
1141 # such a level that at most the specified number of entries are visible (unless
1147 # This tag requires that the tag GENERATE_HTML is set to YES.
1152 # generated that can be used as input for Apple's Xcode 3 integrated development
1156 # that directory and running make install will install the docset in
1157 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1161 # This tag requires that the tag GENERATE_HTML is set to YES.
1169 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1173 # This tag specifies a string that should uniquely identify the documentation
1177 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1181 # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1185 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1191 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1197 # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1201 # The HTML Help Workshop contains a compiler that can convert all HTML output
1209 # This tag requires that the tag GENERATE_HTML is set to YES.
1216 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1224 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1229 # YES) or that it should be included in the master .chm file ( NO).
1231 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1237 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1244 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1251 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1256 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1260 # This tag requires that the tag GENERATE_HTML is set to YES.
1267 # This tag requires that the tag GENERATE_QHP is set to YES.
1275 # This tag requires that the tag GENERATE_QHP is set to YES.
1284 # This tag requires that the tag GENERATE_QHP is set to YES.
1292 # This tag requires that the tag GENERATE_QHP is set to YES.
1300 # This tag requires that the tag GENERATE_QHP is set to YES.
1307 # This tag requires that the tag GENERATE_QHP is set to YES.
1314 # This tag requires that the tag GENERATE_QHP is set to YES.
1326 # This tag requires that the tag GENERATE_HTML is set to YES.
1334 # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1345 # This tag requires that the tag GENERATE_HTML is set to YES.
1352 # index structure (just like the one that is generated for HTML Help). For this
1353 # to work a browser that supports JavaScript, DHTML, CSS and frames is required
1357 # sheet generated by doxygen has an example that shows how to put an image at
1362 # This tag requires that the tag GENERATE_HTML is set to YES.
1366 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1369 # Note that a value of 0 will completely suppress the enum values from appearing
1372 # This tag requires that the tag GENERATE_HTML is set to YES.
1379 # This tag requires that the tag GENERATE_HTML is set to YES.
1386 # This tag requires that the tag GENERATE_HTML is set to YES.
1395 # This tag requires that the tag GENERATE_HTML is set to YES.
1403 # Note that when changing this option you need to delete any form_*.png files in
1406 # This tag requires that the tag GENERATE_HTML is set to YES.
1417 # This tag requires that the tag GENERATE_HTML is set to YES.
1427 # This tag requires that the tag USE_MATHJAX is set to YES.
1440 # This tag requires that the tag USE_MATHJAX is set to YES.
1445 # extension names that should be enabled during MathJax rendering. For example
1447 # This tag requires that the tag USE_MATHJAX is set to YES.
1452 # of code that will be used on startup of the MathJax code. See the MathJax site
1455 # This tag requires that the tag USE_MATHJAX is set to YES.
1461 # should work on any modern browser. Note that when using HTML help
1476 # This tag requires that the tag GENERATE_HTML is set to YES.
1488 # This tag requires that the tag SEARCHENGINE is set to YES.
1504 # This tag requires that the tag SEARCHENGINE is set to YES.
1515 # This tag requires that the tag SEARCHENGINE is set to YES.
1523 # This tag requires that the tag SEARCHENGINE is set to YES.
1531 # This tag requires that the tag SEARCHENGINE is set to YES.
1536 # projects other than the one defined by this configuration file, but that are
1541 # This tag requires that the tag SEARCHENGINE is set to YES.
1558 # This tag requires that the tag GENERATE_LATEX is set to YES.
1565 # Note that when enabling USE_PDFLATEX this option is only used for generating
1566 # bitmaps for formulas in the HTML output, but not in the Makefile that is
1569 # This tag requires that the tag GENERATE_LATEX is set to YES.
1576 # This tag requires that the tag GENERATE_LATEX is set to YES.
1584 # This tag requires that the tag GENERATE_LATEX is set to YES.
1588 # The PAPER_TYPE tag can be used to set the paper type that is used by the
1593 # This tag requires that the tag GENERATE_LATEX is set to YES.
1598 # that should be included in the LaTeX output. To get the times font for
1602 # This tag requires that the tag GENERATE_LATEX is set to YES.
1618 # This tag requires that the tag GENERATE_LATEX is set to YES.
1627 # This tag requires that the tag GENERATE_LATEX is set to YES.
1633 # directory. Note that the files will be copied as-is; there are no commands or
1635 # This tag requires that the tag GENERATE_LATEX is set to YES.
1639 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1644 # This tag requires that the tag GENERATE_LATEX is set to YES.
1652 # This tag requires that the tag GENERATE_LATEX is set to YES.
1661 # This tag requires that the tag GENERATE_LATEX is set to YES.
1668 # This tag requires that the tag GENERATE_LATEX is set to YES.
1675 # Note that which sources are shown also depends on other settings such as
1678 # This tag requires that the tag GENERATE_LATEX is set to YES.
1686 # This tag requires that the tag GENERATE_LATEX is set to YES.
1705 # This tag requires that the tag GENERATE_RTF is set to YES.
1713 # This tag requires that the tag GENERATE_RTF is set to YES.
1717 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
1720 # browsing using Word or some other Word compatible readers that support those
1725 # This tag requires that the tag GENERATE_RTF is set to YES.
1734 # default style sheet that doxygen normally uses.
1735 # This tag requires that the tag GENERATE_RTF is set to YES.
1742 # This tag requires that the tag GENERATE_RTF is set to YES.
1761 # This tag requires that the tag GENERATE_MAN is set to YES.
1765 # The MAN_EXTENSION tag determines the extension that is added to the generated
1770 # This tag requires that the tag GENERATE_MAN is set to YES.
1779 # This tag requires that the tag GENERATE_MAN is set to YES.
1787 # If the GENERATE_XML tag is set to YES doxygen will generate an XML file that
1797 # This tag requires that the tag GENERATE_XML is set to YES.
1803 # This tag requires that the tag GENERATE_XML is set to YES.
1809 # This tag requires that the tag GENERATE_XML is set to YES.
1815 # the XML output. Note that enabling this will significantly increase the size
1818 # This tag requires that the tag GENERATE_XML is set to YES.
1827 # that can be used to generate PDF.
1836 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1845 # Definitions (see http://autogen.sf.net) file that captures the structure of
1846 # the code including all documentation. Note that this feature is still
1857 # file that captures the structure of the code including all documentation.
1859 # Note that this feature is still experimental and incomplete at the moment.
1868 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1878 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1886 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1905 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1913 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1920 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1924 # The INCLUDE_PATH tag can be used to specify one or more directories that
1925 # contain include files that are not input files but should be processed by the
1927 # This tag requires that the tag SEARCH_INCLUDES is set to YES.
1935 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1939 # The PREDEFINED tag can be used to specify one or more macro names that are
1945 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1953 # tag can be used to specify a list of macro names that should be expanded. The
1954 # macro definition that is found in the sources will be used. Use the PREDEFINED
1955 # tag if you want to use a different macro definition that overrules the
1957 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1962 # remove all references to function-like macros that are alone on a line, have an
1967 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1991 # tag file that is based on the input files it reads. See section "Linking to
2028 # NO turns the diagrams off. Note that this option also works with HAVE_DOT
2065 # This tag requires that the tag HAVE_DOT is set to YES.
2069 # When you want a differently looking font n the dot files that doxygen
2075 # This tag requires that the tag HAVE_DOT is set to YES.
2082 # This tag requires that the tag HAVE_DOT is set to YES.
2089 # This tag requires that the tag HAVE_DOT is set to YES.
2097 # This tag requires that the tag HAVE_DOT is set to YES.
2106 # This tag requires that the tag HAVE_DOT is set to YES.
2113 # This tag requires that the tag HAVE_DOT is set to YES.
2121 # This tag requires that the tag HAVE_DOT is set to YES.
2129 # for no limit. Note that the threshold may be exceeded by 50% before the limit
2134 # This tag requires that the tag HAVE_DOT is set to YES.
2142 # This tag requires that the tag HAVE_DOT is set to YES.
2151 # This tag requires that the tag HAVE_DOT is set to YES.
2160 # This tag requires that the tag HAVE_DOT is set to YES.
2167 # Note that enabling this option will significantly increase the time of a run.
2171 # This tag requires that the tag HAVE_DOT is set to YES.
2178 # Note that enabling this option will significantly increase the time of a run.
2182 # This tag requires that the tag HAVE_DOT is set to YES.
2189 # This tag requires that the tag HAVE_DOT is set to YES.
2198 # This tag requires that the tag HAVE_DOT is set to YES.
2209 # This tag requires that the tag HAVE_DOT is set to YES.
2214 # enable generation of interactive SVG images that allow zooming and panning.
2216 # Note that this requires a modern browser other than Internet Explorer. Tested
2221 # This tag requires that the tag HAVE_DOT is set to YES.
2227 # This tag requires that the tag HAVE_DOT is set to YES.
2231 # The DOTFILE_DIRS tag can be used to specify one or more directories that
2232 # contain dot files that are included in the documentation (see the \dotfile
2234 # This tag requires that the tag HAVE_DOT is set to YES.
2238 # The MSCFILE_DIRS tag can be used to specify one or more directories that
2239 # contain msc files that are included in the documentation (see the \mscfile
2245 # that will be shown in the graph. If the number of nodes in a graph becomes
2247 # by representing a node as a red box. Note that doxygen if the number of direct
2249 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2252 # This tag requires that the tag HAVE_DOT is set to YES.
2257 # generated by dot. A depth value of 3 means that only nodes reachable from the
2258 # root by following a path via at most 3 edges will be shown. Nodes that lay
2259 # further from the root node will be omitted. Note that setting this option to 1
2261 # note that the size of a graph can be further restricted by
2264 # This tag requires that the tag HAVE_DOT is set to YES.
2276 # This tag requires that the tag HAVE_DOT is set to YES.
2285 # This tag requires that the tag HAVE_DOT is set to YES.
2293 # This tag requires that the tag HAVE_DOT is set to YES.
2298 # files that are used to generate the various graphs.
2300 # This tag requires that the tag HAVE_DOT is set to YES.

Last Index update Sun Aug 20 00:18:20 CST 2023