doxyfile.in - OpenGrok cross reference for /external/jsoncpp/doc/doxyfile.in

Lines Matching +full:- +full:- +full:disable +full:- +full:documentation
3 # This file describes the settings to be used by the documentation system
16 #---------------------------------------------------------------------------
18 #---------------------------------------------------------------------------
21 # that follow. The default is UTF-8 which is also the encoding used for all text
25 # The default value is: UTF-8.
27 DOXYFILE_ENCODING      = UTF-8
30 # double-quotes, unless you are using Doxywizard) that should identify the
31 # project for which the documentation is generated. This name is used in the
38 # could be handy for archiving the generated documentation or if some version
50 # the documentation. The maximum height of the logo should not exceed 55 pixels
57 # into which the generated documentation will be written. If a relative path is
63 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub-
74 # documentation generated by doxygen is written. Doxygen will use this
76 # Possible values are: Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-
78 # Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en,
79 # Korean, Korean-en, Latvian, Norwegian, Macedonian, Persian, Polish,
88 # documentation (similar to Javadoc). Set to NO to disable this.
102 # This tag implements a quasi-intelligent brief description abbreviator that is
106 # text. Otherwise, the brief description is used as-is. If left blank, the
131 # inherited members of a class in the documentation of that class as if those
145 # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
146 # Stripping is only done if one of the specified strings matches the left-hand
157 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
158 # path mentioned in the documentation of a class, which tells the reader which
162 # using the -I flag.
168 # support long names like on DOS, Mac, or CD-ROM.
174 # first line (until the first dot) of a Javadoc-style comment as the brief
175 # description. If set to NO, the Javadoc-style will behave just like regular Qt-
183 # line (until the first dot) of a Qt-style comment as the brief description. If
184 # set to NO, the Qt-style will behave just like regular Qt-style comments (thus
191 # multi-line C++ special comment block (i.e. a block of //! or /// comments) as
193 # to treat a multi-line C++ comment block as a detailed description. Set this
203 # documentation from any documented member that it re-implements.
209 # new page for each member. If set to NO, the documentation of a member will be
222 # the documentation. An alias has the form:
227 # documentation, which will result in a user-defined paragraph with heading
236 # This tag can be used to specify a number of word-keyword mappings (TCL only).
272 # extension. Doxygen has a built-in mapping, but you can override or extend it
275 # C#, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL. For instance to make
286 # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
288 # documentation. See http://daringfireball.net/projects/markdown/ for details.
290 # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
297 # classes, or namespaces to their corresponding documentation. Such a link can
330 # doxygen to replace the get and set methods by a property in the documentation.
338 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
339 # tag is set to YES, then doxygen will reuse the documentation of the first
368 # the documentation of the scope in which they are defined (i.e. file,
369 # namespace, or group documentation), provided this scope is documented. If set
378 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
390 # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
400 #---------------------------------------------------------------------------
402 #---------------------------------------------------------------------------
405 # documentation are documented, even if no documentation was available. Private
408 # Note: This will also disable the warnings about undocumented members that are
415 # be included in the documentation.
421 # scope will be included in the documentation.
427 # included in the documentation.
433 # locally in source files will be included in the documentation. If set to NO
440 # This flag is only useful for Objective-C code. When set to YES local methods,
442 # included in the documentation. If set to NO only methods in the interface are
449 # extracted and appear in the documentation as a namespace called
459 # members will be included in the various overviews, but no documentation
475 # included in the documentation.
481 # documentation blocks found inside the body of a function. If set to NO these
482 # blocks will be appended to the function's detailed documentation block.
487 # The INTERNAL_DOCS tag determines if documentation that is typed after a
488 # \internal command is included. If the tag is set to NO then the documentation
489 # will be excluded. Set it to YES to include the internal documentation.
495 # names in lower-case letters. If set to YES upper-case letters are also
504 # their full class and namespace scopes in the documentation. If set to YES the
511 # the files that are included by a file in the documentation of that file.
517 # files with double quotes in the documentation rather than with sharp brackets.
523 # documentation for inline members.
529 # (detailed) documentation of file and class members alphabetically by member
543 # (brief and detailed) documentation of class members so that constructors and
547 # member documentation.
549 # detailed member documentation.
562 # fully-qualified names, including namespaces. If set to NO, the class list will
581 # The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the
583 # documentation.
588 # The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the
590 # documentation.
595 # The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug
596 # list. This list is created by putting \bug commands in the documentation.
601 # The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO)
603 # the documentation.
608 # The ENABLED_SECTIONS tag can be used to enable conditional documentation
616 # documentation. If the initializer consists of more lines than specified here
620 # documentation regardless of this setting.
625 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
626 # the bottom of the documentation of classes and structs. If set to YES the list
627 # will mention the files that were used to generate the documentation.
632 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
639 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
649 # popen()) the command command input-file, where command is the value of the
650 # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
652 # version. For an example see the documentation.
659 # that represents doxygen's defaults, run doxygen with the -l option. You can
680 #---------------------------------------------------------------------------
682 #---------------------------------------------------------------------------
695 # Tip: Turn warnings on while writing the documentation.
708 # potential errors in the documentation, such as not documenting some parameters
716 # are documented, but have no documentation for their parameters or return
718 # documentation, but not about the absence of documentation.
739 #---------------------------------------------------------------------------
741 #---------------------------------------------------------------------------
754 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
756 # documentation (see: http://www.gnu.org/software/libiconv) for the list of
758 # The default value is: UTF-8.
760 INPUT_ENCODING         = UTF-8
764 # *.h) to filter out the source-files in the directories. If left blank the
826 # *.h) to filter out the source-files in the directories. If left blank all
839 # that contain images that are to be included in the documentation (see the
848 # <filter> <input-file>
850 # where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
879 # it is also possible to disable source filtering for a specific pattern using
892 #---------------------------------------------------------------------------
894 #---------------------------------------------------------------------------
897 # generated. Documented entities will be cross-referenced with these sources.
906 # classes and enums directly into the documentation.
933 # link to the documentation.
940 # brief description and links to the definition and documentation. Since this
942 # can opt to disable this feature.
949 # point to the HTML generated by the htags(1) tool instead of doxygen built-in
955 # - Install the latest version of global
956 # - Enable SOURCE_BROWSER and USE_HTAGS in the config file
957 # - Make sure the INPUT points to the root of the source tree
958 # - Run doxygen as normal
972 # specified. Set to NO to disable this.
978 #---------------------------------------------------------------------------
980 #---------------------------------------------------------------------------
1004 #---------------------------------------------------------------------------
1006 #---------------------------------------------------------------------------
1028 # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1036 # doxygen -w html new_header.html new_footer.html new_stylesheet.css
1043 # of the possible markers and block names see the documentation.
1048 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1058 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1059 # sheet that is used by each HTML page. It can be used to fine-tune the look of
1070 # The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user-
1076 # see the documentation.
1086 # files will be copied as-is; there are no commands or markers available.
1130 # documentation will contain sections that can be hidden and shown after the
1153 # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
1156 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1164 # This tag determines the name of the docset feed. A documentation feed provides
1165 # an umbrella under which multiple documentation sets from a single provider
1172 # This tag specifies a string that should uniquely identify the documentation
1173 # set bundle. This should be a reverse domain-name style string, e.g.
1181 # the documentation publisher. This should be a reverse domain-name style
1182 # string, e.g. com.mycompany.MyDocSet.documentation.
1188 # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1197 # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
1205 # words in the documentation. The HTML workshop also contains a viewer for
1217 CHM_FILE               = jsoncpp-%JSONCPP_VERSION%.chm
1220 # including file name) of the HTML help compiler ( hhc.exe). If non-empty
1248 # the table of contents of the HTML help documentation and to the tree view.
1257 # (.qch) of the generated HTML documentation.
1272 # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
1280 # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
1289 # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1297 # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1305 # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
1311 # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
1331 # name. Each documentation set should have its own identifier.
1338 # be necessary to disable the index and replace it with your own. The
1348 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1350 # value is set to YES, a side panel will be generated containing a tree-like
1355 # further fine-tune the look of the index. As an example, the default style
1366 # doxygen will group on one line in the generated HTML documentation.
1390 # the HTML documentation. When you change the font size after a successful
1423 # Possible values are: HTML-CSS (which is slower, but has the best
1425 # The default value is: HTML-CSS.
1428 MATHJAX_FORMAT         = HTML-CSS
1453 # example see the documentation.
1538 # to a relative location where the documentation can be found. The format is:
1544 #---------------------------------------------------------------------------
1546 #---------------------------------------------------------------------------
1611 # Note: Only use a user-defined header if you know what you are doing! The
1625 # Note: Only use a user-defined footer if you know what you are doing!
1632 # directory. Note that the files will be copied as-is; there are no commands or
1649 # higher quality PDF documentation.
1689 #---------------------------------------------------------------------------
1691 #---------------------------------------------------------------------------
1740 # using doxygen -e rtf extensionFile.
1745 #---------------------------------------------------------------------------
1747 #---------------------------------------------------------------------------
1782 #---------------------------------------------------------------------------
1784 #---------------------------------------------------------------------------
1787 # captures the structure of the code including all documentation.
1813 # listings (including syntax highlighting and cross-referencing information) to
1821 #---------------------------------------------------------------------------
1823 #---------------------------------------------------------------------------
1839 #---------------------------------------------------------------------------
1841 #---------------------------------------------------------------------------
1845 # the code including all documentation. Note that this feature is still
1851 #---------------------------------------------------------------------------
1853 #---------------------------------------------------------------------------
1856 # file that captures the structure of the code including all documentation.
1889 #---------------------------------------------------------------------------
1891 #---------------------------------------------------------------------------
1894 # C-preprocessor directives found in the sources and include files.
1931 # patterns (like *.h and *.hpp) to filter out the header-files in the
1939 # defined before the preprocessor is started (similar to the -D option of e.g.
1962 # remove all refrences to function-like macros that are alone on a line, have an
1964 # typically used for boiler-plate code, and will confuse the parser if not
1971 #---------------------------------------------------------------------------
1973 #---------------------------------------------------------------------------
1976 # file the location of the external documentation should be added. The format of
1982 # section "Linking to external documentation" for more information about the use
1992 # external documentation" for more information about the usage of tag files.
2022 #---------------------------------------------------------------------------
2024 #---------------------------------------------------------------------------
2038 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
2232 # contain dot files that are included in the documentation (see the \dotfile
2239 # contain msc files that are included in the documentation (see the \mscfile
2273 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2281 # files in one run (i.e. multiple -o and -T options on the command line). This