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
146 # doxygen will generate a detailed section even if there is only a brief
152 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
155 # operators of the base classes will not be shown.
160 # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
162 # shortest path that makes the file name unique will be used
174 # will be relative from the directory where doxygen is started.
188 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
195 # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
197 # description. If set to NO, the Javadoc-style will behave just like regular Qt-
204 # If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line
208 # Javadoc-style will behave just like regular comments and it will not be
214 # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
216 # set to NO, the Qt-style will behave just like regular Qt-style comments (thus
248 # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
249 # page for each member. If set to NO, the documentation of a member will be part
266 # will allow you to put the command \sideeffect (or @sideeffect) in the
267 # documentation, which will result in a user-defined paragraph with heading
279 # only. Doxygen will then generate output that is more tailored for C. For
280 # instance, some of the names that are used will be different. The list of all
281 # members will be omitted, etc.
287 # Python sources only. Doxygen will then generate output that is more tailored
288 # for that language. For instance, namespaces will be presented as packages,
289 # qualified scopes will look different, etc.
295 # sources. Doxygen will then generate output that is tailored for Fortran.
301 # sources. Doxygen will then generate output that is tailored for VHDL.
307 # sources only. Doxygen will then generate output that is more tailored for that
308 # language. For instance, namespaces will be presented as modules, types will be
393 # will parse them like normal C++ but will assume all classes use public instead
400 # getter and setter methods for a property. Setting this option to YES will make
402 # This will only work if the methods are indeed getting or setting a simple
410 # tag is set to YES then doxygen will reuse the documentation of the first
445 # with only public data fields or simple typedef fields will be shown inline in
456 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
457 # with name TypeT. When disabled the typedef will appear as a member of a file,
458 # namespace, or class. And the struct will be named TypeS. This can typically be
469 # doxygen will become slower. If the cache is too large, memory is wasted. The
472 # symbols. At the end of a run doxygen will report the cache usage and suggest
479 # during processing. When set to 0 doxygen will based this on the number of
491 # If the TIMESTAMP tag is set different from NO then each generated page will
503 # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
505 # class members and static file members will be hidden unless the
507 # Note: This will also disable the warnings about undocumented members that are
513 # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
520 # methods of a class will be included in the documentation.
526 # scope will be included in the documentation.
531 # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
538 # locally in source files will be included in the documentation. If set to NO,
553 # If this flag is set to YES, the members of anonymous namespaces will be
555 # 'anonymous_namespace{file}', where file will be replaced with the base name of
563 # will be determined by the corresponding definition. By default unnamed
569 # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
571 # members will be included in the various overviews, but no documentation
577 # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
579 # to NO, these classes will be included in the various overviews. This option
580 # will also hide undocumented C++ concepts if enabled. This option has no effect
586 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
587 # declarations. If set to NO, these declarations will be included in the
593 # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
595 # blocks will be appended to the function's detailed documentation block.
602 # will be excluded. Set it to YES to include the internal documentation.
607 # With the correct setting of option CASE_SENSE_NAMES doxygen will better be
624 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
626 # scope will be hidden.
631 # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
633 # YES the compound reference will be hidden.
639 # will show which file needs to be included to use the class.
644 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
650 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
657 # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
669 # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
671 # name. If set to NO, the members will appear in declaration order.
676 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
678 # name. If set to NO, the members will appear in declaration order. Note that
679 # this will also influence the order of the classes in the class list.
684 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
686 # destructors are listed first. If set to NO the constructors will appear in the
696 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
697 # of group names into alphabetical order. If set to NO the group names will
703 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
704 # fully-qualified names, including namespaces. If set to NO, the class list will
714 # type resolution of all parameters of a function it will reject a match between
717 # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
757 # it will be hidden. Use a value of 0 to hide initializers completely. The
767 # list will mention the files that were used to generate the documentation.
773 # will remove the Files entry from the Quick Index and from the Folder Tree View
780 # page. This will remove the Namespaces entry from the Quick Index and from the
788 # the version control system). Doxygen will invoke the program by executing (via
796 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
801 # will be used as the name of the layout file. See also section "Changing the
805 # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
840 # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
842 # will automatically be disabled.
847 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
855 # If WARN_IF_INCOMPLETE_DOC is set to YES, doxygen will warn about incomplete
856 # function parameter documentation. If set to NO, doxygen will accept that some
864 # value. If set to NO, doxygen will only warn about wrong parameter
866 # set to YES then this flag will automatically be disabled. See also
872 # If WARN_IF_UNDOC_ENUM_VAL option is set to YES, doxygen will warn about
873 # undocumented enumeration values. If set to NO, doxygen will accept
875 # will automatically be disabled.
880 # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
882 # then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but
883 # at the end of the doxygen process doxygen will return with a non-zero status.
885 # like FAIL_ON_WARNINGS but in case no WARN_LOGFILE is defined doxygen will not
887 # of a run, in case a WARN_LOGFILE is defined the warning messages will be
890 # the behavior will remain as with the setting FAIL_ON_WARNINGS.
898 # will be replaced by the file and line number from which the warning originated
899 # and the warning text. Optionally the format may contain $version, which will
950 # character encoding on a per file pattern basis. Doxygen will compare the file
1051 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
1065 # invoke to filter for each input file. Doxygen will invoke the filter program
1071 # name of an input file. Doxygen will then use the output that the filter
1073 # will be ignored.
1077 # or removed, the anchors will not be placed correctly.
1079 # Note that doxygen will use the data processed and written to standard output
1091 # basis. Doxygen will compare the file name with each pattern and apply the
1104 # INPUT_FILTER) will also be used to filter the input files that are used for
1111 # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
1119 # is part of the input, its contents will be placed on the main page
1128 # setting FORTRAN_COMMENT_AFTER will also make it possible that longer lines can
1138 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
1139 # generated. Documented entities will be cross-referenced with these sources.
1147 # Setting the INLINE_SOURCES tag to YES will include the body of functions,
1153 # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
1155 # Fortran comments will always remain visible.
1161 # entity all documented functions referencing it will be listed.
1167 # all documented entities called/used by that function will be listed.
1174 # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
1181 # source code will show a tooltip with additional information such as prototype,
1183 # will make the HTML file larger and loading of large files a bit slower, you
1190 # If the USE_HTAGS tag is set to YES then the references to source code will
1193 # (see https://www.gnu.org/software/global/global.html). You will need version
1202 # Doxygen will invoke htags (and that will in turn invoke gtags), so these
1206 # source code will now point to the output of htags.
1212 # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
1220 # If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
1232 # tag is set to YES then doxygen will add the directory of each input to the
1241 # the include paths will already be set by doxygen for the files and directories
1253 # will then be passed to the parser. Any options specified with CLANG_OPTIONS
1254 # will be added as well.
1265 # compounds will be generated. Enable this if the project contains a lot of
1273 # tag works for classes, function and member names. The entity will be placed in
1284 # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
1289 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1290 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1305 # each generated HTML page. If the tag is left blank doxygen will generate a
1325 # generated HTML page. If the tag is left blank doxygen will generate a standard
1336 # the HTML output. If left blank doxygen will generate a default style sheet.
1340 # it is more robust and this tag (HTML_STYLESHEET) will in the future become
1351 # Doxygen will copy the style sheet files to the output directory.
1356 # Webkit/Chromium, the styling will be left out of the default doxygen.css if
1366 # that these files will be copied to the base HTML output directory. Use the
1369 # files will be copied as-is; there are no commands or markers available.
1388 # will adjust the colors in the style sheet and background images according to
1399 # in the HTML output. For a value of 0 the output will use gray-scales only. A
1400 # value of 255 will produce the most vivid colors.
1418 # documentation will contain a main index with vertical navigation menus that
1419 # are dynamically created via JavaScript. If disabled, the navigation index will
1429 # documentation will contain sections that can be hidden and shown after the
1438 # and collapse entries dynamically later on. Doxygen will expand the tree to
1441 # entries 1 will produce a full collapsed tree by default. 0 is a special value
1442 # representing an infinite number of entries and will result in a full expanded
1449 # If the GENERATE_DOCSET tag is set to YES, additional index files will be
1453 # create a documentation set, doxygen will generate a Makefile in the HTML
1454 # output directory. Running make will produce the docset in that directory and
1455 # running make install will install the docset in
1456 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1481 # com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1513 # files are now used as the Windows 98 help format, and will replace the old
1532 # doxygen will try to run the HTML help compiler on the generated index.hhp.
1567 # generated documentation will be placed on the server by the user during the
1577 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1634 # including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to
1640 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1673 # value is set to YES, a side panel will be generated containing a tree-like
1701 # doxygen will group on one line in the generated HTML documentation.
1703 # Note that a value of 0 will completely suppress the enum values from appearing
1717 # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
1724 # If the OBFUSCATE_EMAILS tag is set to YES, doxygen will obfuscate email
1731 # If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg
1734 # the HTML output. These images will generally look nicer at scaled resolutions.
1787 # this will be translated into chtml), NativeMML (i.e. MathML. Only supported
1788 # for NathJax 2. For MathJax version 3 chtml will be used instead.), chtml (This
1789 # is the name for Mathjax version 3, for MathJax version 2 this will be
1823 # of code that will be used on startup of the MathJax code. See the MathJax site
1831 # When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1852 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1855 # setting. When disabled, doxygen will generate a PHP script for searching and
1864 # When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1866 # which needs to be processed by an external indexer. Doxygen will invoke an
1882 # which will return the search results when EXTERNAL_SEARCH is enabled.
1923 # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
1928 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1929 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1960 # it will be automatically added in the LaTeX code.
1992 # If left blank no extra packages will be included.
1999 # first chapter. If it is left blank doxygen will generate a standard header. It
2016 # last chapter. If it is left blank doxygen will generate a standard footer. See
2029 # will copy the style sheet files to the output directory.
2039 # directory. Note that the files will be copied as-is; there are no commands or
2046 # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
2054 # If the USE_PDFLATEX tag is set to YES, doxygen will use the engine as
2069 # NON_STOP In nonstop mode the diagnostic message will appear on the terminal,
2071 # SCROLL In scroll mode, TeX will stop only for missing files to input or if
2072 # keyboard input is necessary and ERROR_STOP In errorstop mode, TeX will stop at
2079 # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
2095 # path from which the emoji images will be read. If a relative path is entered,
2096 # it will be relative to the LATEX_OUTPUT directory. If left blank the
2097 # LATEX_OUTPUT directory will be used.
2106 # If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
2113 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
2114 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2129 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
2130 # contain hyperlink fields. The RTF file will contain links (just like the HTML
2162 # If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
2168 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
2169 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2170 # it. A directory man3 will be created inside the directory specified by
2194 # will generate one additional man file for each entity documented in the real
2206 # If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
2212 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
2213 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2220 # If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
2222 # the XML output. Note that enabling this will significantly increase the size
2229 # If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include
2240 # If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
2246 # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
2247 # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
2258 # If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
2270 # If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
2278 # If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
2286 # If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
2289 # size of the Perl module output will be much smaller and Perl will parse it
2308 # If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
2314 # If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
2315 # in the source code. If set to NO, only conditional compilation will be
2332 # INCLUDE_PATH will be searched if a #include is found.
2348 # directories. If left blank, the patterns specified with FILE_PATTERNS will be
2366 # macro definition that is found in the sources will be used. Use the PREDEFINED
2373 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
2376 # are typically used for boiler-plate code, and will confuse the parser if not
2402 # When a file name is specified after GENERATE_TAGFILE, doxygen will create a
2408 # If the ALLEXTERNALS tag is set to YES, all external class will be listed in
2409 # the class index. If set to NO, only the inherited external classes will be
2415 # If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
2416 # in the modules index. If set to NO, only the current project's groups will be
2422 # If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
2423 # the related pages index. If set to NO, only the current project's pages will
2433 # If set to YES the inheritance and collaboration graphs will hide inheritance
2439 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2449 # to run in parallel. When set to 0 doxygen will base this on the number of
2494 # If the CLASS_GRAPH tag is set to YES or GRAPH or BUILTIN then doxygen will
2497 # HAVE_DOT is enabled as well, then dot will be used to draw the graph. In case
2499 # CLASS_GRAPH tag is set to BUILTIN, then the built-in generator will be used.
2501 # relations will be shown as texts / links.
2507 # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2516 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2524 # If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
2545 # If the DOT_UML_DETAILS tag is set to NO, doxygen will show attributes and
2547 # tag is set to YES, doxygen will add type and arguments for attributes and
2549 # will not generate fields with class member information in the UML graphs. The
2550 # class diagrams will look similar to the default class diagrams but using UML
2560 # significantly it will wrapped across multiple lines. Some heuristics are apply
2568 # collaboration graphs will show the relations between templates and their
2576 # YES then doxygen will generate a graph for each documented file showing the
2585 # set to YES then doxygen will generate a graph for each documented file showing
2593 # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2596 # Note that enabling this option will significantly increase the time of a run.
2597 # So in most cases it will be better to enable call graphs for selected
2605 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2608 # Note that enabling this option will significantly increase the time of a run.
2609 # So in most cases it will be better to enable caller graphs for selected
2617 # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2624 # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2680 # You can include diagrams made with dia in doxygen documentation. Doxygen will
2696 # a preprocessing step. Doxygen will generate a warning when it encounters a
2697 # \startuml command in this case and will not generate output for the diagram.
2712 # that will be shown in the graph. If the number of nodes in a graph becomes
2713 # larger than this value, doxygen will truncate the graph, which is visualized
2716 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2725 # root by following a path via at most 3 edges will be shown. Nodes that lay
2726 # further from the root node will be omitted. Note that setting this option to 1
2744 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2754 # If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate
2764 # command. If the MSCGEN_TOOL tag is left empty (the default), then doxygen will
2767 # specifying prog as the value, doxygen will call the tool as prog -T