doxygen.cfg.in - OpenGrok cross reference for /external/llvm/docs/doxygen.cfg.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
77 # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
79 # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
80 # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
82 # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
90 # documentation (similar to Javadoc). Set to NO to disable this.
104 # This tag implements a quasi-intelligent brief description abbreviator that is
108 # text. Otherwise, the brief description is used as-is. If left blank, the
123 # inherited members of a class in the documentation of that class as if those
137 # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
138 # Stripping is only done if one of the specified strings matches the left-hand
149 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
150 # path mentioned in the documentation of a class, which tells the reader which
154 # using the -I flag.
160 # support long names like on DOS, Mac, or CD-ROM.
166 # first line (until the first dot) of a Javadoc-style comment as the brief
167 # description. If set to NO, the Javadoc-style will behave just like regular Qt-
175 # line (until the first dot) of a Qt-style comment as the brief description. If
176 # set to NO, the Qt-style will behave just like regular Qt-style comments (thus
183 # multi-line C++ special comment block (i.e. a block of //! or /// comments) as
185 # to treat a multi-line C++ comment block as a detailed description. Set this
195 # documentation from any documented member that it re-implements.
201 # new page for each member. If set to NO, the documentation of a member will be
214 # the documentation. An alias has the form:
219 # documentation, which will result in a user-defined paragraph with heading
225 # This tag can be used to specify a number of word-keyword mappings (TCL only).
261 # extension. Doxygen has a built-in mapping, but you can override or extend it
264 # C#, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL. For instance to make
275 # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
277 # documentation. See http://daringfireball.net/projects/markdown/ for details.
279 # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
286 # classes, or namespaces to their corresponding documentation. Such a link can
319 # doxygen to replace the get and set methods by a property in the documentation.
327 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
328 # tag is set to YES, then doxygen will reuse the documentation of the first
357 # the documentation of the scope in which they are defined (i.e. file,
358 # namespace, or group documentation), provided this scope is documented. If set
367 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
379 # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
389 #---------------------------------------------------------------------------
391 #---------------------------------------------------------------------------
394 # documentation are documented, even if no documentation was available. Private
397 # Note: This will also disable the warnings about undocumented members that are
404 # be included in the documentation.
410 # scope will be included in the documentation.
416 # included in the documentation.
422 # locally in source files will be included in the documentation. If set to NO
429 # This flag is only useful for Objective-C code. When set to YES local methods,
431 # included in the documentation. If set to NO only methods in the interface are
438 # extracted and appear in the documentation as a namespace called
448 # members will be included in the various overviews, but no documentation
464 # included in the documentation.
470 # documentation blocks found inside the body of a function. If set to NO these
471 # blocks will be appended to the function's detailed documentation block.
476 # The INTERNAL_DOCS tag determines if documentation that is typed after a
477 # \internal command is included. If the tag is set to NO then the documentation
478 # will be excluded. Set it to YES to include the internal documentation.
484 # names in lower-case letters. If set to YES upper-case letters are also
493 # their full class and namespace scopes in the documentation. If set to YES the
500 # the files that are included by a file in the documentation of that file.
506 # grouped member an include statement to the documentation, telling the reader
513 # files with double quotes in the documentation rather than with sharp brackets.
519 # documentation for inline members.
525 # (detailed) documentation of file and class members alphabetically by member
540 # (brief and detailed) documentation of class members so that constructors and
544 # member documentation.
546 # detailed member documentation.
559 # fully-qualified names, including namespaces. If set to NO, the class list will
578 # The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the
580 # documentation.
585 # The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the
587 # documentation.
592 # The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug
593 # list. This list is created by putting \bug commands in the documentation.
598 # The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO)
600 # the documentation.
605 # The ENABLED_SECTIONS tag can be used to enable conditional documentation
613 # documentation. If the initializer consists of more lines than specified here
617 # documentation regardless of this setting.
622 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
623 # the bottom of the documentation of classes and structs. If set to YES the list
624 # will mention the files that were used to generate the documentation.
629 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
636 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
646 # popen()) the command command input-file, where command is the value of the
647 # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
649 # version. For an example see the documentation.
656 # that represents doxygen's defaults, run doxygen with the -l option. You can
677 #---------------------------------------------------------------------------
679 #---------------------------------------------------------------------------
692 # Tip: Turn warnings on while writing the documentation.
705 # potential errors in the documentation, such as not documenting some parameters
713 # are documented, but have no documentation for their parameters or return
715 # documentation, but not about the absence of documentation.
736 #---------------------------------------------------------------------------
738 #---------------------------------------------------------------------------
748                          @abs_top_srcdir@/docs/doxygen-mainpage.dox
751 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
753 # documentation (see: http://www.gnu.org/software/libiconv) for the list of
755 # The default value is: UTF-8.
757 INPUT_ENCODING         = UTF-8
761 # *.h) to filter out the source-files in the directories. If left blank the
820 # *.h) to filter out the source-files in the directories. If left blank all
833 # that contain images that are to be included in the documentation (see the
842 # <filter> <input-file>
844 # where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
873 # it is also possible to disable source filtering for a specific pattern using
886 #---------------------------------------------------------------------------
888 #---------------------------------------------------------------------------
891 # generated. Documented entities will be cross-referenced with these sources.
900 # classes and enums directly into the documentation.
927 # link to the documentation.
934 # brief description and links to the definition and documentation. Since this
936 # can opt to disable this feature.
943 # point to the HTML generated by the htags(1) tool instead of doxygen built-in
949 # - Install the latest version of global
950 # - Enable SOURCE_BROWSER and USE_HTAGS in the config file
951 # - Make sure the INPUT points to the root of the source tree
952 # - Run doxygen as normal
966 # specified. Set to NO to disable this.
972 #---------------------------------------------------------------------------
974 #---------------------------------------------------------------------------
998 #---------------------------------------------------------------------------
1000 #---------------------------------------------------------------------------
1022 # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1030 # doxygen -w html new_header.html new_footer.html new_stylesheet.css
1037 # of the possible markers and block names see the documentation.
1042 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1052 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1053 # sheet that is used by each HTML page. It can be used to fine-tune the look of
1064 # The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user-
1070 # see the documentation.
1080 # files will be copied as-is; there are no commands or markers available.
1124 # documentation will contain sections that can be hidden and shown after the
1147 # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
1150 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1158 # This tag determines the name of the docset feed. A documentation feed provides
1159 # an umbrella under which multiple documentation sets from a single provider
1166 # This tag specifies a string that should uniquely identify the documentation
1167 # set bundle. This should be a reverse domain-name style string, e.g.
1175 # the documentation publisher. This should be a reverse domain-name style
1176 # string, e.g. com.mycompany.MyDocSet.documentation.
1182 # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1191 # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
1199 # words in the documentation. The HTML workshop also contains a viewer for
1214 # including file name) of the HTML help compiler ( hhc.exe). If non-empty
1242 # the table of contents of the HTML help documentation and to the tree view.
1251 # (.qch) of the generated HTML documentation.
1266 # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
1274 # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
1283 # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1291 # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1299 # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
1305 # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
1325 # name. Each documentation set should have its own identifier.
1332 # be necessary to disable the index and replace it with your own. The
1342 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1344 # value is set to YES, a side panel will be generated containing a tree-like
1349 # further fine-tune the look of the index. As an example, the default style
1360 # doxygen will group on one line in the generated HTML documentation.
1384 # the HTML documentation. When you change the font size after a successful
1417 # Possible values are: HTML-CSS (which is slower, but has the best
1419 # The default value is: HTML-CSS.
1422 MATHJAX_FORMAT         = HTML-CSS
1447 # example see the documentation.
1532 # to a relative location where the documentation can be found. The format is:
1538 #---------------------------------------------------------------------------
1540 #---------------------------------------------------------------------------
1605 # Note: Only use a user-defined header if you know what you are doing! The
1619 # Note: Only use a user-defined footer if you know what you are doing!
1626 # directory. Note that the files will be copied as-is; there are no commands or
1643 # higher quality PDF documentation.
1683 #---------------------------------------------------------------------------
1685 #---------------------------------------------------------------------------
1734 # using doxygen -e rtf extensionFile.
1739 #---------------------------------------------------------------------------
1741 #---------------------------------------------------------------------------
1776 #---------------------------------------------------------------------------
1778 #---------------------------------------------------------------------------
1781 # captures the structure of the code including all documentation.
1795 # listings (including syntax highlighting and cross-referencing information) to
1803 #---------------------------------------------------------------------------
1805 #---------------------------------------------------------------------------
1821 #---------------------------------------------------------------------------
1823 #---------------------------------------------------------------------------
1827 # the code including all documentation. Note that this feature is still
1833 #---------------------------------------------------------------------------
1835 #---------------------------------------------------------------------------
1838 # file that captures the structure of the code including all documentation.
1871 #---------------------------------------------------------------------------
1873 #---------------------------------------------------------------------------
1876 # C-preprocessor directives found in the sources and include files.
1913 # patterns (like *.h and *.hpp) to filter out the header-files in the
1921 # defined before the preprocessor is started (similar to the -D option of e.g.
1940 # remove all refrences to function-like macros that are alone on a line, have an
1942 # typically used for boiler-plate code, and will confuse the parser if not
1949 #---------------------------------------------------------------------------
1951 #---------------------------------------------------------------------------
1954 # file the location of the external documentation should be added. The format of
1960 # section "Linking to external documentation" for more information about the use
1970 # external documentation" for more information about the usage of tag files.
2000 #---------------------------------------------------------------------------
2002 #---------------------------------------------------------------------------
2016 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
2022 # You can include diagrams made with dia in doxygen documentation. Doxygen will
2023 # then run dia to produce the diagram and insert it in the documentation. The
2217 # contain dot files that are included in the documentation (see the \dotfile
2224 # contain msc files that are included in the documentation (see the \mscfile
2230 # contain dia files that are included in the documentation (see the \diafile
2264 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2272 # files in one run (i.e. multiple -o and -T options on the command line). This