Lines Matching refs:will
6 # All text after a hash (#) is considered a comment and will be ignored
29 # base path where the generated documentation will be put.
30 # If a relative path is entered, it will be relative to the location
31 # where doxygen was started. If left blank the current directory will be used.
35 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
37 # format and will distribute the generated files over these directories.
45 # documentation generated by doxygen is written. Doxygen will use this
56 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
63 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
66 # brief descriptions will be completely suppressed.
72 # in this list, if found as the leading text of the brief description, will be
83 # Doxygen will generate a detailed section even if there is only a brief
88 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
91 # operators of the base classes will not be shown.
95 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
97 # to NO the shortest path that makes the file name unique will be used.
119 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
126 # will interpret the first line (until the first dot) of a JavaDoc-style
128 # comments will behave just like the Qt-style comments (thus requiring an
133 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
136 # will behave just like regular Qt-style comments (thus requiring
150 # will output the detailed description near the top, like JavaDoc.
163 # tag is set to YES, then doxygen will reuse the documentation of the first
169 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
170 # a new page for each member. If set to NO, the documentation of a member will
182 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
184 # will result in a user-defined paragraph with heading "Side Effects:".
190 # sources only. Doxygen will then generate output that is more tailored for C.
191 # For instance, some of the names that are used will be different. The list
192 # of all members will be omitted, etc.
197 # only. Doxygen will then generate output that is more tailored for Java.
198 # For instance, namespaces will be presented as packages, qualified scopes
199 # will look different, etc.
215 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
217 # Private class members and static file members will be hidden unless
223 # will be included in the documentation.
228 # will be included in the documentation.
233 # defined locally in source files will be included in the documentation.
245 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
247 # If set to NO (the default) these members will be included in the
253 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
255 # If set to NO (the default) these classes will be included in the various
260 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
262 # If set to NO (the default) these declarations will be included in the
267 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
269 # If set to NO (the default) these blocks will be appended to the
276 # to NO (the default) then the documentation will be excluded.
281 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
290 # will show members with their full class and namespace scopes in the
291 # documentation. If set to YES the scope will be hidden.
296 # will put a list of the files that are included by a file in the documentation
307 # will sort the (detailed) documentation of file and class members
308 # alphabetically by member name. If set to NO the members will appear in
313 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
315 # by member name. If set to NO (the default) the members will appear in
320 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
322 # NO (the default), the class list will be sorted only by class name,
362 # here it will be hidden. Use a value of 0 to hide initializers completely.
371 # list will mention the files that were used to generate the documentation.
376 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
383 # version control system). Doxygen will invoke the program by executing (via
406 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
407 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
412 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
421 # or return value. If set to NO (the default) doxygen will only warn about
429 # tags, which will be replaced by the file and line number from which the
431 # $version, which will be replaced by the version of the file (if it could
499 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
513 # invoke to filter for each input file. Doxygen will invoke the filter program
516 # input file. Doxygen will then use the output that the filter program writes
517 # to standard output. If FILTER_PATTERNS is specified, this tag will be
523 # basis. Doxygen will compare the file name with each pattern and apply the
532 # INPUT_FILTER) will be used to filter the input files when producing source
541 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
542 # be generated. Documented entities will be cross-referenced with these sources.
548 # Setting the INLINE_SOURCES tag to YES will include the body
553 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
555 # fragments. Normal C and C++ comments will always remain visible.
561 # functions referencing it will be listed.
567 # called/used by that function will be listed.
572 # will generate a verbatim copy of the header file for each class for
582 # of all compounds will be generated. Enable this if the project
589 # in which this list will be split (can be a number in the range [1..20])
594 # classes will be put under the same header in the alphabetical index.
604 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
609 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
610 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
611 # put in front of it. If left blank `html' will be used as the default path.
617 # doxygen will generate files with .html extension.
622 # each generated HTML page. If it is left blank doxygen will generate a
628 # each generated HTML page. If it is left blank doxygen will generate a
636 # will generate a default style sheet. Note that doxygen will try to copy
638 # stylesheet in the HTML output directory as well, or it will be erased!
643 # files or namespaces will be aligned in HTML using tables. If set to
644 # NO a bullet list will be used.
649 # will be generated that can be used as input for tools like the
664 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
693 # that doxygen will group on one line in the generated HTML documentation.
697 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
716 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
721 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
722 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
723 # put in front of it. If left blank `latex' will be used as the default path.
728 # invoked. If left blank `latex' will be used as the default command name.
733 # generate index for LaTeX. If left blank `makeindex' will be used as the
746 # executive. If left blank a4wide will be used.
757 # the first chapter. If it is left blank doxygen will generate a
763 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
769 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
775 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
776 # command to the generated LaTeX files. This will instruct LaTeX to keep
782 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
792 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
798 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
799 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
800 # put in front of it. If left blank `rtf' will be used as the default path.
811 # will contain hyperlink fields. The RTF file will
834 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
839 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
840 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
841 # put in front of it. If left blank `man' will be used as the default path.
851 # then it will generate one additional man file for each entity
862 # If the GENERATE_XML tag is set to YES Doxygen will
868 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
869 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
870 # put in front of it. If left blank `xml' will be used as the default path.
886 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
889 # enabling this will significantly increase the size of the XML output.
897 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
909 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
917 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
923 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
926 # tag is set to NO the size of the Perl module output will be much smaller
927 # and Perl will parse it just the same.
942 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
948 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
950 # compilation will be performed. Macro expansion can be done in a controlled
962 # in the INCLUDE_PATH (see below) will be search if a #include is found.
974 # directories. If left blank, the patterns specified with FILE_PATTERNS will
991 # The macro definition that is found in the sources will be used.
997 # doxygen's preprocessor will remove all function-like macros that are alone
999 # function macros are typically used for boiler-plate code, and will confuse
1025 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1030 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1032 # will be listed.
1036 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1037 # in the modules index. If set to NO, only the current project's groups will
1051 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1060 # If set to YES, the inheritance and collaboration graphs will hide
1066 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1074 # will generate a graph for each documented class showing the direct and
1075 # indirect inheritance relations. Setting this tag to YES will force the
1081 # will generate a graph for each documented class showing the direct and
1088 # will generate a graph for groups, showing the direct groups dependencies
1092 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1098 # If set to YES, the inheritance and collaboration graphs will show the
1104 # tags are set to YES then doxygen will generate a graph for each documented
1111 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1117 # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
1119 # Note that enabling this option will significantly increase the time of a run.
1120 # So in most cases it will be better to enable call graphs for selected
1126 # will graphical hierarchy of all classes instead of a textual one.
1131 # then doxygen will show the dependencies a directory has on other directories
1139 # If left blank png will be used.
1156 # this value, doxygen will try to truncate the graph, so that it fits within
1164 # this value, doxygen will try to truncate the graph, so that it fits within
1172 # from the root by following a path via at most 3 edges will be shown. Nodes
1173 # that lay further from the root node will be omitted. Note that setting this
1197 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1203 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1214 # used. If set to NO the values of all tags below this one will be ignored.