Lines Matching +full:- +full:- +full:disable +full:- +full:documentation
3 # This file describes the settings to be used by the documentation system
15 #---------------------------------------------------------------------------
17 #---------------------------------------------------------------------------
20 # that follow. The default is UTF-8 which is also the encoding used for all
25 DOXYFILE_ENCODING = UTF-8
34 # This could be handy for archiving the generated documentation or
46 # included in the documentation. The maximum height of the logo should not
53 # base path where the generated documentation will be put.
60 # 4096 sub-directories (in 2 levels) under the output directory of each output
69 # documentation generated by doxygen is written. Doxygen will use this
72 # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
74 # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
75 # messages), Korean, Korean-en, Latvian, Lithuanian, Norwegian, Macedonian,
76 # Persian, Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic,
83 # the file and class documentation (similar to JavaDoc).
84 # Set to NO to disable this.
95 # This tag implements a quasi-intelligent brief description abbreviator
99 # used as the annotated text. Otherwise, the brief description is used as-is.
114 # inherited members of a class in the documentation of that class as if those
127 # can be used to strip a user-defined part of the path. Stripping is
128 # only done if one of the specified strings matches the left-hand part of
137 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
138 # the path mentioned in the documentation of a class, which tells
142 # are normally passed to the compiler using the -I flag.
148 # doesn't support long names like on DOS, Mac, or CD-ROM.
153 # will interpret the first line (until the first dot) of a JavaDoc-style
155 # comments will behave just like regular Qt-style comments
161 # interpret the first line (until the first dot) of a Qt-style
163 # will behave just like regular Qt-style comments (thus requiring
169 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
171 # The new default is to treat a multi-line C++ comment block as a detailed
177 # member inherits the documentation from any documented member that it
178 # re-implements.
183 # a new page for each member. If set to NO, the documentation of a member will
194 # as commands in the documentation. An alias has the form "name=value".
196 # put the command \sideeffect (or @sideeffect) in the documentation, which
197 # will result in a user-defined paragraph with heading "Side Effects:".
202 # This tag can be used to specify a number of word-keyword mappings (TCL only).
237 # extension. Doxygen has a built-in mapping, but you can override or extend it
240 # Javascript, CSharp, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL, C,
248 # If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all
250 # documentation. See http://daringfireball.net/projects/markdown/ for details.
253 # Disable only in case of backward compatibilities issues.
258 # classes, or namespaces to their corresponding documentation. Such a link can
287 # the documentation. This will only work if the methods are indeed getting or
293 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
294 # tag is set to YES, then doxygen will reuse the documentation of the first
317 # inline in the documentation of the scope in which they are defined (i.e. file,
318 # namespace, or group documentation), provided this scope is documented. If set
326 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
337 # the code, doxygen keeps a cache of pre-resolved symbols. If the cache is too
345 #---------------------------------------------------------------------------
347 #---------------------------------------------------------------------------
350 # documentation are documented, even if no documentation was available.
357 # will be included in the documentation.
362 # scope will be included in the documentation.
367 # will be included in the documentation.
372 # defined locally in source files will be included in the documentation.
377 # This flag is only useful for Objective-C code. When set to YES local
379 # the interface are included in the documentation.
385 # extracted and appear in the documentation as a namespace called
395 # various overviews, but no documentation section is generated.
410 # documentation.
415 # documentation blocks found inside the body of a function.
417 # function's detailed documentation block.
421 # The INTERNAL_DOCS tag determines if documentation
423 # to NO (the default) then the documentation will be excluded.
424 # Set it to YES to include the internal documentation.
429 # file names in lower-case letters. If set to YES upper-case letters are also
438 # documentation. If set to YES the scope will be hidden.
443 # will put a list of the files that are included by a file in the documentation
449 # will list include files with double quotes in the documentation
455 # is inserted in the documentation for inline members.
460 # will sort the (detailed) documentation of file and class members
467 # brief documentation of file, namespace and class members alphabetically
474 # will sort the (brief and detailed) documentation of class members so that
490 # sorted by fully-qualified names, including namespaces. If set to
509 # disable (NO) the todo list. This list is created by putting \todo
510 # commands in the documentation.
515 # disable (NO) the test list. This list is created by putting \test
516 # commands in the documentation.
521 # disable (NO) the bug list. This list is created by putting \bug
522 # commands in the documentation.
527 # disable (NO) the deprecated list. This list is created by putting
528 # \deprecated commands in the documentation.
533 # documentation sections, marked by \if section-label ... \endif
534 # and \cond section-label ... \endcond blocks.
540 # the documentation. If the initializer consists of more lines than specified
543 # documentation can be controlled using \showinitializer or \hideinitializer
544 # command in the documentation regardless of this setting.
548 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
549 # at the bottom of the documentation of classes and structs. If set to YES the
550 # list will mention the files that were used to generate the documentation.
554 # Set the SHOW_FILES tag to NO to disable the generation of the Files page.
560 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the
570 # popen()) the command <command> <input-file>, where <command> is the value of
571 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
580 # that represents doxygen's defaults, run doxygen with the -l option.
597 #---------------------------------------------------------------------------
599 #---------------------------------------------------------------------------
619 # potential errors in the documentation, such as not documenting some
626 # functions that are documented, but have no documentation for their parameters
628 # wrong or incomplete parameter documentation, but not about the absence of
629 # documentation.
648 #---------------------------------------------------------------------------
650 #---------------------------------------------------------------------------
658 @abs_top_srcdir@/doc/quick-guide.md \
661 @abs_top_srcdir@/xkbcommon/xkbcommon-names.h \
662 @abs_top_srcdir@/xkbcommon/xkbcommon-x11.h \
663 @abs_top_srcdir@/xkbcommon/xkbcommon-compose.h \
666 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
671 INPUT_ENCODING = UTF-8
675 # and *.h) to filter out the source-files in the directories. If left
728 # and *.h) to filter out the source-files in the directories. If left
741 # directories that contain image that are included in the documentation (see
748 # by executing (via popen()) the command <filter> <input-file>, where <filter>
749 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
778 # and it is also possible to disable source filtering for a specific pattern
791 #---------------------------------------------------------------------------
793 #---------------------------------------------------------------------------
796 # be generated. Documented entities will be cross-referenced with these sources.
803 # of functions and classes directly in the documentation.
829 # Otherwise they will link to the documentation.
835 # built-in source browser. The htags tool is part of GNU's global source
843 # which an include is specified. Set to NO to disable this.
847 #---------------------------------------------------------------------------
849 #---------------------------------------------------------------------------
871 #---------------------------------------------------------------------------
873 #---------------------------------------------------------------------------
897 # It is advised to generate a default header using "doxygen -w html
911 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
913 # fine-tune the look of the HTML output. If left blank doxygen will
921 # user-defined cascading style sheet that is included after the standard
928 HTML_EXTRA_STYLESHEET = @abs_top_srcdir@/doc/doxygen-extra.css
935 # the files will be copied as-is; there are no commands or markers available.
971 # documentation will contain sections that can be hidden and shown after the
990 # To create a documentation set, doxygen will generate a Makefile in the
993 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
1001 # feed. A documentation feed provides an umbrella under which multiple
1002 # documentation sets from a single provider (such as a company or product suite)
1008 # should uniquely identify the documentation set bundle. This should be a
1009 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
1015 # identify the documentation publisher. This should be a reverse domain-name
1016 # style string, e.g. com.mycompany.MyDocSet.documentation.
1020 # The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
1027 # of the generated HTML documentation.
1040 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
1064 # to the contents of the HTML help documentation and to the tree view.
1071 # Qt Compressed Help (.qch) of the generated HTML documentation.
1089 # http://doc.trolltech.com/qthelpproject.html#virtual-folders
1095 # http://doc.trolltech.com/qthelpproject.html#custom-filters
1101 # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
1109 # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
1116 # If non-empty doxygen will try to run qhelpgenerator on the generated
1146 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1149 # containing a tree-like index structure (just like the one that
1160 # documentation. Note that a value of 0 will completely suppress the enum
1177 # as images in the HTML documentation. The default is 10. Note that
1202 # the MathJax output. Supported types are HTML-CSS, NativeMML (i.e. MathML) and
1203 # SVG. The default value is HTML-CSS, which is slower, but has the best
1206 MATHJAX_FORMAT = HTML-CSS
1285 # of to a relative location where the documentation can be found.
1290 #---------------------------------------------------------------------------
1292 #---------------------------------------------------------------------------
1352 # Note that the files will be copied as-is; there are no commands or markers
1366 # higher quality PDF documentation.
1396 #---------------------------------------------------------------------------
1398 #---------------------------------------------------------------------------
1438 #---------------------------------------------------------------------------
1440 #---------------------------------------------------------------------------
1466 #---------------------------------------------------------------------------
1468 #---------------------------------------------------------------------------
1472 # the code including all documentation.
1484 # and cross-referencing information) to the XML output. Note that
1489 #---------------------------------------------------------------------------
1491 #---------------------------------------------------------------------------
1504 #---------------------------------------------------------------------------
1506 #---------------------------------------------------------------------------
1511 # documentation. Note that this feature is still experimental
1516 #---------------------------------------------------------------------------
1518 #---------------------------------------------------------------------------
1522 # the code including all documentation. Note that this
1551 #---------------------------------------------------------------------------
1553 #---------------------------------------------------------------------------
1556 # evaluate all C-preprocessor directives found in the sources and include
1586 # patterns (like *.h and *.hpp) to filter out the header-files in the
1593 # are defined before the preprocessor is started (similar to the -D option of
1611 # doxygen's preprocessor will remove all references to function-like macros
1617 #---------------------------------------------------------------------------
1619 #---------------------------------------------------------------------------
1622 # tag file the location of the external documentation should be added. The
1664 #---------------------------------------------------------------------------
1666 #---------------------------------------------------------------------------
1679 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
1830 # contain dot files that are included in the documentation (see the
1836 # contain msc files that are included in the documentation (see the
1864 # enabling this option may lead to badly anti-aliased labels on the edges of
1870 # files in one run (i.e. multiple -o and -T options on the command line). This