Lines Matching full:will

6 # All text after a hash (#) is considered a comment and will be ignored.
46 # Doxygen will copy the logo to the output directory.
51 # base path where the generated documentation will be put.
52 # If a relative path is entered, it will be relative to the location
53 # where doxygen was started. If left blank the current directory will be used.
57 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
59 # format and will distribute the generated files over these directories.
67 # documentation generated by doxygen is written. Doxygen will use this
79 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
86 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
89 # brief descriptions will be completely suppressed.
95 # in this list, if found as the leading text of the brief description, will be
106 # Doxygen will generate a detailed section even if there is only a brief
111 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
114 # operators of the base classes will not be shown.
118 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
120 # to NO the shortest path that makes the file name unique will be used.
142 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
149 # will interpret the first line (until the first dot) of a JavaDoc-style
151 # comments will behave just like regular Qt-style comments
156 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
159 # will behave just like regular Qt-style comments (thus requiring
178 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
179 # a new page for each member. If set to NO, the documentation of a member will
191 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
193 # will result in a user-defined paragraph with heading "Side Effects:".
201 # "class=itcl::class" will allow you to use the command class in the
207 # sources only. Doxygen will then generate output that is more tailored for C.
208 # For instance, some of the names that are used will be different. The list
209 # of all members will be omitted, etc.
214 # sources only. Doxygen will then generate output that is more tailored for
215 # Java. For instance, namespaces will be presented as packages, qualified
216 # scopes will look different, etc.
221 # sources only. Doxygen will then generate output that is more tailored for
227 # sources. Doxygen will then generate output that is tailored for
259 # Doxygen will parse them like normal C++ but will assume all classes use public
266 # will make doxygen replace the get and set methods by a property in the
267 # documentation. This will only work if the methods are indeed getting or
274 # tag is set to YES, then doxygen will reuse the documentation of the first
296 # unions with only public data fields will be shown inline in the documentation
306 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
307 # with name TypeT. When disabled the typedef will appear as a member of a file,
308 # namespace, or class. And the struct will be named TypeS. This can typically
316 # When the cache is full, less often used symbols will be written to disk.
321 # If the system has enough physical memory increasing the cache will improve the
323 # a logarithmic scale so increasing the size by one will roughly double the
334 # pre-resolved symbols. If the cache is too small doxygen will become slower.
345 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
347 # Private class members and static file members will be hidden unless
353 # will be included in the documentation.
358 # will be included in the documentation.
363 # defined locally in source files will be included in the documentation.
375 # If this flag is set to YES, the members of anonymous namespaces will be
377 # 'anonymous_namespace{file}', where file will be replaced with the base
383 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
385 # If set to NO (the default) these members will be included in the
391 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
393 # If set to NO (the default) these classes will be included in the various
398 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
400 # If set to NO (the default) these declarations will be included in the
405 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
407 # If set to NO (the default) these blocks will be appended to the
414 # to NO (the default) then the documentation will be excluded.
419 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
428 # will show members with their full class and namespace scopes in the
429 # documentation. If set to YES the scope will be hidden.
434 # will put a list of the files that are included by a file in the documentation
440 # will list include files with double quotes in the documentation
451 # will sort the (detailed) documentation of file and class members
452 # alphabetically by member name. If set to NO the members will appear in
457 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
459 # by member name. If set to NO (the default) the members will appear in
465 # will sort the (brief and detailed) documentation of class members so that
467 # the constructors will appear in the respective orders defined by
469 # This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
474 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
476 # the group names will appear in their defined order.
480 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
482 # NO (the default), the class list will be sorted only by class name,
491 # do proper type resolution of all parameters of a function it will reject a
495 # will still accept a match between prototype and implementation in such cases.
531 # here it will be hidden. Use a value of 0 to hide initializers completely.
540 # list will mention the files that were used to generate the documentation.
545 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
551 # This will remove the Files entry from the Quick Index and from the
558 # This will remove the Namespaces entry from the Quick Index
565 # the version control system). Doxygen will invoke the program by executing (via
573 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
578 # DoxygenLayout.xml will be used as the name of the layout file.
607 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
608 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
613 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
622 # or return value. If set to NO (the default) doxygen will only warn about
630 # tags, which will be replaced by the file and line number from which the
632 # $version, which will be replaced by the version of the file (if it could
722 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
736 # invoke to filter for each input file. Doxygen will invoke the filter program
739 # input file. Doxygen will then use the output that the filter program writes
741 # If FILTER_PATTERNS is specified, this tag will be
748 # Doxygen will compare the file name with each pattern and apply the
758 # INPUT_FILTER) will be used to filter the input files when producing source
764 # pattern. A pattern will override the setting for FILTER_PATTERN (if any)
775 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
776 # be generated. Documented entities will be cross-referenced with these sources.
782 # Setting the INLINE_SOURCES tag to YES will include the body
787 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
789 # fragments. Normal C and C++ comments will always remain visible.
795 # functions referencing it will be listed.
801 # called/used by that function will be listed.
807 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
809 # Otherwise they will link to the documentation.
814 # will point to the HTML generated by the htags(1) tool instead of doxygen
817 # will need version 4.8.6 or higher.
822 # will generate a verbatim copy of the header file for each class for
832 # of all compounds will be generated. Enable this if the project
839 # in which this list will be split (can be a number in the range [1..20])
844 # classes will be put under the same header in the alphabetical index.
854 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
859 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
860 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
861 # put in front of it. If left blank `html' will be used as the default path.
867 # doxygen will generate files with .html extension.
872 # each generated HTML page. If it is left blank doxygen will generate a
885 # each generated HTML page. If it is left blank doxygen will generate a
893 # will generate a default style sheet. Note that doxygen will try to copy
895 # style sheet in the HTML output directory as well, or it will be erased!
901 # that these files will be copied to the base HTML output directory. Use the
904 # the files will be copied as-is; there are no commands or markers available.
909 # Doxygen will adjust the colors in the style sheet and background images
919 # the colors in the HTML output. For a value of 0 the output will use
920 # grayscales only. A value of 255 will produce the most vivid colors.
934 # page will contain the date and time when the page was generated. Setting
940 # files or namespaces will be aligned in HTML using tables. If set to
941 # NO a bullet list will be used.
946 # documentation will contain sections that can be hidden and shown after the
954 # will be generated that can be used as input for Apple's Xcode 3
956 # To create a documentation set, doxygen will generate a Makefile in the
957 # HTML output directory. Running make will produce the docset in that
958 # directory and running "make install" will install the docset in
959 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
976 # will append .docset to the name.
991 # will be generated that can be used as input for tools like the
1006 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
1035 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
1082 # If non-empty doxygen will try to run qhelpgenerator on the generated
1088 #  will be generated, which together with the HTML files, form an Eclipse help
1114 # If the tag value is set to YES, a side panel will be generated
1125 # (range [0,1..20]) that doxygen will group on one line in the generated HTML
1126 # documentation. Note that a value of 0 will completely suppress the enum
1131 # By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
1142 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
1188 # When the SEARCHENGINE tag is enabled doxygen will generate a search box
1198 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1200 # using Javascript. Doxygen will generate the search PHP script and index
1212 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
1217 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1218 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1219 # put in front of it. If left blank `latex' will be used as the default path.
1224 # invoked. If left blank `latex' will be used as the default command name.
1232 # generate index for LaTeX. If left blank `makeindex' will be used as the
1245 # executive. If left blank a4wide will be used.
1256 # the first chapter. If it is left blank doxygen will generate a
1263 # the last chapter. If it is left blank doxygen will generate a
1269 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
1275 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1281 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1282 # command to the generated LaTeX files. This will instruct LaTeX to keep
1288 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
1294 # If LATEX_SOURCE_CODE is set to YES then doxygen will include
1311 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1317 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1318 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1319 # put in front of it. If left blank `rtf' will be used as the default path.
1330 # will contain hyperlink fields. The RTF file will
1353 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1358 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
1359 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1360 # put in front of it. If left blank `man' will be used as the default path.
1370 # then it will generate one additional man file for each entity
1381 # If the GENERATE_XML tag is set to YES Doxygen will
1387 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
1388 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1389 # put in front of it. If left blank `xml' will be used as the default path.
1405 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1408 # enabling this will significantly increase the size of the XML output.
1416 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1428 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
1436 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1442 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1447 # tag is set to NO the size of the Perl module output will be much smaller
1448 # and Perl will parse it just the same.
1463 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1469 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1471 # compilation will be performed. Macro expansion can be done in a controlled
1483 # pointed to by INCLUDE_PATH will be searched when a #include is found.
1495 # directories. If left blank, the patterns specified with FILE_PATTERNS will
1512 # The macro definition that is found in the sources will be used.
1520 # doxygen's preprocessor will remove all references to function-like macros
1522 # semicolon, because these will confuse the parser if not removed.
1549 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1554 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1556 # will be listed.
1560 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1561 # in the modules index. If set to NO, only the current project's groups will
1575 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1584 # command. Doxygen will then run the mscgen tool (see
1592 # If set to YES, the inheritance and collaboration graphs will hide
1598 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1606 # allowed to run in parallel. When set to 0 (the default) doxygen will
1613 # By default doxygen will use the Helvetica font for all dot files that
1627 # By default doxygen will tell dot to use the Helvetica font.
1634 # will generate a graph for each documented class showing the direct and
1635 # indirect inheritance relations. Setting this tag to YES will force the
1641 # will generate a graph for each documented class showing the direct and
1648 # will generate a graph for groups, showing the direct groups dependencies
1652 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1658 # If set to YES, the inheritance and collaboration graphs will show the
1664 # tags are set to YES then doxygen will generate a graph for each documented
1671 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1678 # doxygen will generate a call dependency graph for every global function
1679 # or class method. Note that enabling this option will significantly increase
1680 # the time of a run. So in most cases it will be better to enable call graphs
1686 # doxygen will generate a caller dependency graph for every global function
1687 # or class method. Note that enabling this option will significantly increase
1688 # the time of a run. So in most cases it will be better to enable caller
1694 # will generate a graphical hierarchy of all classes instead of a textual one.
1699 # then doxygen will show the dependencies a directory has on other directories
1707 # If left blank png will be used. If you choose svg you need to set
1740 # nodes that will be shown in the graph. If the number of nodes in a graph
1741 # becomes larger than this value, doxygen will truncate the graph, which is
1744 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1751 # from the root by following a path via at most 3 edges will be shown. Nodes
1752 # that lay further from the root node will be omitted. Note that setting this
1774 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1780 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will