Lines Matching refs:will
37 # All text after a hash (#) is considered a comment and will be
86 # and the maximum width should not exceed 200 pixels. Doxygen will copy the logo
92 # into which the generated documentation will be written. If a relative path is
93 # entered, it will be relative to the location where doxygen was started. If
94 # left blank the current directory will be used.
98 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub-
100 # will distribute the generated files over these directories. Enabling this
109 # documentation generated by doxygen is written. Doxygen will use this
123 # If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member
130 # If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief
134 # brief descriptions will be completely suppressed.
141 # as the leading text of the brief description, will be stripped from the text
161 # doxygen will generate a detailed section even if there is only a brief
167 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
170 # operators of the base classes will not be shown.
175 # If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path
177 # shortest path that makes the file name unique will be used
189 # will be relative from the directory where doxygen is started.
204 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
211 # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
213 # description. If set to NO, the Javadoc-style will behave just like regular Qt-
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
246 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a
247 # new page for each member. If set to NO, the documentation of a member will be
264 # will allow you to put the command \sideeffect (or @sideeffect) in the
265 # documentation, which will result in a user-defined paragraph with heading
273 # will allow you to use the command class in the itcl::class meaning.
278 # only. Doxygen will then generate output that is more tailored for C. For
279 # instance, some of the names that are used will be different. The list of all
280 # members will be omitted, etc.
286 # Python sources only. Doxygen will then generate output that is more tailored
287 # for that language. For instance, namespaces will be presented as packages,
288 # qualified scopes will look different, etc.
294 # sources. Doxygen will then generate output that is tailored for Fortran.
300 # sources. Doxygen will then generate output that is tailored for VHDL.
357 # will parse them like normal C++ but will assume all classes use public instead
364 # getter and setter methods for a property. Setting this option to YES will make
366 # This will only work if the methods are indeed getting or setting a simple
374 # tag is set to YES, then doxygen will reuse the documentation of the first
402 # with only public data fields or simple typedef fields will be shown inline in
413 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
414 # with name TypeT. When disabled the typedef will appear as a member of a file,
415 # namespace, or class. And the struct will be named TypeS. This can typically be
426 # doxygen will become slower. If the cache is too large, memory is wasted. The
429 # symbols. At the end of a run doxygen will report the cache usage and suggest
439 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
441 # class members and static file members will be hidden unless the
443 # Note: This will also disable the warnings about undocumented members that are
449 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class will
456 # scope will be included in the documentation.
461 # If the EXTRACT_STATIC tag is set to YES all static members of a file will be
468 # locally in source files will be included in the documentation. If set to NO
483 # If this flag is set to YES, the members of anonymous namespaces will be
485 # 'anonymous_namespace{file}', where file will be replaced with the base name of
492 # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
494 # members will be included in the various overviews, but no documentation
500 # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
502 # to NO these classes will be included in the various overviews. This option has
508 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
509 # (class|struct|union) declarations. If set to NO these declarations will be
515 # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
517 # blocks will be appended to the function's detailed documentation block.
524 # will be excluded. Set it to YES to include the internal documentation.
529 # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
538 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
540 # scope will be hidden.
545 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
551 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
558 # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
570 # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
572 # name. If set to NO the members will appear in declaration order.
577 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
579 # name. If set to NO the members will appear in declaration order. Note that
580 # this will also influence the order of the classes in the class list.
585 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
587 # destructors are listed first. If set to NO the constructors will appear in the
597 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
598 # of group names into alphabetical order. If set to NO the group names will
604 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
605 # fully-qualified names, including namespaces. If set to NO, the class list will
615 # type resolution of all parameters of a function it will reject a match between
618 # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
660 # it will be hidden. Use a value of 0 to hide initializers completely. The
670 # will mention the files that were used to generate the documentation.
676 # will remove the Files entry from the Quick Index and from the Folder Tree View
683 # page. This will remove the Namespaces entry from the Quick Index and from the
691 # the version control system). Doxygen will invoke the program by executing (via
699 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
704 # will be used as the name of the layout file.
707 # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
743 # If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate
745 # will automatically be disabled.
750 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
760 # value. If set to NO doxygen will only warn about wrong or incomplete parameter
768 # will be replaced by the file and line number from which the warning originated
769 # and the warning text. Optionally the format may contain $version, which will
904 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
918 # invoke to filter for each input file. Doxygen will invoke the filter program
924 # name of an input file. Doxygen will then use the output that the filter
926 # will be ignored.
930 # or removed, the anchors will not be placed correctly.
935 # basis. Doxygen will compare the file name with each pattern and apply the
944 # INPUT_FILTER ) will also be used to filter the input files that are used for
951 # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
959 # is part of the input, its contents will be placed on the main page
969 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
970 # generated. Documented entities will be cross-referenced with these sources.
978 # Setting the INLINE_SOURCES tag to YES will include the body of functions,
984 # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
986 # Fortran comments will always remain visible.
992 # function all documented functions referencing it will be listed.
998 # all documented entities called/used by that function will be listed.
1005 # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
1012 # source code will show a tooltip with additional information such as prototype,
1014 # will make the HTML file larger and loading of large files a bit slower, you
1021 # If the USE_HTAGS tag is set to YES then the references to source code will
1024 # (see http://www.gnu.org/software/global/global.html). You will need version
1033 # Doxygen will invoke htags (and that will in turn invoke gtags), so these
1037 # source code will now point to the output of htags.
1043 # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
1056 # compounds will be generated. Enable this if the project contains a lot of
1063 # which the alphabetical index list will be split.
1069 # In case all classes in a project start with a common prefix, all classes will
1081 # If the GENERATE_HTML tag is set to YES doxygen will generate HTML output
1086 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1087 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1102 # each generated HTML page. If the tag is left blank doxygen will generate a
1122 # generated HTML page. If the tag is left blank doxygen will generate a standard
1133 # the HTML output. If left blank doxygen will generate a default style sheet.
1137 # it is more robust and this tag (HTML_STYLESHEET) will in the future become
1148 # Doxygen will copy the style sheet file to the output directory. For an example
1156 # that these files will be copied to the base HTML output directory. Use the
1159 # files will be copied as-is; there are no commands or markers available.
1165 # will adjust the colors in the stylesheet and background images according to
1176 # in the HTML output. For a value of 0 the output will use grayscales only. A
1177 # value of 255 will produce the most vivid colors.
1195 # page will contain the date and time when the page was generated. Setting this
1203 # documentation will contain sections that can be hidden and shown after the
1212 # and collapse entries dynamically later on. Doxygen will expand the tree to
1215 # entries 1 will produce a full collapsed tree by default. 0 is a special value
1216 # representing an infinite number of entries and will result in a full expanded
1223 # If the GENERATE_DOCSET tag is set to YES, additional index files will be
1226 # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
1227 # Makefile in the HTML output directory. Running make will produce the docset in
1228 # that directory and running make install will install the docset in
1229 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1247 # com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1275 # files are now used as the Windows 98 help format, and will replace the old
1294 # doxygen will try to run the HTML help compiler on the generated index.hhp.
1328 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1384 # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
1390 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1423 # value is set to YES, a side panel will be generated containing a tree-like
1439 # doxygen will group on one line in the generated HTML documentation.
1441 # Note that a value of 0 will completely suppress the enum values from appearing
1455 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to
1524 # of code that will be used on startup of the MathJax code. See the MathJax site
1531 # When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1552 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1555 # EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for
1564 # When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1566 # which needs to be processed by an external indexer. Doxygen will invoke an
1581 # which will return the search results when EXTERNAL_SEARCH is enabled.
1621 # If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output.
1626 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1627 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1673 # If left blank no extra packages will be included.
1680 # chapter. If it is left blank doxygen will generate a standard header. See
1686 # $datetime, $date, $doxygenversion, $projectname, $projectnumber. Doxygen will
1696 # chapter. If it is left blank doxygen will generate a standard footer.
1705 # directory. Note that the files will be copied as-is; there are no commands or
1712 # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
1720 # If the LATEX_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1728 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1729 # command to the generated LaTeX files. This will instruct LaTeX to keep running
1737 # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1744 # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
1766 # If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The
1773 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
1774 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1789 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
1790 # contain hyperlink fields. The RTF file will contain links (just like the HTML
1822 # If the GENERATE_MAN tag is set to YES doxygen will generate man pages for
1828 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
1829 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1830 # it. A directory man3 will be created inside the directory specified by
1847 # will generate one additional man file for each entity documented in the real
1859 # If the GENERATE_XML tag is set to YES doxygen will generate an XML file that
1865 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
1866 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1885 # If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program
1887 # the XML output. Note that enabling this will significantly increase the size
1898 # If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files
1904 # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
1905 # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
1916 # If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen
1928 # If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module
1936 # If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary
1944 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely
1947 # size of the Perl module output will be much smaller and Perl will parse it
1966 # If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all
1972 # If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names
1973 # in the source code. If set to NO only conditional compilation will be
1990 # INCLUDE_PATH will be searched if a #include is found.
2006 # directories. If left blank, the patterns specified with FILE_PATTERNS will be
2024 # macro definition that is found in the sources will be used. Use the PREDEFINED
2031 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
2034 # typically used for boiler-plate code, and will confuse the parser if not
2060 # When a file name is specified after GENERATE_TAGFILE, doxygen will create a
2066 # If the ALLEXTERNALS tag is set to YES all external class will be listed in the
2067 # class index. If set to NO only the inherited external classes will be listed.
2072 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in
2073 # the modules index. If set to NO, only the current project's groups will be
2079 # If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in
2080 # the related pages index. If set to NO, only the current project's pages will
2096 # If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram
2106 # command. Doxygen will then run the mscgen tool (see:
2114 # You can include diagrams made with dia in doxygen documentation. Doxygen will
2121 # If set to YES, the inheritance and collaboration graphs will hide inheritance
2127 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2137 # to run in parallel. When set to 0 doxygen will base this on the number of
2163 # By default doxygen will tell dot to use the default font as specified with
2170 # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2172 # Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
2178 # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2187 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2194 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
2216 # collaboration graphs will show the relations between templates and their
2224 # YES then doxygen will generate a graph for each documented file showing the
2233 # set to YES then doxygen will generate a graph for each documented file showing
2241 # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2244 # Note that enabling this option will significantly increase the time of a run.
2245 # So in most cases it will be better to enable call graphs for selected
2252 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2255 # Note that enabling this option will significantly increase the time of a run.
2256 # So in most cases it will be better to enable caller graphs for selected
2263 # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2270 # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2328 # that will be shown in the graph. If the number of nodes in a graph becomes
2329 # larger than this value, doxygen will truncate the graph, which is visualized
2332 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2341 # root by following a path via at most 3 edges will be shown. Nodes that lay
2342 # further from the root node will be omitted. Note that setting this option to 1
2372 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2380 # If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot