Lines Matching full:will

8 # All text after a hash (#) is considered a comment and will be ignored.
48 # Doxygen will copy the logo to the output directory.
53 # base path where the generated documentation will be put.
54 # If a relative path is entered, it will be relative to the location
55 # where doxygen was started. If left blank the current directory will be used.
59 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
61 # format and will distribute the generated files over these directories.
69 # documentation generated by doxygen is written. Doxygen will use this
81 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
88 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
91 # brief descriptions will be completely suppressed.
97 # in this list, if found as the leading text of the brief description, will be
118 # Doxygen will generate a detailed section even if there is only a brief
123 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
126 # operators of the base classes will not be shown.
130 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
132 # to NO the shortest path that makes the file name unique will be used.
142 # relative paths, which will be relative from the directory where doxygen is
156 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
163 # will interpret the first line (until the first dot) of a JavaDoc-style
165 # comments will behave just like regular Qt-style comments
170 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
173 # will behave just like regular Qt-style comments (thus requiring
192 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
193 # a new page for each member. If set to NO, the documentation of a member will
205 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
207 # will result in a user-defined paragraph with heading "Side Effects:".
214 # "class=itcl::class" will allow you to use the command class in the
220 # sources only. Doxygen will then generate output that is more tailored for C.
221 # For instance, some of the names that are used will be different. The list
222 # of all members will be omitted, etc.
227 # sources only. Doxygen will then generate output that is more tailored for
228 # Java. For instance, namespaces will be presented as packages, qualified
229 # scopes will look different, etc.
234 # sources only. Doxygen will then generate output that is more tailored for
240 # sources. Doxygen will then generate output that is tailored for
289 # Doxygen will parse them like normal C++ but will assume all classes use public
296 # default) will make doxygen replace the get and set methods by a property in
297 # the documentation. This will only work if the methods are indeed getting or
304 # tag is set to YES, then doxygen will reuse the documentation of the first
326 # unions with only public data fields or simple typedef fields will be shown
336 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
337 # with name TypeT. When disabled the typedef will appear as a member of a file,
338 # namespace, or class. And the struct will be named TypeS. This can typically
348 # small doxygen will become slower. If the cache is too large, memory is wasted.
359 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
361 # Private class members and static file members will be hidden unless
367 # will be included in the documentation.
372 # scope will be included in the documentation.
377 # will be included in the documentation.
382 # defined locally in source files will be included in the documentation.
394 # If this flag is set to YES, the members of anonymous namespaces will be
396 # 'anonymous_namespace{file}', where file will be replaced with the base
402 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
404 # If set to NO (the default) these members will be included in the
410 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
412 # If set to NO (the default) these classes will be included in the various
417 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
419 # If set to NO (the default) these declarations will be included in the
424 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
426 # If set to NO (the default) these blocks will be appended to the
433 # to NO (the default) then the documentation will be excluded.
438 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
447 # will show members with their full class and namespace scopes in the
448 # documentation. If set to YES the scope will be hidden.
453 # will put a list of the files that are included by a file in the documentation
459 # will list include files with double quotes in the documentation
470 # will sort the (detailed) documentation of file and class members
471 # alphabetically by member name. If set to NO the members will appear in
476 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
478 # by member name. If set to NO (the default) the members will appear in
484 # will sort the (brief and detailed) documentation of class members so that
486 # the constructors will appear in the respective orders defined by
488 # This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
493 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
495 # the group names will appear in their defined order.
499 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
501 # NO (the default), the class list will be sorted only by class name,
510 # do proper type resolution of all parameters of a function it will reject a
514 # will still accept a match between prototype and implementation in such cases.
551 # here it will be hidden. Use a value of 0 to hide initializers completely.
560 # list will mention the files that were used to generate the documentation.
565 # This will remove the Files entry from the Quick Index and from the
572 # This will remove the Namespaces entry from the Quick Index
579 # the version control system). Doxygen will invoke the program by executing (via
587 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
592 # DoxygenLayout.xml will be used as the name of the layout file.
622 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
623 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
628 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
637 # or return value. If set to NO (the default) doxygen will only warn about
645 # tags, which will be replaced by the file and line number from which the
647 # $version, which will be replaced by the version of the file (if it could
736 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
750 # invoke to filter for each input file. Doxygen will invoke the filter program
753 # input file. Doxygen will then use the output that the filter program writes
755 # If FILTER_PATTERNS is specified, this tag will be ignored.
758 # or removed, the anchors will not be placed correctly.
764 # Doxygen will compare the file name with each pattern and apply the
774 # INPUT_FILTER) will be used to filter the input files when producing source
780 # pattern. A pattern will override the setting for FILTER_PATTERN (if any)
788 # is part of the input, its contents will be placed on the main page
798 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
799 # be generated. Documented entities will be cross-referenced with these sources.
805 # Setting the INLINE_SOURCES tag to YES will include the body
810 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
812 # fragments. Normal C, C++ and Fortran comments will always remain visible.
818 # functions referencing it will be listed.
824 # called/used by that function will be listed.
830 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
832 # Otherwise they will link to the documentation.
837 # will point to the HTML generated by the htags(1) tool instead of doxygen
840 # will need version 4.8.6 or higher.
845 # will generate a verbatim copy of the header file for each class for
855 # of all compounds will be generated. Enable this if the project
862 # in which this list will be split (can be a number in the range [1..20])
867 # classes will be put under the same header in the alphabetical index.
877 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
882 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
883 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
884 # put in front of it. If left blank `html' will be used as the default path.
890 # doxygen will generate files with .html extension.
895 # each generated HTML page. If it is left blank doxygen will generate a
908 # each generated HTML page. If it is left blank doxygen will generate a
915 # fine-tune the look of the HTML output. If left blank doxygen will
918 # tag will in the future become obsolete.
927 # robust against future updates. Doxygen will copy the style sheet file to
934 # that these files will be copied to the base HTML output directory. Use the
937 # the files will be copied as-is; there are no commands or markers available.
942 # Doxygen will adjust the colors in the style sheet and background images
952 # the colors in the HTML output. For a value of 0 the output will use
953 # grayscales only. A value of 255 will produce the most vivid colors.
967 # page will contain the date and time when the page was generated. Setting
973 # documentation will contain sections that can be hidden and shown after the
980 # can expand and collapse entries dynamically later on. Doxygen will expand
983 # So setting the number of entries 1 will produce a full collapsed tree by
985 # and will result in a full expanded tree by default.
990 # will be generated that can be used as input for Apple's Xcode 3
992 # To create a documentation set, doxygen will generate a Makefile in the
993 # HTML output directory. Running make will produce the docset in that
994 # directory and running "make install" will install the docset in
995 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
1012 # will append .docset to the name.
1027 # will be generated that can be used as input for tools like the
1042 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
1071 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
1118 # If non-empty doxygen will try to run qhelpgenerator on the generated
1124 #  will be generated, which together with the HTML files, form an Eclipse help
1150 # If the tag value is set to YES, a side panel will be generated
1161 # (range [0,1..20]) that doxygen will group on one line in the generated HTML
1162 # documentation. Note that a value of 0 will completely suppress the enum
1173 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
1228 # pieces of code that will be used on startup of the MathJax code.
1232 # When the SEARCHENGINE tag is enabled doxygen will generate a search box
1242 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1245 # EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for
1252 # When EXTERNAL_SEARCH is enabled doxygen will no longer generate the PHP
1254 # which needs to be processed by an external indexer. Doxygen will invoke an
1263 # which will returned the search results when EXTERNAL_SEARCH is enabled.
1296 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
1301 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1302 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1303 # put in front of it. If left blank `latex' will be used as the default path.
1308 # invoked. If left blank `latex' will be used as the default command name.
1316 # generate index for LaTeX. If left blank `makeindex' will be used as the
1329 # executive. If left blank a4 will be used.
1340 # the first chapter. If it is left blank doxygen will generate a
1347 # the last chapter. If it is left blank doxygen will generate a
1354 # Note that the files will be copied as-is; there are no commands or markers
1360 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
1366 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1372 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1373 # command to the generated LaTeX files. This will instruct LaTeX to keep
1379 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
1385 # If LATEX_SOURCE_CODE is set to YES then doxygen will include
1402 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1408 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1409 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1410 # put in front of it. If left blank `rtf' will be used as the default path.
1421 # will contain hyperlink fields. The RTF file will
1444 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1449 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
1450 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1451 # put in front of it. If left blank `man' will be used as the default path.
1461 # then it will generate one additional man file for each entity
1472 # If the GENERATE_XML tag is set to YES Doxygen will
1478 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
1479 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1480 # put in front of it. If left blank `xml' will be used as the default path.
1496 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1499 # enabling this will significantly increase the size of the XML output.
1507 # If the GENERATE_DOCBOOK tag is set to YES Doxygen will generate DOCBOOK files
1512 # The DOCBOOK_OUTPUT tag is used to specify where the DOCBOOK pages will be put.
1513 # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
1514 # front of it. If left blank docbook will be used as the default path.
1522 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1534 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
1542 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1548 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1553 # tag is set to NO the size of the Perl module output will be much smaller
1554 # and Perl will parse it just the same.
1569 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1575 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1577 # compilation will be performed. Macro expansion can be done in a controlled
1589 # pointed to by INCLUDE_PATH will be searched when a #include is found.
1601 # directories. If left blank, the patterns specified with FILE_PATTERNS will
1629 # The macro definition that is found in the sources will be used.
1636 # doxygen's preprocessor will remove all references to function-like macros
1638 # semicolon, because these will confuse the parser if not removed.
1661 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1666 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1668 # will be listed.
1672 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1673 # in the modules index. If set to NO, only the current project's groups will
1678 # If the EXTERNAL_PAGES tag is set to YES all external pages will be listed
1680 # pages will be listed.
1693 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1702 # command. Doxygen will then run the mscgen tool (see
1710 # If set to YES, the inheritance and collaboration graphs will hide
1716 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1724 # allowed to run in parallel. When set to 0 (the default) doxygen will
1731 # By default doxygen will use the Helvetica font for all dot files that
1745 # By default doxygen will tell dot to use the Helvetica font.
1752 # will generate a graph for each documented class showing the direct and
1753 # indirect inheritance relations. Setting this tag to YES will force the
1759 # will generate a graph for each documented class showing the direct and
1766 # will generate a graph for groups, showing the direct groups dependencies
1770 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1785 # If set to YES, the inheritance and collaboration graphs will show the
1791 # tags are set to YES then doxygen will generate a graph for each documented
1798 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1805 # doxygen will generate a call dependency graph for every global function
1806 # or class method. Note that enabling this option will significantly increase
1807 # the time of a run. So in most cases it will be better to enable call graphs
1813 # doxygen will generate a caller dependency graph for every global function
1814 # or class method. Note that enabling this option will significantly increase
1815 # the time of a run. So in most cases it will be better to enable caller
1821 # will generate a graphical hierarchy of all classes instead of a textual one.
1826 # then doxygen will show the dependencies a directory has on other directories
1834 # If left blank png will be used. If you choose svg you need to set
1867 # nodes that will be shown in the graph. If the number of nodes in a graph
1868 # becomes larger than this value, doxygen will truncate the graph, which is
1871 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1878 # from the root by following a path via at most 3 edges will be shown. Nodes
1879 # that lay further from the root node will be omitted. Note that setting this
1901 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1907 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will