Lines Matching full:will

9 # All text after a single hash (#) is considered a comment and will be ignored.
61 # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
67 # into which the generated documentation will be written. If a relative path is
68 # entered, it will be relative to the location where doxygen was started. If
69 # left blank the current directory will be used.
73 # If the CREATE_SUBDIRS tag is set to YES then doxygen will create up to 4096
75 # and will distribute the generated files over these directories. Enabling this
84 # Controls the number of sub-directories that will be created when
95 # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
97 # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
104 # documentation generated by doxygen is written. Doxygen will use this
118 # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
125 # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
129 # brief descriptions will be completely suppressed.
136 # as the leading text of the brief description, will be stripped from the text
156 # doxygen will generate a detailed section even if there is only a brief
162 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
165 # operators of the base classes will not be shown.
170 # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
172 # shortest path that makes the file name unique will be used
184 # will be relative from the directory where doxygen is started.
198 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
205 # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
207 # description. If set to NO, the Javadoc-style will behave just like regular Qt-
214 # If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line
218 # Javadoc-style will behave just like regular comments and it will not be
224 # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
226 # set to NO, the Qt-style will behave just like regular Qt-style comments (thus
258 # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
259 # page for each member. If set to NO, the documentation of a member will be part
276 # will allow you to put the command \sideeffect (or @sideeffect) in the
277 # documentation, which will result in a user-defined paragraph with heading
289 # only. Doxygen will then generate output that is more tailored for C. For
290 # instance, some of the names that are used will be different. The list of all
291 # members will be omitted, etc.
297 # Python sources only. Doxygen will then generate output that is more tailored
298 # for that language. For instance, namespaces will be presented as packages,
299 # qualified scopes will look different, etc.
305 # sources. Doxygen will then generate output that is tailored for Fortran.
311 # sources. Doxygen will then generate output that is tailored for VHDL.
317 # sources only. Doxygen will then generate output that is more tailored for that
318 # language. For instance, namespaces will be presented as modules, types will be
403 # will parse them like normal C++ but will assume all classes use public instead
410 # getter and setter methods for a property. Setting this option to YES will make
412 # This will only work if the methods are indeed getting or setting a simple
420 # tag is set to YES then doxygen will reuse the documentation of the first
455 # with only public data fields or simple typedef fields will be shown inline in
466 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
467 # with name TypeT. When disabled the typedef will appear as a member of a file,
468 # namespace, or class. And the struct will be named TypeS. This can typically be
479 # doxygen will become slower. If the cache is too large, memory is wasted. The
482 # symbols. At the end of a run doxygen will report the cache usage and suggest
489 # during processing. When set to 0 doxygen will based this on the number of
501 # If the TIMESTAMP tag is set different from NO then each generated page will
513 # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
515 # class members and static file members will be hidden unless the
517 # Note: This will also disable the warnings about undocumented members that are
523 # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
530 # methods of a class will be included in the documentation.
536 # scope will be included in the documentation.
541 # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
548 # locally in source files will be included in the documentation. If set to NO,
563 # If this flag is set to YES, the members of anonymous namespaces will be
565 # 'anonymous_namespace{file}', where file will be replaced with the base name of
573 # will be determined by the corresponding definition. By default unnamed
579 # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
581 # members will be included in the various overviews, but no documentation
587 # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
589 # to NO, these classes will be included in the various overviews. This option
590 # will also hide undocumented C++ concepts if enabled. This option has no effect
596 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
597 # declarations. If set to NO, these declarations will be included in the
603 # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
605 # blocks will be appended to the function's detailed documentation block.
612 # will be excluded. Set it to YES to include the internal documentation.
617 # With the correct setting of option CASE_SENSE_NAMES doxygen will better be
634 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
636 # scope will be hidden.
641 # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
643 # YES the compound reference will be hidden.
649 # will show which file needs to be included to use the class.
654 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
660 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
667 # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
679 # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
681 # name. If set to NO, the members will appear in declaration order.
686 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
688 # name. If set to NO, the members will appear in declaration order. Note that
689 # this will also influence the order of the classes in the class list.
694 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
696 # destructors are listed first. If set to NO the constructors will appear in the
706 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
707 # of group names into alphabetical order. If set to NO the group names will
713 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
714 # fully-qualified names, including namespaces. If set to NO, the class list will
724 # type resolution of all parameters of a function it will reject a match between
727 # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
767 # it will be hidden. Use a value of 0 to hide initializers completely. The
777 # list will mention the files that were used to generate the documentation.
783 # will remove the Files entry from the Quick Index and from the Folder Tree View
790 # page. This will remove the Namespaces entry from the Quick Index and from the
798 # the version control system). Doxygen will invoke the program by executing (via
806 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
811 # will be used as the name of the layout file. See also section "Changing the
815 # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
850 # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
852 # will automatically be disabled.
857 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
865 # If WARN_IF_INCOMPLETE_DOC is set to YES, doxygen will warn about incomplete
866 # function parameter documentation. If set to NO, doxygen will accept that some
874 # value. If set to NO, doxygen will only warn about wrong parameter
876 # set to YES then this flag will automatically be disabled. See also
882 # If WARN_IF_UNDOC_ENUM_VAL option is set to YES, doxygen will warn about
883 # undocumented enumeration values. If set to NO, doxygen will accept
885 # will automatically be disabled.
890 # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
892 # then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but
893 # at the end of the doxygen process doxygen will return with a non-zero status.
895 # like FAIL_ON_WARNINGS but in case no WARN_LOGFILE is defined doxygen will not
897 # of a run, in case a WARN_LOGFILE is defined the warning messages will be
900 # the behavior will remain as with the setting FAIL_ON_WARNINGS.
908 # will be replaced by the file and line number from which the warning originated
909 # and the warning text. Optionally the format may contain $version, which will
960 # character encoding on a per file pattern basis. Doxygen will compare the file
1089 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
1103 # invoke to filter for each input file. Doxygen will invoke the filter program
1109 # name of an input file. Doxygen will then use the output that the filter
1111 # will be ignored.
1115 # or removed, the anchors will not be placed correctly.
1117 # Note that doxygen will use the data processed and written to standard output
1129 # basis. Doxygen will compare the file name with each pattern and apply the
1142 # INPUT_FILTER) will also be used to filter the input files that are used for
1149 # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
1157 # is part of the input, its contents will be placed on the main page
1166 # setting FORTRAN_COMMENT_AFTER will also make it possible that longer lines can
1176 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
1177 # generated. Documented entities will be cross-referenced with these sources.
1185 # Setting the INLINE_SOURCES tag to YES will include the body of functions,
1191 # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
1193 # Fortran comments will always remain visible.
1199 # entity all documented functions referencing it will be listed.
1205 # all documented entities called/used by that function will be listed.
1212 # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
1219 # source code will show a tooltip with additional information such as prototype,
1221 # will make the HTML file larger and loading of large files a bit slower, you
1228 # If the USE_HTAGS tag is set to YES then the references to source code will
1231 # (see https://www.gnu.org/software/global/global.html). You will need version
1240 # Doxygen will invoke htags (and that will in turn invoke gtags), so these
1244 # source code will now point to the output of htags.
1250 # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
1263 # compounds will be generated. Enable this if the project contains a lot of
1271 # tag works for classes, function and member names. The entity will be placed in
1282 # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
1287 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1288 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1303 # each generated HTML page. If the tag is left blank doxygen will generate a
1323 # generated HTML page. If the tag is left blank doxygen will generate a standard
1334 # the HTML output. If left blank doxygen will generate a default style sheet.
1338 # it is more robust and this tag (HTML_STYLESHEET) will in the future become
1349 # Doxygen will copy the style sheet files to the output directory.
1354 # Webkit/Chromium, the styling will be left out of the default doxygen.css if
1364 # that these files will be copied to the base HTML output directory. Use the
1367 # files will be copied as-is; there are no commands or markers available.
1386 # will adjust the colors in the style sheet and background images according to
1397 # in the HTML output. For a value of 0 the output will use gray-scales only. A
1398 # value of 255 will produce the most vivid colors.
1416 # documentation will contain a main index with vertical navigation menus that
1417 # are dynamically created via JavaScript. If disabled, the navigation index will
1427 # documentation will contain sections that can be hidden and shown after the
1443 # and collapse entries dynamically later on. Doxygen will expand the tree to
1446 # entries 1 will produce a full collapsed tree by default. 0 is a special value
1447 # representing an infinite number of entries and will result in a full expanded
1454 # If the GENERATE_DOCSET tag is set to YES, additional index files will be
1458 # create a documentation set, doxygen will generate a Makefile in the HTML
1459 # output directory. Running make will produce the docset in that directory and
1460 # running make install will install the docset in
1461 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1486 # com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1518 # files are now used as the Windows 98 help format, and will replace the old
1537 # doxygen will try to run the HTML help compiler on the generated index.hhp.
1572 # generated documentation will be placed on the server by the user during the
1582 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1639 # including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to
1645 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1678 # value is set to YES, a side panel will be generated containing a tree-like
1706 # doxygen will group on one line in the generated HTML documentation.
1708 # Note that a value of 0 will completely suppress the enum values from appearing
1722 # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
1729 # If the OBFUSCATE_EMAILS tag is set to YES, doxygen will obfuscate email
1736 # If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg
1739 # the HTML output. These images will generally look nicer at scaled resolutions.
1792 # this will be translated into chtml), NativeMML (i.e. MathML. Only supported
1793 # for NathJax 2. For MathJax version 3 chtml will be used instead.), chtml (This
1794 # is the name for Mathjax version 3, for MathJax version 2 this will be
1828 # of code that will be used on startup of the MathJax code. See the MathJax site
1836 # When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1857 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1860 # setting. When disabled, doxygen will generate a PHP script for searching and
1869 # When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1871 # which needs to be processed by an external indexer. Doxygen will invoke an
1887 # which will return the search results when EXTERNAL_SEARCH is enabled.
1928 # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
1933 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1934 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1965 # it will be automatically added in the LaTeX code.
1997 # If left blank no extra packages will be included.
2004 # first chapter. If it is left blank doxygen will generate a standard header. It
2021 # last chapter. If it is left blank doxygen will generate a standard footer. See
2034 # will copy the style sheet files to the output directory.
2044 # directory. Note that the files will be copied as-is; there are no commands or
2051 # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
2059 # If the USE_PDFLATEX tag is set to YES, doxygen will use the engine as
2074 # NON_STOP In nonstop mode the diagnostic message will appear on the terminal,
2076 # SCROLL In scroll mode, TeX will stop only for missing files to input or if
2077 # keyboard input is necessary and ERROR_STOP In errorstop mode, TeX will stop at
2084 # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
2100 # path from which the emoji images will be read. If a relative path is entered,
2101 # it will be relative to the LATEX_OUTPUT directory. If left blank the
2102 # LATEX_OUTPUT directory will be used.
2111 # If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
2118 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
2119 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2134 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
2135 # contain hyperlink fields. The RTF file will contain links (just like the HTML
2167 # If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
2173 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
2174 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2175 # it. A directory man3 will be created inside the directory specified by
2199 # will generate one additional man file for each entity documented in the real
2211 # If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
2217 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
2218 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2225 # If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
2227 # the XML output. Note that enabling this will significantly increase the size
2234 # If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include
2245 # If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
2251 # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
2252 # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
2263 # If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
2275 # If the GENERATE_SQLITE3 tag is set to YES doxygen will generate a Sqlite3
2281 # The SQLITE3_OUTPUT tag is used to specify where the Sqlite3 database will be
2282 # put. If a relative path is entered the value of OUTPUT_DIRECTORY will be put
2290 # database file will be recreated with each doxygen run. If set to NO, doxygen
2291 # will warn if an a database file is already found and not modify it.
2301 # If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
2309 # If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
2317 # If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
2320 # size of the Perl module output will be much smaller and Perl will parse it
2339 # If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
2345 # If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
2346 # in the source code. If set to NO, only conditional compilation will be
2363 # INCLUDE_PATH will be searched if a #include is found.
2379 # directories. If left blank, the patterns specified with FILE_PATTERNS will be
2397 # macro definition that is found in the sources will be used. Use the PREDEFINED
2404 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
2407 # are typically used for boiler-plate code, and will confuse the parser if not
2433 # When a file name is specified after GENERATE_TAGFILE, doxygen will create a
2440 # will be listed in the class and namespace index. If set to NO, only the
2441 # inherited external classes will be listed.
2446 # If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
2447 # in the topic index. If set to NO, only the current project's groups will be
2453 # If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
2454 # the related pages index. If set to NO, only the current project's pages will
2464 # If set to YES the inheritance and collaboration graphs will hide inheritance
2470 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2480 # to run in parallel. When set to 0 doxygen will base this on the number of
2525 # If the CLASS_GRAPH tag is set to YES or GRAPH or BUILTIN then doxygen will
2528 # HAVE_DOT is enabled as well, then dot will be used to draw the graph. In case
2530 # CLASS_GRAPH tag is set to BUILTIN, then the built-in generator will be used.
2532 # relations will be shown as texts / links.
2538 # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2550 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2561 # If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
2582 # If the DOT_UML_DETAILS tag is set to NO, doxygen will show attributes and
2584 # tag is set to YES, doxygen will add type and arguments for attributes and
2586 # will not generate fields with class member information in the UML graphs. The
2587 # class diagrams will look similar to the default class diagrams but using UML
2597 # significantly it will wrapped across multiple lines. Some heuristics are apply
2605 # collaboration graphs will show the relations between templates and their
2613 # YES then doxygen will generate a graph for each documented file showing the
2624 # set to YES then doxygen will generate a graph for each documented file showing
2635 # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2638 # Note that enabling this option will significantly increase the time of a run.
2639 # So in most cases it will be better to enable call graphs for selected
2647 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2650 # Note that enabling this option will significantly increase the time of a run.
2651 # So in most cases it will be better to enable caller graphs for selected
2659 # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2666 # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2725 # You can include diagrams made with dia in doxygen documentation. Doxygen will
2741 # a preprocessing step. Doxygen will generate a warning when it encounters a
2742 # \startuml command in this case and will not generate output for the diagram.
2757 # that will be shown in the graph. If the number of nodes in a graph becomes
2758 # larger than this value, doxygen will truncate the graph, which is visualized
2761 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2770 # root by following a path via at most 3 edges will be shown. Nodes that lay
2771 # further from the root node will be omitted. Note that setting this option to 1
2789 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2799 # If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate
2809 # command. If the MSCGEN_TOOL tag is left empty (the default), then doxygen will
2812 # specifying prog as the value, doxygen will call the tool as prog -T