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
65 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
72 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
75 # brief descriptions will be completely suppressed.
81 # in this list, if found as the leading text of the brief description, will be
102 # Doxygen will generate a detailed section even if there is only a brief
107 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
110 # operators of the base classes will not be shown.
114 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
116 # to NO the shortest path that makes the file name unique will be used.
138 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
145 # will interpret the first line (until the first dot) of a JavaDoc-style
147 # comments will behave just like regular Qt-style comments
152 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
155 # will behave just like regular Qt-style comments (thus requiring
174 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
175 # a new page for each member. If set to NO, the documentation of a member will
187 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
189 # will result in a user-defined paragraph with heading "Side Effects:".
195 # sources only. Doxygen will then generate output that is more tailored for C.
196 # For instance, some of the names that are used will be different. The list
197 # of all members will be omitted, etc.
202 # sources only. Doxygen will then generate output that is more tailored for
203 # Java. For instance, namespaces will be presented as packages, qualified
204 # scopes will look different, etc.
209 # sources only. Doxygen will then generate output that is more tailored for
215 # sources. Doxygen will then generate output that is tailored for
247 # Doxygen will parse them like normal C++ but will assume all classes use public
254 # will make doxygen to replace the get and set methods by a property in the
255 # documentation. This will only work if the methods are indeed getting or
262 # tag is set to YES, then doxygen will reuse the documentation of the first
278 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
279 # with name TypeT. When disabled the typedef will appear as a member of a file,
280 # namespace, or class. And the struct will be named TypeS. This can typically
288 # When the cache is full, less often used symbols will be written to disk.
293 # If the system has enough physical memory increasing the cache will improve the
295 # a logarithmic scale so increasing the size by one will rougly double the
306 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
308 # Private class members and static file members will be hidden unless
314 # will be included in the documentation.
319 # will be included in the documentation.
324 # defined locally in source files will be included in the documentation.
336 # If this flag is set to YES, the members of anonymous namespaces will be
338 # 'anonymous_namespace{file}', where file will be replaced with the base
344 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
346 # If set to NO (the default) these members will be included in the
352 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
354 # If set to NO (the default) these classes will be included in the various
359 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
361 # If set to NO (the default) these declarations will be included in the
366 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
368 # If set to NO (the default) these blocks will be appended to the
375 # to NO (the default) then the documentation will be excluded.
380 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
389 # will show members with their full class and namespace scopes in the
390 # documentation. If set to YES the scope will be hidden.
395 # will put a list of the files that are included by a file in the documentation
401 # will list include files with double quotes in the documentation
412 # will sort the (detailed) documentation of file and class members
413 # alphabetically by member name. If set to NO the members will appear in
418 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
420 # by member name. If set to NO (the default) the members will appear in
426 # will sort the (brief and detailed) documentation of class members so that
428 # the constructors will appear in the respective orders defined by
430 # This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
435 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
437 # the group names will appear in their defined order.
441 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
443 # NO (the default), the class list will be sorted only by class name,
483 # here it will be hidden. Use a value of 0 to hide initializers completely.
492 # list will mention the files that were used to generate the documentation.
497 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
503 # This will remove the Files entry from the Quick Index and from the
509 # Namespaces page. This will remove the Namespaces entry from the Quick Index
516 # the version control system). Doxygen will invoke the program by executing (via
524 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
529 # DoxygenLayout.xml will be used as the name of the layout file.
548 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
549 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
554 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
563 # or return value. If set to NO (the default) doxygen will only warn about
571 # tags, which will be replaced by the file and line number from which the
573 # $version, which will be replaced by the version of the file (if it could
703 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
717 # invoke to filter for each input file. Doxygen will invoke the filter program
720 # input file. Doxygen will then use the output that the filter program writes
721 # to standard output. If FILTER_PATTERNS is specified, this tag will be
727 # basis. Doxygen will compare the file name with each pattern and apply the
736 # INPUT_FILTER) will be used to filter the input files when producing source
745 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
746 # be generated. Documented entities will be cross-referenced with these sources.
752 # Setting the INLINE_SOURCES tag to YES will include the body
757 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
759 # fragments. Normal C and C++ comments will always remain visible.
765 # functions referencing it will be listed.
771 # called/used by that function will be listed.
777 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
778 # link to the source code. Otherwise they will link to the documentation.
783 # will point to the HTML generated by the htags(1) tool instead of doxygen
786 # will need version 4.8.6 or higher.
791 # will generate a verbatim copy of the header file for each class for
801 # of all compounds will be generated. Enable this if the project
808 # in which this list will be split (can be a number in the range [1..20])
813 # classes will be put under the same header in the alphabetical index.
823 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
828 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
829 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
830 # put in front of it. If left blank `html' will be used as the default path.
836 # doxygen will generate files with .html extension.
841 # each generated HTML page. If it is left blank doxygen will generate a
847 # each generated HTML page. If it is left blank doxygen will generate a
855 # will generate a default style sheet. Note that doxygen will try to copy
857 # stylesheet in the HTML output directory as well, or it will be erased!
862 # Doxygen will adjust the colors in the stylesheet and background images
872 # the colors in the HTML output. For a value of 0 the output will use
873 # grayscales only. A value of 255 will produce the most vivid colors.
887 # page will contain the date and time when the page was generated. Setting
893 # files or namespaces will be aligned in HTML using tables. If set to
894 # NO a bullet list will be used.
899 # documentation will contain sections that can be hidden and shown after the
907 # will be generated that can be used as input for Apple's Xcode 3
909 # To create a documentation set, doxygen will generate a Makefile in the
910 # HTML output directory. Running make will produce the docset in that
911 # directory and running "make install" will install the docset in
912 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
929 # will append .docset to the name.
944 # will be generated that can be used as input for tools like the
959 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
988 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
1035 # If non-empty doxygen will try to run qhelpgenerator on the generated
1041 # will be generated, which together with the HTML files, form an Eclipse help
1064 # that doxygen will group on one line in the generated HTML documentation.
1070 # If the tag value is set to YES, a side panel will be generated
1078 # By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
1089 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
1110 # When the SEARCHENGINE tag is enabled doxygen will generate a search box
1120 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1122 # using Javascript. Doxygen will generate the search PHP script and index
1134 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
1139 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1140 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1141 # put in front of it. If left blank `latex' will be used as the default path.
1146 # invoked. If left blank `latex' will be used as the default command name.
1154 # generate index for LaTeX. If left blank `makeindex' will be used as the
1167 # executive. If left blank a4wide will be used.
1178 # the first chapter. If it is left blank doxygen will generate a
1184 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
1190 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1196 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1197 # command to the generated LaTeX files. This will instruct LaTeX to keep
1203 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
1209 # If LATEX_SOURCE_CODE is set to YES then doxygen will include
1220 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1226 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1227 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1228 # put in front of it. If left blank `rtf' will be used as the default path.
1239 # will contain hyperlink fields. The RTF file will
1262 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1267 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
1268 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1269 # put in front of it. If left blank `man' will be used as the default path.
1279 # then it will generate one additional man file for each entity
1290 # If the GENERATE_XML tag is set to YES Doxygen will
1296 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
1297 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1298 # put in front of it. If left blank `xml' will be used as the default path.
1314 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1317 # enabling this will significantly increase the size of the XML output.
1325 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1337 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
1345 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1351 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1354 # tag is set to NO the size of the Perl module output will be much smaller
1355 # and Perl will parse it just the same.
1370 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1376 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1378 # compilation will be performed. Macro expansion can be done in a controlled
1390 # in the INCLUDE_PATH (see below) will be search if a #include is found.
1402 # directories. If left blank, the patterns specified with FILE_PATTERNS will
1419 # The macro definition that is found in the sources will be used.
1425 # doxygen's preprocessor will remove all function-like macros that are alone
1427 # function macros are typically used for boiler-plate code, and will confuse
1453 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1458 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1460 # will be listed.
1464 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1465 # in the modules index. If set to NO, only the current project's groups will
1479 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1489 # command. Doxygen will then run the mscgen tool (see
1497 # If set to YES, the inheritance and collaboration graphs will hide
1503 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1511 # allowed to run in parallel. When set to 0 (the default) doxygen will
1518 # By default doxygen will write a font called FreeSans.ttf to the output
1534 # By default doxygen will tell dot to use the output directory to look for the
1535 # FreeSans.ttf font (which doxygen will put there itself). If you specify a
1542 # will generate a graph for each documented class showing the direct and
1543 # indirect inheritance relations. Setting this tag to YES will force the
1549 # will generate a graph for each documented class showing the direct and
1556 # will generate a graph for groups, showing the direct groups dependencies
1560 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1566 # If set to YES, the inheritance and collaboration graphs will show the
1572 # tags are set to YES then doxygen will generate a graph for each documented
1579 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1586 # doxygen will generate a call dependency graph for every global function
1587 # or class method. Note that enabling this option will significantly increase
1588 # the time of a run. So in most cases it will be better to enable call graphs
1594 # doxygen will generate a caller dependency graph for every global function
1595 # or class method. Note that enabling this option will significantly increase
1596 # the time of a run. So in most cases it will be better to enable caller
1602 # will graphical hierarchy of all classes instead of a textual one.
1607 # then doxygen will show the dependencies a directory has on other directories
1615 # If left blank png will be used.
1631 # nodes that will be shown in the graph. If the number of nodes in a graph
1632 # becomes larger than this value, doxygen will truncate the graph, which is
1635 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1642 # from the root by following a path via at most 3 edges will be shown. Nodes
1643 # that lay further from the root node will be omitted. Note that setting this
1665 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1671 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will