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
67 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
74 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
77 # brief descriptions will be completely suppressed.
83 # in this list, if found as the leading text of the brief description, will be
94 # Doxygen will generate a detailed section even if there is only a brief
99 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
102 # operators of the base classes will not be shown.
106 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
108 # to NO the shortest path that makes the file name unique will be used.
130 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
137 # will interpret the first line (until the first dot) of a JavaDoc-style
139 # comments will behave just like the Qt-style comments (thus requiring an
153 # will output the detailed description near the top, like JavaDoc.
166 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
167 # a new page for each member. If set to NO, the documentation of a member will
179 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
181 # will result in a user-defined paragraph with heading "Side Effects:".
187 # sources only. Doxygen will then generate output that is more tailored for C.
188 # For instance, some of the names that are used will be different. The list
189 # of all members will be omitted, etc.
194 # sources only. Doxygen will then generate output that is more tailored for Java.
195 # For instance, namespaces will be presented as packages, qualified scopes
196 # will look different, etc.
210 # tag is set to YES, then doxygen will reuse the documentation of the first
228 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
230 # Private class members and static file members will be hidden unless
236 # will be included in the documentation.
241 # will be included in the documentation.
246 # defined locally in source files will be included in the documentation.
258 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
260 # If set to NO (the default) these members will be included in the
266 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
268 # If set to NO (the default) these classes will be included in the various
273 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
275 # If set to NO (the default) these declarations will be included in the
280 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
282 # If set to NO (the default) these blocks will be appended to the
289 # to NO (the default) then the documentation will be excluded.
294 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
303 # will show members with their full class and namespace scopes in the
304 # documentation. If set to YES the scope will be hidden.
309 # will put a list of the files that are included by a file in the documentation
320 # will sort the (detailed) documentation of file and class members
321 # alphabetically by member name. If set to NO the members will appear in
326 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
328 # by member name. If set to NO (the default) the members will appear in
333 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
335 # NO (the default), the class list will be sorted only by class name,
375 # here it will be hidden. Use a value of 0 to hide initializers completely.
384 # list will mention the files that were used to generate the documentation.
389 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
396 # version control system). Doxygen will invoke the program by executing (via
419 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
420 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
425 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
434 # or return value. If set to NO (the default) doxygen will only warn about
442 # tags, which will be replaced by the file and line number from which the
444 # $version, which will be replaced by the version of the file (if it could
520 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
534 # invoke to filter for each input file. Doxygen will invoke the filter program
537 # input file. Doxygen will then use the output that the filter program writes
538 # to standard output.  If FILTER_PATTERNS is specified, this tag will be
544 # basis.  Doxygen will compare the file name with each pattern and apply the
553 # INPUT_FILTER) will be used to filter the input files when producing source
562 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
563 # be generated. Documented entities will be cross-referenced with these sources.
569 # Setting the INLINE_SOURCES tag to YES will include the body
574 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
576 # fragments. Normal C and C++ comments will always remain visible.
582 # functions referencing it will be listed.
588 # called/used by that function will be listed.
593 # will point to the HTML generated by the htags(1) tool instead of doxygen
596 # will need version 4.8.6 or higher.
601 # will generate a verbatim copy of the header file for each class for
611 # of all compounds will be generated. Enable this if the project
618 # in which this list will be split (can be a number in the range [1..20])
623 # classes will be put under the same header in the alphabetical index.
633 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
638 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
639 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
640 # put in front of it. If left blank `html' will be used as the default path.
646 # doxygen will generate files with .html extension.
651 # each generated HTML page. If it is left blank doxygen will generate a
657 # each generated HTML page. If it is left blank doxygen will generate a
665 # will generate a default style sheet. Note that doxygen will try to copy
667 # stylesheet in the HTML output directory as well, or it will be erased!
672 # files or namespaces will be aligned in HTML using tables. If set to
673 # NO a bullet list will be used.
678 # will be generated that can be used as input for tools like the
693 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
722 # that doxygen will group on one line in the generated HTML documentation.
726 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
745 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
750 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
751 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
752 # put in front of it. If left blank `latex' will be used as the default path.
757 # invoked. If left blank `latex' will be used as the default command name.
762 # generate index for LaTeX. If left blank `makeindex' will be used as the
775 # executive. If left blank a4wide will be used.
786 # the first chapter. If it is left blank doxygen will generate a
792 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
798 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
804 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
805 # command to the generated LaTeX files. This will instruct LaTeX to keep
811 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
821 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
827 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
828 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
829 # put in front of it. If left blank `rtf' will be used as the default path.
840 # will contain hyperlink fields. The RTF file will
863 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
868 # The MAN_OUTPUT tag is used to specify where the man 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 `man' will be used as the default path.
880 # then it will generate one additional man file for each entity
891 # If the GENERATE_XML tag is set to YES Doxygen will
897 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
898 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
899 # put in front of it. If left blank `xml' will be used as the default path.
915 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
918 # enabling this will significantly increase the size of the XML output.
926 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
938 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
946 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
952 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
955 # tag is set to NO the size of the Perl module output will be much smaller
956 # and Perl will parse it just the same.
971 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
977 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
979 # compilation will be performed. Macro expansion can be done in a controlled
991 # in the INCLUDE_PATH (see below) will be search if a #include is found.
1003 # directories. If left blank, the patterns specified with FILE_PATTERNS will
1020 # The macro definition that is found in the sources will be used.
1026 # doxygen's preprocessor will remove all function-like macros that are alone
1028 # function macros are typically used for boiler-plate code, and will confuse
1054 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1059 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1061 # will be listed.
1065 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1066 # in the modules index. If set to NO, only the current project's groups will
1080 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1089 # If set to YES, the inheritance and collaboration graphs will hide
1095 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1103 # will generate a graph for each documented class showing the direct and
1104 # indirect inheritance relations. Setting this tag to YES will force the
1110 # will generate a graph for each documented class showing the direct and
1117 # will generate a graph for groups, showing the direct groups dependencies
1121 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1128 # If set to YES, the inheritance and collaboration graphs will show the
1134 # tags are set to YES then doxygen will generate a graph for each documented
1141 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1147 # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
1149 # Note that enabling this option will significantly increase the time of a run.
1150 # So in most cases it will be better to enable call graphs for selected
1156 # will graphical hierarchy of all classes instead of a textual one.
1161 # then doxygen will show the dependencies a directory has on other directories
1169 # If left blank png will be used.
1186 # this value, doxygen will try to truncate the graph, so that it fits within
1195 # this value, doxygen will try to truncate the graph, so that it fits within
1204 # from the root by following a path via at most 3 edges will be shown. Nodes
1205 # that lay further from the root node will be omitted. Note that setting this
1230 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1236 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1247 # used. If set to NO the values of all tags below this one will be ignored.