Lines Matching refs:will

6 # All text after a hash (#) is considered a comment and will be ignored
46 # Doxygen will copy the logo to the output directory.
51 # base path where the generated documentation will be put.
52 # If a relative path is entered, it will be relative to the location
53 # where doxygen was started. If left blank the current directory will be used.
57 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
59 # format and will distribute the generated files over these directories.
67 # documentation generated by doxygen is written. Doxygen will use this
79 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
86 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
89 # brief descriptions will be completely suppressed.
95 # in this list, if found as the leading text of the brief description, will be
116 # Doxygen will generate a detailed section even if there is only a brief
121 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
124 # operators of the base classes will not be shown.
128 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
130 # to NO the shortest path that makes the file name unique will be used.
140 # relative paths, which will be relative from the directory where doxygen is
154 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
161 # will interpret the first line (until the first dot) of a JavaDoc-style
163 # comments will behave just like regular Qt-style comments
168 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
171 # will behave just like regular Qt-style comments (thus requiring
190 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
191 # a new page for each member. If set to NO, the documentation of a member will
203 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
205 # will result in a user-defined paragraph with heading "Side Effects:".
212 # "class=itcl::class" will allow you to use the command class in the
218 # sources only. Doxygen will then generate output that is more tailored for C.
219 # For instance, some of the names that are used will be different. The list
220 # of all members will be omitted, etc.
225 # sources only. Doxygen will then generate output that is more tailored for
226 # Java. For instance, namespaces will be presented as packages, qualified
227 # scopes will look different, etc.
232 # sources only. Doxygen will then generate output that is more tailored for
238 # sources. Doxygen will then generate output that is tailored for
287 # Doxygen will parse them like normal C++ but will assume all classes use public
294 # default) will make doxygen replace the get and set methods by a property in
295 # the documentation. This will only work if the methods are indeed getting or
302 # tag is set to YES, then doxygen will reuse the documentation of the first
324 # unions with only public data fields will be shown inline in the documentation
334 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
335 # with name TypeT. When disabled the typedef will appear as a member of a file,
336 # namespace, or class. And the struct will be named TypeS. This can typically
344 # When the cache is full, less often used symbols will be written to disk.
349 # If the system has enough physical memory increasing the cache will improve the
351 # a logarithmic scale so increasing the size by one will roughly double the
362 # pre-resolved symbols. If the cache is too small doxygen will become slower.
373 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
375 # Private class members and static file members will be hidden unless
381 # will be included in the documentation.
386 # scope will be included in the documentation.
391 # will be included in the documentation.
396 # defined locally in source files will be included in the documentation.
408 # If this flag is set to YES, the members of anonymous namespaces will be
410 # 'anonymous_namespace{file}', where file will be replaced with the base
416 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
418 # If set to NO (the default) these members will be included in the
424 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
426 # If set to NO (the default) these classes will be included in the various
431 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
433 # If set to NO (the default) these declarations will be included in the
438 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
440 # If set to NO (the default) these blocks will be appended to the
447 # to NO (the default) then the documentation will be excluded.
452 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
461 # will show members with their full class and namespace scopes in the
462 # documentation. If set to YES the scope will be hidden.
467 # will put a list of the files that are included by a file in the documentation
473 # will list include files with double quotes in the documentation
484 # will sort the (detailed) documentation of file and class members
485 # alphabetically by member name. If set to NO the members will appear in
490 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
492 # by member name. If set to NO (the default) the members will appear in
498 # will sort the (brief and detailed) documentation of class members so that
500 # the constructors will appear in the respective orders defined by
502 # This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
507 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
509 # the group names will appear in their defined order.
513 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
515 # NO (the default), the class list will be sorted only by class name,
524 # do proper type resolution of all parameters of a function it will reject a
528 # will still accept a match between prototype and implementation in such cases.
565 # here it will be hidden. Use a value of 0 to hide initializers completely.
574 # list will mention the files that were used to generate the documentation.
579 # This will remove the Files entry from the Quick Index and from the
585 # Namespaces page.  This will remove the Namespaces entry from the Quick Index
592 # the version control system). Doxygen will invoke the program by executing (via
600 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
605 # DoxygenLayout.xml will be used as the name of the layout file.
635 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
636 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
641 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
650 # or return value. If set to NO (the default) doxygen will only warn about
658 # tags, which will be replaced by the file and line number from which the
660 # $version, which will be replaced by the version of the file (if it could
782 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
796 # invoke to filter for each input file. Doxygen will invoke the filter program
799 # input file. Doxygen will then use the output that the filter program writes
800 # to standard output.  If FILTER_PATTERNS is specified, this tag will be
806 # basis.  Doxygen will compare the file name with each pattern and apply the
815 # INPUT_FILTER) will be used to filter the input files when producing source
821 # pattern. A pattern will override the setting for FILTER_PATTERN (if any)
829 # is part of the input, its contents will be placed on the main page (index.html).
839 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
840 # be generated. Documented entities will be cross-referenced with these sources.
846 # Setting the INLINE_SOURCES tag to YES will include the body
851 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
853 # fragments. Normal C, C++ and Fortran comments will always remain visible.
859 # functions referencing it will be listed.
865 # called/used by that function will be listed.
871 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
872 # link to the source code.  Otherwise they will link to the documentation.
877 # will point to the HTML generated by the htags(1) tool instead of doxygen
880 # will need version 4.8.6 or higher.
885 # will generate a verbatim copy of the header file for each class for
895 # of all compounds will be generated. Enable this if the project
902 # in which this list will be split (can be a number in the range [1..20])
907 # classes will be put under the same header in the alphabetical index.
917 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
922 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
923 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
924 # put in front of it. If left blank `html' will be used as the default path.
930 # doxygen will generate files with .html extension.
935 # each generated HTML page. If it is left blank doxygen will generate a
948 # each generated HTML page. If it is left blank doxygen will generate a
955 # fine-tune the look of the HTML output. If left blank doxygen will
958 # tag will in the future become obsolete.
967 # robust against future updates. Doxygen will copy the style sheet file to
974 # that these files will be copied to the base HTML output directory. Use the
977 # the files will be copied as-is; there are no commands or markers available.
982 # Doxygen will adjust the colors in the style sheet and background images
992 # the colors in the HTML output. For a value of 0 the output will use
993 # grayscales only. A value of 255 will produce the most vivid colors.
1007 # page will contain the date and time when the page was generated. Setting
1013 # documentation will contain sections that can be hidden and shown after the
1020 # can expand and collapse entries dynamically later on. Doxygen will expand
1023 # So setting the number of entries 1 will produce a full collapsed tree by
1025 # and will result in a full expanded tree by default.
1030 # will be generated that can be used as input for Apple's Xcode 3
1032 # To create a documentation set, doxygen will generate a Makefile in the
1033 # HTML output directory. Running make will produce the docset in that
1034 # directory and running "make install" will install the docset in
1035 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
1052 # will append .docset to the name.
1067 # will be generated that can be used as input for tools like the
1082 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
1111 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
1158 # If non-empty doxygen will try to run qhelpgenerator on the generated
1164 # will be generated, which together with the HTML files, form an Eclipse help
1190 # If the tag value is set to YES, a side panel will be generated
1201 # (range [0,1..20]) that doxygen will group on one line in the generated HTML
1202 # documentation. Note that a value of 0 will completely suppress the enum
1213 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
1266 # When the SEARCHENGINE tag is enabled doxygen will generate a search box
1276 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1279 # EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for
1286 # When EXTERNAL_SEARCH is enabled doxygen will no longer generate the PHP
1288 # which needs to be processed by an external indexer. Doxygen will invoke an
1297 # which will returned the search results when EXTERNAL_SEARCH is enabled.
1330 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
1335 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1336 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1337 # put in front of it. If left blank `latex' will be used as the default path.
1342 # invoked. If left blank `latex' will be used as the default command name.
1350 # generate index for LaTeX. If left blank `makeindex' will be used as the
1363 # executive. If left blank a4wide will be used.
1374 # the first chapter. If it is left blank doxygen will generate a
1381 # the last chapter. If it is left blank doxygen will generate a
1387 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
1393 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1399 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1400 # command to the generated LaTeX files. This will instruct LaTeX to keep
1406 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
1412 # If LATEX_SOURCE_CODE is set to YES then doxygen will include
1429 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1435 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1436 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1437 # put in front of it. If left blank `rtf' will be used as the default path.
1448 # will contain hyperlink fields. The RTF file will
1471 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1476 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
1477 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1478 # put in front of it. If left blank `man' will be used as the default path.
1488 # then it will generate one additional man file for each entity
1499 # If the GENERATE_XML tag is set to YES Doxygen will
1505 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
1506 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1507 # put in front of it. If left blank `xml' will be used as the default path.
1523 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1526 # enabling this will significantly increase the size of the XML output.
1534 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1546 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
1554 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1560 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1563 # tag is set to NO the size of the Perl module output will be much smaller
1564 # and Perl will parse it just the same.
1579 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1585 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1587 # compilation will be performed. Macro expansion can be done in a controlled
1599 # pointed to by INCLUDE_PATH will be searched when a #include is found.
1611 # directories. If left blank, the patterns specified with FILE_PATTERNS will
1628 # The macro definition that is found in the sources will be used.
1635 # doxygen's preprocessor will remove all references to function-like macros
1637 # semicolon, because these will confuse the parser if not removed.
1658 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1663 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1665 # will be listed.
1669 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1670 # in the modules index. If set to NO, only the current project's groups will
1684 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1693 # command. Doxygen will then run the mscgen tool (see
1701 # If set to YES, the inheritance and collaboration graphs will hide
1707 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1715 # allowed to run in parallel. When set to 0 (the default) doxygen will
1722 # By default doxygen will use the Helvetica font for all dot files that
1736 # By default doxygen will tell dot to use the Helvetica font.
1743 # will generate a graph for each documented class showing the direct and
1744 # indirect inheritance relations. Setting this tag to YES will force the
1750 # will generate a graph for each documented class showing the direct and
1757 # will generate a graph for groups, showing the direct groups dependencies
1761 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1776 # If set to YES, the inheritance and collaboration graphs will show the
1782 # tags are set to YES then doxygen will generate a graph for each documented
1789 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1796 # doxygen will generate a call dependency graph for every global function
1797 # or class method. Note that enabling this option will significantly increase
1798 # the time of a run. So in most cases it will be better to enable call graphs
1804 # doxygen will generate a caller dependency graph for every global function
1805 # or class method. Note that enabling this option will significantly increase
1806 # the time of a run. So in most cases it will be better to enable caller
1812 # will generate a graphical hierarchy of all classes instead of a textual one.
1817 # then doxygen will show the dependencies a directory has on other directories
1825 # If left blank png will be used. If you choose svg you need to set
1858 # nodes that will be shown in the graph. If the number of nodes in a graph
1859 # becomes larger than this value, doxygen will truncate the graph, which is
1862 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1869 # from the root by following a path via at most 3 edges will be shown. Nodes
1870 # that lay further from the root node will be omitted. Note that setting this
1892 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1898 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will