Lines Matching refs:will
6 # All text after a hash (#) is considered a comment and will be ignored
37 # base path where the generated documentation will be put.
38 # If a relative path is entered, it will be relative to the location
39 # where doxygen was started. If left blank the current directory will be used.
43 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
45 # format and will distribute the generated files over these directories.
53 # documentation generated by doxygen is written. Doxygen will use this
64 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
71 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
74 # brief descriptions will be completely suppressed.
80 # in this list, if found as the leading text of the brief description, will be
91 # Doxygen will generate a detailed section even if there is only a brief
96 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
99 # operators of the base classes will not be shown.
103 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
105 # to NO the shortest path that makes the file name unique will be used.
127 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
134 # will interpret the first line (until the first dot) of a JavaDoc-style
136 # comments will behave just like regular Qt-style comments
141 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
144 # will behave just like regular Qt-style comments (thus requiring
158 # will output the detailed description near the top, like JavaDoc.
170 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
171 # a new page for each member. If set to NO, the documentation of a member will
183 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
185 # will result in a user-defined paragraph with heading "Side Effects:".
191 # sources only. Doxygen will then generate output that is more tailored for C.
192 # For instance, some of the names that are used will be different. The list
193 # of all members will be omitted, etc.
198 # sources only. Doxygen will then generate output that is more tailored for Java.
199 # For instance, namespaces will be presented as packages, qualified scopes
200 # will look different, etc.
219 # tag is set to YES, then doxygen will reuse the documentation of the first
237 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
239 # Private class members and static file members will be hidden unless
245 # will be included in the documentation.
250 # will be included in the documentation.
255 # defined locally in source files will be included in the documentation.
267 # If this flag is set to YES, the members of anonymous namespaces will be extracted
269 # where file will be replaced with the base name of the file that contains the anonymous
274 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
276 # If set to NO (the default) these members will be included in the
282 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
284 # If set to NO (the default) these classes will be included in the various
289 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
291 # If set to NO (the default) these declarations will be included in the
296 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
298 # If set to NO (the default) these blocks will be appended to the
305 # to NO (the default) then the documentation will be excluded.
310 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
319 # will show members with their full class and namespace scopes in the
320 # documentation. If set to YES the scope will be hidden.
325 # will put a list of the files that are included by a file in the documentation
336 # will sort the (detailed) documentation of file and class members
337 # alphabetically by member name. If set to NO the members will appear in
342 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
344 # by member name. If set to NO (the default) the members will appear in
349 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
351 # NO (the default), the class list will be sorted only by class name,
391 # here it will be hidden. Use a value of 0 to hide initializers completely.
400 # list will mention the files that were used to generate the documentation.
405 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
412 # version control system). Doxygen will invoke the program by executing (via
435 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
436 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
441 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
450 # or return value. If set to NO (the default) doxygen will only warn about
458 # tags, which will be replaced by the file and line number from which the
460 # $version, which will be replaced by the version of the file (if it could
546 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
560 # invoke to filter for each input file. Doxygen will invoke the filter program
563 # input file. Doxygen will then use the output that the filter program writes
564 # to standard output. If FILTER_PATTERNS is specified, this tag will be
570 # basis. Doxygen will compare the file name with each pattern and apply the
579 # INPUT_FILTER) will be used to filter the input files when producing source
588 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
589 # be generated. Documented entities will be cross-referenced with these sources.
592 # then you must also enable this option. If you don't then doxygen will produce
597 # Setting the INLINE_SOURCES tag to YES will include the body
602 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
604 # fragments. Normal C and C++ comments will always remain visible.
610 # functions referencing it will be listed.
616 # called/used by that function will be listed.
622 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
623 # link to the source code. Otherwise they will link to the documentstion.
628 # will point to the HTML generated by the htags(1) tool instead of doxygen
631 # will need version 4.8.6 or higher.
636 # will generate a verbatim copy of the header file for each class for
646 # of all compounds will be generated. Enable this if the project
653 # in which this list will be split (can be a number in the range [1..20])
658 # classes will be put under the same header in the alphabetical index.
668 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
673 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
674 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
675 # put in front of it. If left blank `html' will be used as the default path.
681 # doxygen will generate files with .html extension.
686 # each generated HTML page. If it is left blank doxygen will generate a
692 # each generated HTML page. If it is left blank doxygen will generate a
700 # will generate a default style sheet. Note that doxygen will try to copy
702 # stylesheet in the HTML output directory as well, or it will be erased!
707 # files or namespaces will be aligned in HTML using tables. If set to
708 # NO a bullet list will be used.
713 # will be generated that can be used as input for tools like the
720 # documentation will contain sections that can be hidden and shown after the
736 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
765 # that doxygen will group on one line in the generated HTML documentation.
769 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
788 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
793 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
794 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
795 # put in front of it. If left blank `latex' will be used as the default path.
800 # invoked. If left blank `latex' will be used as the default command name.
805 # generate index for LaTeX. If left blank `makeindex' will be used as the
818 # executive. If left blank a4wide will be used.
829 # the first chapter. If it is left blank doxygen will generate a
835 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
841 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
847 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
848 # command to the generated LaTeX files. This will instruct LaTeX to keep
854 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
864 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
870 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
871 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
872 # put in front of it. If left blank `rtf' will be used as the default path.
883 # will contain hyperlink fields. The RTF file will
906 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
911 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
912 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
913 # put in front of it. If left blank `man' will be used as the default path.
923 # then it will generate one additional man file for each entity
934 # If the GENERATE_XML tag is set to YES Doxygen will
940 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
941 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
942 # put in front of it. If left blank `xml' will be used as the default path.
958 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
961 # enabling this will significantly increase the size of the XML output.
969 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
981 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
989 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
995 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
998 # tag is set to NO the size of the Perl module output will be much smaller
999 # and Perl will parse it just the same.
1014 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1020 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1022 # compilation will be performed. Macro expansion can be done in a controlled
1034 # in the INCLUDE_PATH (see below) will be search if a #include is found.
1046 # directories. If left blank, the patterns specified with FILE_PATTERNS will
1063 # The macro definition that is found in the sources will be used.
1069 # doxygen's preprocessor will remove all function-like macros that are alone
1071 # function macros are typically used for boiler-plate code, and will confuse
1104 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1109 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1111 # will be listed.
1115 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1116 # in the modules index. If set to NO, only the current project's groups will
1130 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1140 # command. Doxygen will then run the mscgen tool (see http://www.mcternan.me.uk/mscgen/) to
1147 # If set to YES, the inheritance and collaboration graphs will hide
1153 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1161 # will generate a graph for each documented class showing the direct and
1162 # indirect inheritance relations. Setting this tag to YES will force the
1168 # will generate a graph for each documented class showing the direct and
1175 # will generate a graph for groups, showing the direct groups dependencies
1179 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1185 # If set to YES, the inheritance and collaboration graphs will show the
1191 # tags are set to YES then doxygen will generate a graph for each documented
1198 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1204 # If the CALL_GRAPH, SOURCE_BROWSER and HAVE_DOT tags are set to YES then doxygen will
1206 # Note that enabling this option will significantly increase the time of a run.
1207 # So in most cases it will be better to enable call graphs for selected
1212 # If the CALLER_GRAPH, SOURCE_BROWSER and HAVE_DOT tags are set to YES then doxygen will
1214 # Note that enabling this option will significantly increase the time of a run.
1215 # So in most cases it will be better to enable caller graphs for selected
1221 # will graphical hierarchy of all classes instead of a textual one.
1226 # then doxygen will show the dependencies a directory has on other directories
1234 # If left blank png will be used.
1250 # nodes that will be shown in the graph. If the number of nodes in a graph
1251 # becomes larger than this value, doxygen will truncate the graph, which is
1254 # MAX_DOT_GRAPH_NOTES then the graph will not be shown at all. Also note
1261 # from the root by following a path via at most 3 edges will be shown. Nodes
1262 # that lay further from the root node will be omitted. Note that setting this
1284 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1290 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1301 # used. If set to NO the values of all tags below this one will be ignored.