Lines Matching refs: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 # when the HTML document is shown. Doxygen will copy the logo to the output
73 # into which the generated documentation will be written. If a relative path is
74 # entered, it will be relative to the location where Doxygen was started. If
75 # left blank the current directory will be used.
79 # If the CREATE_SUBDIRS tag is set to YES then Doxygen will create up to 4096
81 # and will distribute the generated files over these directories. Enabling this
90 # Controls the number of sub-directories that will be created when
101 # If the ALLOW_UNICODE_NAMES tag is set to YES, Doxygen will allow non-ASCII
103 # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
110 # documentation generated by Doxygen is written. Doxygen will use this
124 # If the BRIEF_MEMBER_DESC tag is set to YES, Doxygen will include brief member
131 # If the REPEAT_BRIEF tag is set to YES, Doxygen will prepend the brief
135 # brief descriptions will be completely suppressed.
142 # as the leading text of the brief description, will be stripped from the text
152 # Doxygen will generate a detailed section even if there is only a brief
158 # If the INLINE_INHERITED_MEMB tag is set to YES, Doxygen will show all
161 # operators of the base classes will not be shown.
166 # If the FULL_PATH_NAMES tag is set to YES, Doxygen will prepend the full path
168 # shortest path that makes the file name unique will be used
180 # will be relative from the directory where Doxygen is started.
194 # If the SHORT_NAMES tag is set to YES, Doxygen will generate much shorter (but
201 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen will interpret the
203 # description. If set to NO, the Javadoc-style will behave just like regular Qt-
210 # If the JAVADOC_BANNER tag is set to YES then Doxygen will interpret a line
214 # Javadoc-style will behave just like regular comments and it will not be
220 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will interpret the first
222 # set to NO, the Qt-style will behave just like regular Qt-style comments (thus
254 # If the SEPARATE_MEMBER_PAGES tag is set to YES then Doxygen will produce a new
255 # page for each member. If set to NO, the documentation of a member will be part
272 # will allow you to put the command \sideeffect (or @sideeffect) in the
273 # documentation, which will result in a user-defined paragraph with heading
300 # only. Doxygen will then generate output that is more tailored for C. For
301 # instance, some of the names that are used will be different. The list of all
302 # members will be omitted, etc.
308 # Python sources only. Doxygen will then generate output that is more tailored
309 # for that language. For instance, namespaces will be presented as packages,
310 # qualified scopes will look different, etc.
316 # sources. Doxygen will then generate output that is tailored for Fortran.
322 # sources. Doxygen will then generate output that is tailored for VHDL.
328 # sources only. Doxygen will then generate output that is more tailored for that
329 # language. For instance, namespaces will be presented as modules, types will be
413 # https://www.riverbankcomputing.com/software) sources only. Doxygen will parse
414 # them like normal C++ but will assume all classes use public instead of private
421 # getter and setter methods for a property. Setting this option to YES will make
423 # This will only work if the methods are indeed getting or setting a simple
431 # tag is set to YES then Doxygen will reuse the documentation of the first
466 # with only public data fields or simple typedef fields will be shown inline in
477 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
478 # with name TypeT. When disabled the typedef will appear as a member of a file,
479 # namespace, or class. And the struct will be named TypeS. This can typically be
490 # Doxygen will become slower. If the cache is too large, memory is wasted. The
493 # symbols. At the end of a run Doxygen will report the cache usage and suggest
500 # during processing. When set to 0 Doxygen will based this on the number of
512 # If the TIMESTAMP tag is set different from NO then each generated page will
524 # If the EXTRACT_ALL tag is set to YES, Doxygen will assume all entities in
526 # class members and static file members will be hidden unless the
528 # Note: This will also disable the warnings about undocumented members that are
534 # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
541 # methods of a class will be included in the documentation.
547 # scope will be included in the documentation.
552 # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
559 # locally in source files will be included in the documentation. If set to NO,
574 # If this flag is set to YES, the members of anonymous namespaces will be
576 # 'anonymous_namespace{file}', where file will be replaced with the base name of
584 # will be determined by the corresponding definition. By default unnamed
590 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
592 # members will be included in the various overviews, but no documentation
598 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
600 # to NO, these classes will be included in the various overviews. This option
601 # will also hide undocumented C++ concepts if enabled. This option has no effect
607 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all friend
608 # declarations. If set to NO, these declarations will be included in the
614 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
616 # blocks will be appended to the function's detailed documentation block.
623 # will be excluded. Set it to YES to include the internal documentation.
628 # With the correct setting of option CASE_SENSE_NAMES Doxygen will better be
645 # If the HIDE_SCOPE_NAMES tag is set to NO then Doxygen will show members with
647 # scope will be hidden.
652 # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then Doxygen will
654 # YES the compound reference will be hidden.
660 # will show which file needs to be included to use the class.
665 # If the SHOW_INCLUDE_FILES tag is set to YES then Doxygen will put a list of
671 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
678 # If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen will list include
690 # If the SORT_MEMBER_DOCS tag is set to YES then Doxygen will sort the
692 # name. If set to NO, the members will appear in declaration order.
697 # If the SORT_BRIEF_DOCS tag is set to YES then Doxygen will sort the brief
699 # name. If set to NO, the members will appear in declaration order. Note that
700 # this will also influence the order of the classes in the class list.
705 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then Doxygen will sort the
707 # destructors are listed first. If set to NO the constructors will appear in the
717 # If the SORT_GROUP_NAMES tag is set to YES then Doxygen will sort the hierarchy
718 # of group names into alphabetical order. If set to NO the group names will
724 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
725 # fully-qualified names, including namespaces. If set to NO, the class list will
735 # type resolution of all parameters of a function it will reject a match between
738 # simple string match. By disabling STRICT_PROTO_MATCHING Doxygen will still
778 # it will be hidden. Use a value of 0 to hide initializers completely. The
788 # list will mention the files that were used to generate the documentation.
794 # will remove the Files entry from the Quick Index and from the Folder Tree View
801 # page. This will remove the Namespaces entry from the Quick Index and from the
809 # the version control system). Doxygen will invoke the program by executing (via
817 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
822 # will be used as the name of the layout file. See also section "Changing the
826 # DoxygenLayout.xml, Doxygen will parse it automatically even if the LAYOUT_FILE
852 # launching external tools will then become
877 # If the WARN_IF_UNDOCUMENTED tag is set to YES then Doxygen will generate
879 # will automatically be disabled.
884 # If the WARN_IF_DOC_ERROR tag is set to YES, Doxygen will generate warnings for
892 # If WARN_IF_INCOMPLETE_DOC is set to YES, Doxygen will warn about incomplete
893 # function parameter documentation. If set to NO, Doxygen will accept that some
901 # value. If set to NO, Doxygen will only warn about wrong parameter
903 # set to YES then this flag will automatically be disabled. See also
909 # If WARN_IF_UNDOC_ENUM_VAL option is set to YES, Doxygen will warn about
910 # undocumented enumeration values. If set to NO, Doxygen will accept
912 # will automatically be disabled.
917 # If the WARN_AS_ERROR tag is set to YES then Doxygen will immediately stop when
919 # then Doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but
920 # at the end of the Doxygen process Doxygen will return with a non-zero status.
922 # like FAIL_ON_WARNINGS but in case no WARN_LOGFILE is defined Doxygen will not
924 # of a run, in case a WARN_LOGFILE is defined the warning messages will be
927 # the behavior will remain as with the setting FAIL_ON_WARNINGS.
935 # will be replaced by the file and line number from which the warning originated
936 # and the warning text. Optionally the format may contain $version, which will
996 # character encoding on a per file pattern basis. Doxygen will compare the file
1083 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
1097 # invoke to filter for each input file. Doxygen will invoke the filter program
1103 # name of an input file. Doxygen will then use the output that the filter
1105 # will be ignored.
1109 # or removed, the anchors will not be placed correctly.
1111 # Note that Doxygen will use the data processed and written to standard output
1123 # basis. Doxygen will compare the file name with each pattern and apply the
1136 # INPUT_FILTER) will also be used to filter the input files that are used for
1143 # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
1151 # is part of the input, its contents will be placed on the main page
1160 # setting FORTRAN_COMMENT_AFTER will also make it possible that longer lines can
1170 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
1171 # generated. Documented entities will be cross-referenced with these sources.
1179 # Setting the INLINE_SOURCES tag to YES will include the body of functions,
1186 # Setting the STRIP_CODE_COMMENTS tag to YES will instruct Doxygen to hide any
1188 # Fortran comments will always remain visible.
1194 # entity all documented functions referencing it will be listed.
1200 # all documented entities called/used by that function will be listed.
1207 # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
1214 # source code will show a tooltip with additional information such as prototype,
1216 # will make the HTML file larger and loading of large files a bit slower, you
1223 # If the USE_HTAGS tag is set to YES then the references to source code will
1226 # (see https://www.gnu.org/software/global/global.html). You will need version
1235 # Doxygen will invoke htags (and that will in turn invoke gtags), so these
1239 # source code will now point to the output of htags.
1245 # If the VERBATIM_HEADERS tag is set the YES then Doxygen will generate a
1253 # If the CLANG_ASSISTED_PARSING tag is set to YES then Doxygen will use the
1265 # tag is set to YES then Doxygen will add the directory of each input to the
1274 # the include paths will already be set by Doxygen for the files and directories
1286 # will then be passed to the parser. Any options specified with CLANG_OPTIONS
1287 # will be added as well.
1298 # compounds will be generated. Enable this if the project contains a lot of
1306 # tag works for classes, function and member names. The entity will be placed in
1317 # If the GENERATE_HTML tag is set to YES, Doxygen will generate HTML output
1322 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1323 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1338 # each generated HTML page. If the tag is left blank Doxygen will generate a
1358 # generated HTML page. If the tag is left blank Doxygen will generate a standard
1369 # the HTML output. If left blank Doxygen will generate a default style sheet.
1373 # it is more robust and this tag (HTML_STYLESHEET) will in the future become
1384 # Doxygen will copy the style sheet files to the output directory.
1389 # Webkit/Chromium, the styling will be left out of the default doxygen.css if
1402 # that these files will be copied to the base HTML output directory. Use the
1405 # files will be copied as-is; there are no commands or markers available.
1425 # will adjust the colors in the style sheet and background images according to
1436 # in the HTML output. For a value of 0 the output will use gray-scales only. A
1437 # value of 255 will produce the most vivid colors.
1455 # documentation will contain a main index with vertical navigation menus that
1456 # are dynamically created via JavaScript. If disabled, the navigation index will
1466 # documentation will contain sections that can be hidden and shown after the
1480 # If the HTML_COPY_CLIPBOARD tag is set to YES then Doxygen will show an icon in
1494 # the settings under a project specific key, such that the user preferences will
1502 # and collapse entries dynamically later on. Doxygen will expand the tree to
1505 # entries 1 will produce a full collapsed tree by default. 0 is a special value
1506 # representing an infinite number of entries and will result in a full expanded
1513 # If the GENERATE_DOCSET tag is set to YES, additional index files will be
1517 # create a documentation set, Doxygen will generate a Makefile in the HTML
1518 # output directory. Running make will produce the docset in that directory and
1519 # running make install will install the docset in
1520 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1545 # com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1577 # files are now used as the Windows 98 help format, and will replace the old
1596 # Doxygen will try to run the HTML help compiler on the generated index.hhp.
1631 # generated documentation will be placed on the server by the user during the
1641 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1698 # including file name) of Qt's qhelpgenerator. If non-empty Doxygen will try to
1704 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1737 # value is set to YES, a side panel will be generated containing a tree-like
1765 # Doxygen will group on one line in the generated HTML documentation.
1767 # Note that a value of 0 will completely suppress the enum values from appearing
1774 # When the SHOW_ENUM_VALUES tag is set doxygen will show the specified
1787 # If the EXT_LINKS_IN_WINDOW option is set to YES, Doxygen will open links to
1794 # If the OBFUSCATE_EMAILS tag is set to YES, Doxygen will obfuscate email
1801 # If the HTML_FORMULA_FORMAT option is set to svg, Doxygen will use the pdf2svg
1804 # the HTML output. These images will generally look nicer at scaled resolutions.
1857 # this will be translated into chtml), NativeMML (i.e. MathML. Only supported
1858 # for MathJax 2. For MathJax version 3 chtml will be used instead.), chtml (This
1859 # is the name for Mathjax version 3, for MathJax version 2 this will be
1893 # of code that will be used on startup of the MathJax code. See the MathJax site
1901 # When the SEARCHENGINE tag is enabled Doxygen will generate a search box for
1922 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1925 # setting. When disabled, Doxygen will generate a PHP script for searching and
1934 # When EXTERNAL_SEARCH tag is enabled Doxygen will no longer generate the PHP
1936 # which needs to be processed by an external indexer. Doxygen will invoke an
1952 # which will return the search results when EXTERNAL_SEARCH is enabled.
1993 # If the GENERATE_LATEX tag is set to YES, Doxygen will generate LaTeX output.
1998 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1999 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2030 # it will be automatically added in the LaTeX code.
2062 # If left blank no extra packages will be included.
2069 # first chapter. If it is left blank Doxygen will generate a standard header. It
2086 # last chapter. If it is left blank Doxygen will generate a standard footer. See
2099 # will copy the style sheet files to the output directory.
2109 # directory. Note that the files will be copied as-is; there are no commands or
2116 # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
2124 # If the USE_PDFLATEX tag is set to YES, Doxygen will use the engine as
2139 # NON_STOP In nonstop mode the diagnostic message will appear on the terminal,
2141 # SCROLL In scroll mode, TeX will stop only for missing files to input or if
2142 # keyboard input is necessary and ERROR_STOP In errorstop mode, TeX will stop at
2149 # If the LATEX_HIDE_INDICES tag is set to YES then Doxygen will not include the
2165 # path from which the emoji images will be read. If a relative path is entered,
2166 # it will be relative to the LATEX_OUTPUT directory. If left blank the
2167 # LATEX_OUTPUT directory will be used.
2176 # If the GENERATE_RTF tag is set to YES, Doxygen will generate RTF output. The
2183 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
2184 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2199 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
2200 # contain hyperlink fields. The RTF file will contain links (just like the HTML
2230 # Note that the files will be copied as-is; there are no commands or markers
2240 # If the GENERATE_MAN tag is set to YES, Doxygen will generate man pages for
2246 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
2247 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2248 # it. A directory man3 will be created inside the directory specified by
2272 # will generate one additional man file for each entity documented in the real
2284 # If the GENERATE_XML tag is set to YES, Doxygen will generate an XML file that
2290 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
2291 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2298 # If the XML_PROGRAMLISTING tag is set to YES, Doxygen will dump the program
2300 # the XML output. Note that enabling this will significantly increase the size
2307 # If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, Doxygen will include
2318 # If the GENERATE_DOCBOOK tag is set to YES, Doxygen will generate Docbook files
2324 # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
2325 # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
2336 # If the GENERATE_AUTOGEN_DEF tag is set to YES, Doxygen will generate an
2348 # If the GENERATE_SQLITE3 tag is set to YES Doxygen will generate a Sqlite3
2354 # The SQLITE3_OUTPUT tag is used to specify where the Sqlite3 database will be
2355 # put. If a relative path is entered the value of OUTPUT_DIRECTORY will be put
2363 # database file will be recreated with each Doxygen run. If set to NO, Doxygen
2364 # will warn if a database file is already found and not modify it.
2374 # If the GENERATE_PERLMOD tag is set to YES, Doxygen will generate a Perl module
2382 # If the PERLMOD_LATEX tag is set to YES, Doxygen will generate the necessary
2390 # If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
2393 # size of the Perl module output will be much smaller and Perl will parse it
2412 # If the ENABLE_PREPROCESSING tag is set to YES, Doxygen will evaluate all
2418 # If the MACRO_EXPANSION tag is set to YES, Doxygen will expand all macro names
2419 # in the source code. If set to NO, only conditional compilation will be
2436 # INCLUDE_PATH will be searched if a #include is found.
2452 # directories. If left blank, the patterns specified with FILE_PATTERNS will be
2532 # macro definition that is found in the sources will be used. Use the PREDEFINED
2539 # If the SKIP_FUNCTION_MACROS tag is set to YES then Doxygen's preprocessor will
2542 # are typically used for boiler-plate code, and will confuse the parser if not
2568 # When a file name is specified after GENERATE_TAGFILE, Doxygen will create a
2575 # will be listed in the class and namespace index. If set to NO, only the
2576 # inherited external classes will be listed.
2581 # If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
2582 # in the topic index. If set to NO, only the current project's groups will be
2588 # If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
2589 # the related pages index. If set to NO, only the current project's pages will
2599 # If set to YES the inheritance and collaboration graphs will hide inheritance
2605 # If you set the HAVE_DOT tag to YES then Doxygen will assume the dot tool is
2615 # to run in parallel. When set to 0 Doxygen will base this on the number of
2660 # If the CLASS_GRAPH tag is set to YES or GRAPH or BUILTIN then Doxygen will
2663 # HAVE_DOT is enabled as well, then dot will be used to draw the graph. In case
2665 # CLASS_GRAPH tag is set to BUILTIN, then the built-in generator will be used.
2667 # relations will be shown as texts / links. Explicit enabling an inheritance
2677 # If the COLLABORATION_GRAPH tag is set to YES then Doxygen will generate a
2689 # If the GROUP_GRAPHS tag is set to YES then Doxygen will generate a graph for
2700 # If the UML_LOOK tag is set to YES, Doxygen will generate inheritance and
2721 # If the DOT_UML_DETAILS tag is set to NO, Doxygen will show attributes and
2723 # tag is set to YES, Doxygen will add type and arguments for attributes and
2725 # will not generate fields with class member information in the UML graphs. The
2726 # class diagrams will look similar to the default class diagrams but using UML
2736 # significantly it will be wrapped across multiple lines. Some heuristics are
2744 # collaboration graphs will show the relations between templates and their
2752 # YES then Doxygen will generate a graph for each documented file showing the
2763 # set to YES then Doxygen will generate a graph for each documented file showing
2774 # If the CALL_GRAPH tag is set to YES then Doxygen will generate a call
2777 # Note that enabling this option will significantly increase the time of a run.
2778 # So in most cases it will be better to enable call graphs for selected
2786 # If the CALLER_GRAPH tag is set to YES then Doxygen will generate a caller
2789 # Note that enabling this option will significantly increase the time of a run.
2790 # So in most cases it will be better to enable caller graphs for selected
2798 # If the GRAPHICAL_HIERARCHY tag is set to YES then Doxygen will graphical
2805 # If the DIRECTORY_GRAPH tag is set to YES then Doxygen will show the
2864 # You can include diagrams made with dia in Doxygen documentation. Doxygen will
2880 # a preprocessing step. Doxygen will generate a warning when it encounters a
2881 # \startuml command in this case and will not generate output for the diagram.
2896 # that will be shown in the graph. If the number of nodes in a graph becomes
2897 # larger than this value, Doxygen will truncate the graph, which is visualized
2900 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2909 # root by following a path via at most 3 edges will be shown. Nodes that lay
2910 # further from the root node will be omitted. Note that setting this option to 1
2928 # If the GENERATE_LEGEND tag is set to YES Doxygen will generate a legend page
2938 # If the DOT_CLEANUP tag is set to YES, Doxygen will remove the intermediate
2948 # command. If the MSCGEN_TOOL tag is left empty (the default), then Doxygen will
2951 # specifying prog as the value, Doxygen will call the tool as prog -T