Lines Matching full:will

17 # All text after a hash (#) is considered a comment and will be ignored
42 # base path where the generated documentation will be put.
43 # If a relative path is entered, it will be relative to the location
44 # where doxygen was started. If left blank the current directory will be used.
48 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
50 # format and will distribute the generated files over these directories.
58 # documentation generated by doxygen is written. Doxygen will use this
69 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
76 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
79 # brief descriptions will be completely suppressed.
85 # in this list, if found as the leading text of the brief description, will be
96 # Doxygen will generate a detailed section even if there is only a brief
101 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
104 # operators of the base classes will not be shown.
108 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
110 # to NO the shortest path that makes the file name unique will be used.
132 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
139 # will interpret the first line (until the first dot) of a java_doc-style
141 # comments will behave just like regular Qt-style comments
146 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
149 # will behave just like regular Qt-style comments (thus requiring
168 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
169 # a new page for each member. If set to NO, the documentation of a member will
181 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
183 # will result in a user-defined paragraph with heading "Side Effects:".
189 # sources only. Doxygen will then generate output that is more tailored for C.
190 # For instance, some of the names that are used will be different. The list
191 # of all members will be omitted, etc.
196 # sources only. Doxygen will then generate output that is more tailored for Java.
197 # For instance, namespaces will be presented as packages, qualified scopes
198 # will look different, etc.
217 # Doxygen will parse them like normal C++ but will assume all classes use public
223 # tag is set to YES, then doxygen will reuse the documentation of the first
239 # typedef struct type_s {} type_t, will appear in the documentation as a struct
240 # with name type_t. When disabled the typedef will appear as a member of a file,
241 # namespace, or class. And the struct will be named type_s. This can typically
251 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
253 # Private class members and static file members will be hidden unless
259 # will be included in the documentation.
264 # will be included in the documentation.
269 # defined locally in source files will be included in the documentation.
281 # If this flag is set to YES, the members of anonymous namespaces will be extracted
283 # where file will be replaced with the base name of the file that contains the anonymous
288 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
290 # If set to NO (the default) these members will be included in the
296 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
298 # If set to NO (the default) these classes will be included in the various
303 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
305 # If set to NO (the default) these declarations will be included in the
310 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
312 # If set to NO (the default) these blocks will be appended to the
319 # to NO (the default) then the documentation will be excluded.
324 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
333 # will show members with their full class and namespace scopes in the
334 # documentation. If set to YES the scope will be hidden.
339 # will put a list of the files that are included by a file in the documentation
350 # will sort the (detailed) documentation of file and class members
351 # alphabetically by member name. If set to NO the members will appear in
356 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
358 # by member name. If set to NO (the default) the members will appear in
363 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
365 # NO (the default), the class list will be sorted only by class name,
405 # here it will be hidden. Use a value of 0 to hide initializers completely.
414 # list will mention the files that were used to generate the documentation.
420 # version control system). Doxygen will invoke the program by executing (via
443 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
444 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
449 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
458 # or return value. If set to NO (the default) doxygen will only warn about
466 # tags, which will be replaced by the file and line number from which the
468 # $version, which will be replaced by the version of the file (if it could
552 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
566 # invoke to filter for each input file. Doxygen will invoke the filter program
569 # input file. Doxygen will then use the output that the filter program writes
570 # to standard output.  If FILTER_PATTERNS is specified, this tag will be
576 # basis.  Doxygen will compare the file name with each pattern and apply the
585 # INPUT_FILTER) will be used to filter the input files when producing source
594 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
595 # be generated. Documented entities will be cross-referenced with these sources.
598 # then you must also enable this option. If you don't then doxygen will produce
603 # Setting the INLINE_SOURCES tag to YES will include the body
608 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
610 # fragments. Normal C and C++ comments will always remain visible.
616 # functions referencing it will be listed.
622 # called/used by that function will be listed.
628 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
629 # link to the source code.  Otherwise they will link to the documentstion.
634 # will point to the HTML generated by the htags(1) tool instead of doxygen
637 # will need version 4.8.6 or higher.
642 # will generate a verbatim copy of the header file for each class for
652 # of all compounds will be generated. Enable this if the project
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 # will be generated that can be used as input for tools like the
714 # documentation will contain sections that can be hidden and shown after the
730 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
759 # that doxygen will group on one line in the generated HTML documentation.
763 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
782 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
787 # The LATEX_OUTPUT tag is used to specify where the la_te_x docs will be put.
788 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
789 # put in front of it. If left blank `latex' will be used as the default path.
794 # invoked. If left blank `latex' will be used as the default command name.
799 # generate index for la_te_x. If left blank `makeindex' will be used as the
812 # executive. If left blank a4wide will be used.
823 # the first chapter. If it is left blank doxygen will generate a
829 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
835 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
841 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
842 # command to the generated la_te_x files. This will instruct la_te_x to keep
848 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
858 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
864 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
865 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
866 # put in front of it. If left blank `rtf' will be used as the default path.
877 # will contain hyperlink fields. The RTF file will
900 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
905 # The MAN_OUTPUT tag is used to specify where the man pages 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 `man' will be used as the default path.
917 # then it will generate one additional man file for each entity
928 # If the GENERATE_XML tag is set to YES Doxygen will
934 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
935 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
936 # put in front of it. If left blank `xml' will be used as the default path.
940 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
943 # enabling this will significantly increase the size of the XML output.
951 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
963 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
971 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
977 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
980 # tag is set to NO the size of the Perl module output will be much smaller
981 # and Perl will parse it just the same.
996 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1002 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1004 # compilation will be performed. Macro expansion can be done in a controlled
1016 # in the INCLUDE_PATH (see below) will be search if a #include is found.
1028 # directories. If left blank, the patterns specified with FILE_PATTERNS will
1045 # The macro definition that is found in the sources will be used.
1051 # doxygen's preprocessor will remove all function-like macros that are alone
1053 # function macros are typically used for boiler-plate code, and will confuse
1079 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1084 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1086 # will be listed.
1090 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1091 # in the modules index. If set to NO, only the current project's groups will
1100 # If set to YES, the inheritance and collaboration graphs will hide
1106 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1113 # If the CLASS_GRAPH tag is set to YES (or GRAPH) then doxygen will generate a
1115 # relations. In case HAVE_DOT is set as well dot will be used to draw the graph,
1116 # otherwise the built-in generator will be used. If the CLASS_GRAPH tag is set
1117 # to TEXT the direct and indirect inheritance relations will be shown as texts /
1125 # will generate a graph for each documented class showing the direct and
1132 # will generate a graph for groups, showing the direct groups dependencies
1136 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1142 # If set to YES, the inheritance and collaboration graphs will show the
1148 # tags are set to YES then doxygen will generate a graph for each documented
1155 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1161 # If the CALL_GRAPH, SOURCE_BROWSER and HAVE_DOT tags are set to YES then doxygen will
1163 # Note that enabling this option will significantly increase the time of a run.
1164 # So in most cases it will be better to enable call graphs for selected
1169 # If the CALLER_GRAPH, SOURCE_BROWSER and HAVE_DOT tags are set to YES then doxygen will
1171 # Note that enabling this option will significantly increase the time of a run.
1172 # So in most cases it will be better to enable caller graphs for selected
1178 # will graphical hierarchy of all classes instead of a textual one.
1183 # then doxygen will show the dependencies a directory has on other directories
1191 # If left blank png will be used.
1207 # nodes that will be shown in the graph. If the number of nodes in a graph
1208 # becomes larger than this value, doxygen will truncate the graph, which is
1211 # MAX_DOT_GRAPH_NOTES then the graph will not be shown at all. Also note
1218 # from the root by following a path via at most 3 edges will be shown. Nodes
1219 # that lay further from the root node will be omitted. Note that setting this
1233 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1239 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1250 # used. If set to NO the values of all tags below this one will be ignored.