Lines Matching refs:will

8 # All text after a hash (#) is considered a comment and will be ignored.
48 # Doxygen will copy the logo to the output directory.
53 # base path where the generated documentation will be put.
54 # If a relative path is entered, it will be relative to the location
55 # where doxygen was started. If left blank the current directory will be used.
59 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
61 # format and will distribute the generated files over these directories.
69 # documentation generated by doxygen is written. Doxygen will use this
81 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
88 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
91 # brief descriptions will be completely suppressed.
97 # in this list, if found as the leading text of the brief description, will be
108 # Doxygen will generate a detailed section even if there is only a brief
114 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
117 # operators of the base classes will not be shown.
121 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
123 # to NO the shortest path that makes the file name unique will be used.
133 # relative paths, which will be relative from the directory where doxygen is
147 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
154 # will interpret the first line (until the first dot) of a JavaDoc-style
156 # comments will behave just like regular Qt-style comments
161 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
164 # will behave just like regular Qt-style comments (thus requiring
184 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
185 # a new page for each member. If set to NO, the documentation of a member will
197 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
199 # will result in a user-defined paragraph with heading "Side Effects:".
206 # "class=itcl::class" will allow you to use the command class in the
212 # sources only. Doxygen will then generate output that is more tailored for C.
213 # For instance, some of the names that are used will be different. The list
214 # of all members will be omitted, etc.
219 # sources only. Doxygen will then generate output that is more tailored for
220 # Java. For instance, namespaces will be presented as packages, qualified
221 # scopes will look different, etc.
226 # sources only. Doxygen will then generate output that is more tailored for
232 # sources. Doxygen will then generate output that is tailored for
282 # Doxygen will parse them like normal C++ but will assume all classes use public
289 # default) will make doxygen replace the get and set methods by a property in
290 # the documentation. This will only work if the methods are indeed getting or
298 # tag is set to YES, then doxygen will reuse the documentation of the first
321 # unions with only public data fields will be shown inline in the documentation
331 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
332 # with name TypeT. When disabled the typedef will appear as a member of a file,
333 # namespace, or class. And the struct will be named TypeS. This can typically
341 # When the cache is full, less often used symbols will be written to disk.
346 # If the system has enough physical memory increasing the cache will improve the
348 # a logarithmic scale so increasing the size by one will roughly double the
359 # pre-resolved symbols. If the cache is too small doxygen will become slower.
370 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
372 # Private class members and static file members will be hidden unless
378 # will be included in the documentation.
383 # scope will be included in the documentation.
388 # will be included in the documentation.
394 # defined locally in source files will be included in the documentation.
407 # If this flag is set to YES, the members of anonymous namespaces will be
409 # 'anonymous_namespace{file}', where file will be replaced with the base
415 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
417 # If set to NO (the default) these members will be included in the
423 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
425 # If set to NO (the default) these classes will be included in the various
430 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
432 # If set to NO (the default) these declarations will be included in the
437 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
439 # If set to NO (the default) these blocks will be appended to the
446 # to NO (the default) then the documentation will be excluded.
451 # 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
499 # will sort the (brief and detailed) documentation of class members so that
501 # the constructors will appear in the respective orders defined by
503 # This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
509 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
511 # the group names will appear in their defined order.
516 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
518 # NO (the default), the class list will be sorted only by class name,
528 # do proper type resolution of all parameters of a function it will reject a
532 # will still accept a match between prototype and implementation in such cases.
569 # here it will be hidden. Use a value of 0 to hide initializers completely.
579 # list will mention the files that were used to generate the documentation.
584 # This will remove the Files entry from the Quick Index and from the
591 # This will remove the Namespaces entry from the Quick Index
598 # the version control system). Doxygen will invoke the program by executing (via
606 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
611 # DoxygenLayout.xml will be used as the name of the layout file.
641 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
642 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
647 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
656 # or return value. If set to NO (the default) doxygen will only warn about
664 # tags, which will be replaced by the file and line number from which the
666 # $version, which will be replaced by the version of the file (if it could
759 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
773 # invoke to filter for each input file. Doxygen will invoke the filter program
776 # input file. Doxygen will then use the output that the filter program writes
778 # If FILTER_PATTERNS is specified, this tag will be
785 # Doxygen will compare the file name with each pattern and apply the
795 # INPUT_FILTER) will be used to filter the input files when producing source
801 # pattern. A pattern will override the setting for FILTER_PATTERN (if any)
809 # is part of the input, its contents will be placed on the main page (index.html).
819 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
820 # be generated. Documented entities will be cross-referenced with these sources.
827 # Setting the INLINE_SOURCES tag to YES will include the body
832 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
834 # fragments. Normal C, C++ and Fortran comments will always remain visible.
841 # functions referencing it will be listed.
847 # called/used by that function will be listed.
853 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
855 # Otherwise they will link to the documentation.
860 # will point to the HTML generated by the htags(1) tool instead of doxygen
863 # will need version 4.8.6 or higher.
868 # will generate a verbatim copy of the header file for each class for
878 # of all compounds will be generated. Enable this if the project
885 # in which this list will be split (can be a number in the range [1..20])
890 # classes will be put under the same header in the alphabetical index.
900 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
905 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
906 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
907 # put in front of it. If left blank `html' will be used as the default path.
913 # doxygen will generate files with .html extension.
918 # each generated HTML page. If it is left blank doxygen will generate a
931 # each generated HTML page. If it is left blank doxygen will generate a
938 # fine-tune the look of the HTML output. If left blank doxygen will
941 # tag will in the future become obsolete.
950 # robust against future updates. Doxygen will copy the style sheet file to
957 # that these files will be copied to the base HTML output directory. Use the
960 # the files will be copied as-is; there are no commands or markers available.
965 # Doxygen will adjust the colors in the style sheet and background images
975 # the colors in the HTML output. For a value of 0 the output will use
976 # grayscales only. A value of 255 will produce the most vivid colors.
990 # page will contain the date and time when the page was generated. Setting
996 # documentation will contain sections that can be hidden and shown after the
1003 # can expand and collapse entries dynamically later on. Doxygen will expand
1006 # So setting the number of entries 1 will produce a full collapsed tree by
1008 # and will result in a full expanded tree by default.
1013 # will be generated that can be used as input for Apple's Xcode 3
1015 # To create a documentation set, doxygen will generate a Makefile in the
1016 # HTML output directory. Running make will produce the docset in that
1017 # directory and running "make install" will install the docset in
1018 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
1035 # will append .docset to the name.
1050 # will be generated that can be used as input for tools like the
1065 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
1094 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
1141 # If non-empty doxygen will try to run qhelpgenerator on the generated
1147 #  will be generated, which together with the HTML files, form an Eclipse help
1173 # If the tag value is set to YES, a side panel will be generated
1184 # (range [0,1..20]) that doxygen will group on one line in the generated HTML
1185 # documentation. Note that a value of 0 will completely suppress the enum
1196 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
1250 # When the SEARCHENGINE tag is enabled doxygen will generate a search box
1260 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1263 # EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for
1270 # When EXTERNAL_SEARCH is enabled doxygen will no longer generate the PHP
1272 # which needs to be processed by an external indexer. Doxygen will invoke an
1281 # which will returned the search results when EXTERNAL_SEARCH is enabled.
1314 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
1319 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1320 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1321 # put in front of it. If left blank `latex' will be used as the default path.
1326 # invoked. If left blank `latex' will be used as the default command name.
1334 # generate index for LaTeX. If left blank `makeindex' will be used as the
1347 # executive. If left blank a4wide will be used.
1358 # the first chapter. If it is left blank doxygen will generate a
1365 # the last chapter. If it is left blank doxygen will generate a
1371 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
1377 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1383 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1384 # command to the generated LaTeX files. This will instruct LaTeX to keep
1390 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
1396 # If LATEX_SOURCE_CODE is set to YES then doxygen will include
1413 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1419 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1420 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1421 # put in front of it. If left blank `rtf' will be used as the default path.
1432 # will contain hyperlink fields. The RTF file will
1455 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1460 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
1461 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1462 # put in front of it. If left blank `man' will be used as the default path.
1472 # then it will generate one additional man file for each entity
1483 # If the GENERATE_XML tag is set to YES Doxygen will
1489 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
1490 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1491 # put in front of it. If left blank `xml' will be used as the default path.
1507 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1510 # enabling this will significantly increase the size of the XML output.
1518 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1530 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
1538 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1544 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1549 # tag is set to NO the size of the Perl module output will be much smaller
1550 # and Perl will parse it just the same.
1565 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1571 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1573 # compilation will be performed. Macro expansion can be done in a controlled
1585 # pointed to by INCLUDE_PATH will be searched when a #include is found.
1597 # directories. If left blank, the patterns specified with FILE_PATTERNS will
1614 # The macro definition that is found in the sources will be used.
1621 # doxygen's preprocessor will remove all references to function-like macros
1623 # semicolon, because these will confuse the parser if not removed.
1646 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1651 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1653 # will be listed.
1657 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1658 # in the modules index. If set to NO, only the current project's groups will
1672 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1681 # command. Doxygen will then run the mscgen tool (see
1689 # If set to YES, the inheritance and collaboration graphs will hide
1695 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1703 # allowed to run in parallel. When set to 0 (the default) doxygen will
1710 # By default doxygen will use the Helvetica font for all dot files that
1724 # By default doxygen will tell dot to use the Helvetica font.
1731 # will generate a graph for each documented class showing the direct and
1732 # indirect inheritance relations. Setting this tag to YES will force the
1738 # will generate a graph for each documented class showing the direct and
1745 # will generate a graph for groups, showing the direct groups dependencies
1749 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1764 # If set to YES, the inheritance and collaboration graphs will show the
1770 # tags are set to YES then doxygen will generate a graph for each documented
1777 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1784 # doxygen will generate a call dependency graph for every global function
1785 # or class method. Note that enabling this option will significantly increase
1786 # the time of a run. So in most cases it will be better to enable call graphs
1792 # doxygen will generate a caller dependency graph for every global function
1793 # or class method. Note that enabling this option will significantly increase
1794 # the time of a run. So in most cases it will be better to enable caller
1800 # will generate a graphical hierarchy of all classes instead of a textual one.
1805 # then doxygen will show the dependencies a directory has on other directories
1813 # If left blank png will be used. If you choose svg you need to set
1846 # nodes that will be shown in the graph. If the number of nodes in a graph
1847 # becomes larger than this value, doxygen will truncate the graph, which is
1850 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1857 # from the root by following a path via at most 3 edges will be shown. Nodes
1858 # that lay further from the root node will be omitted. Note that setting this
1880 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1886 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will