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 
406 # will sort the (detailed) documentation of file and class members 
407 # alphabetically by member name. If set to NO the members will appear in 
412 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 
414 # by member name. If set to NO (the default) the members will appear in 
420 # will sort the (brief and detailed) documentation of class members so that
422 # the constructors will appear in the respective orders defined by
424 # This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
429 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the 
431 # the group names will appear in their defined order.
435 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 
437 # NO (the default), the class list will be sorted only by class name, 
477 # here it will be hidden. Use a value of 0 to hide initializers completely. 
486 # list will mention the files that were used to generate the documentation.
491 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy 
497 # This will remove the Files entry from the Quick Index and from the 
503 # Namespaces page.  This will remove the Namespaces entry from the Quick Index 
510 # the version control system). Doxygen will invoke the program by executing (via 
518 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by 
522 # file name after the option, if omitted DoxygenLayout.xml will be used as the name 
542 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 
543 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will 
548 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 
557 # or return value. If set to NO (the default) doxygen will only warn about 
565 # tags, which will be replaced by the file and line number from which the 
567 # $version, which will be replaced by the version of the file (if it could 
683 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 
697 # invoke to filter for each input file. Doxygen will invoke the filter program 
700 # input file. Doxygen will then use the output that the filter program writes 
701 # to standard output.  If FILTER_PATTERNS is specified, this tag will be 
707 # basis.  Doxygen will compare the file name with each pattern and apply the 
716 # INPUT_FILTER) will be used to filter the input files when producing source 
725 # If the SOURCE_BROWSER tag is set to YES then a list of source files will 
726 # be generated. Documented entities will be cross-referenced with these sources. 
732 # Setting the INLINE_SOURCES tag to YES will include the body 
737 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 
739 # fragments. Normal C and C++ comments will always remain visible.
745 # functions referencing it will be listed.
751 # called/used by that function will be listed.
757 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will 
758 # link to the source code.  Otherwise they will link to the documentation.
763 # will point to the HTML generated by the htags(1) tool instead of doxygen 
766 # will need version 4.8.6 or higher.
771 # will generate a verbatim copy of the header file for each class for 
781 # of all compounds will be generated. Enable this if the project 
788 # in which this list will be split (can be a number in the range [1..20])
793 # classes will be put under the same header in the alphabetical index. 
803 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will 
808 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 
809 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
810 # put in front of it. If left blank `html' will be used as the default path.
816 # doxygen will generate files with .html extension.
821 # each generated HTML page. If it is left blank doxygen will generate a 
827 # each generated HTML page. If it is left blank doxygen will generate a 
835 # will generate a default style sheet. Note that doxygen will try to copy 
837 # stylesheet in the HTML output directory as well, or it will be erased!
842 # files or namespaces will be aligned in HTML using tables. If set to 
843 # NO a bullet list will be used.
848 # documentation will contain sections that can be hidden and shown after the 
856 # will be generated that can be used as input for Apple's Xcode 3 
858 # To create a documentation set, doxygen will generate a Makefile in the 
859 # HTML output directory. Running make will produce the docset in that 
860 # directory and running "make install" will install the docset in 
861 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find 
877 # will append .docset to the name.
882 # will be generated that can be used as input for tools like the 
897 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 
926 # are set, an additional index file will be generated that can be used as input for 
969 # If non-empty doxygen will try to run qhelpgenerator on the generated 
981 # that doxygen will group on one line in the generated HTML documentation.
987 # If the tag value is set to YES, a side panel will be generated 
995 # By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories, 
1014 # When the SEARCHENGINE tag is enable doxygen will generate a search box
1027 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 
1032 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 
1033 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
1034 # put in front of it. If left blank `latex' will be used as the default path.
1039 # invoked. If left blank `latex' will be used as the default command name.
1044 # generate index for LaTeX. If left blank `makeindex' will be used as the 
1057 # executive. If left blank a4wide will be used.
1068 # the first chapter. If it is left blank doxygen will generate a 
1074 # is prepared for conversion to pdf (using ps2pdf). The pdf file will 
1080 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 
1086 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 
1087 # command to the generated LaTeX files. This will instruct LaTeX to keep 
1093 # If LATEX_HIDE_INDICES is set to YES then doxygen will not 
1099 # If LATEX_SOURCE_CODE is set to YES then doxygen will include
1110 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 
1116 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 
1117 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
1118 # put in front of it. If left blank `rtf' will be used as the default path.
1129 # will contain hyperlink fields. The RTF file will 
1152 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will 
1157 # The MAN_OUTPUT tag is used to specify where the man pages will be put. 
1158 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
1159 # put in front of it. If left blank `man' will be used as the default path.
1169 # then it will generate one additional man file for each entity 
1180 # If the GENERATE_XML tag is set to YES Doxygen will 
1186 # The XML_OUTPUT tag is used to specify where the XML pages will be put. 
1187 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
1188 # put in front of it. If left blank `xml' will be used as the default path.
1204 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will 
1207 # enabling this will significantly increase the size of the XML output.
1215 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 
1227 # If the GENERATE_PERLMOD tag is set to YES Doxygen will 
1235 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate 
1241 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 
1244 # tag is set to NO the size of the Perl module output will be much smaller 
1245 # and Perl will parse it just the same.
1260 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 
1266 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 
1268 # compilation will be performed. Macro expansion can be done in a controlled 
1280 # in the INCLUDE_PATH (see below) will be search if a #include is found.
1292 # directories. If left blank, the patterns specified with FILE_PATTERNS will 
1309 # The macro definition that is found in the sources will be used. 
1316 # doxygen's preprocessor will remove all function-like macros that are alone 
1318 # function macros are typically used for boiler-plate code, and will confuse 
1344 # When a file name is specified after GENERATE_TAGFILE, doxygen will create 
1349 # If the ALLEXTERNALS tag is set to YES all external classes will be listed 
1351 # will be listed.
1355 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 
1356 # in the modules index. If set to NO, only the current project's groups will 
1370 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 
1380 # command. Doxygen will then run the mscgen tool (see 
1388 # If set to YES, the inheritance and collaboration graphs will hide 
1394 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 
1401 # By default doxygen will write a font called FreeSans.ttf to the output 
1417 # By default doxygen will tell dot to use the output directory to look for the 
1418 # FreeSans.ttf font (which doxygen will put there itself). If you specify a 
1425 # will generate a graph for each documented class showing the direct and 
1426 # indirect inheritance relations. Setting this tag to YES will force the 
1432 # will generate a graph for each documented class showing the direct and 
1439 # will generate a graph for groups, showing the direct groups dependencies
1443 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and 
1449 # If set to YES, the inheritance and collaboration graphs will show the 
1455 # tags are set to YES then doxygen will generate a graph for each documented 
1462 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each 
1469 # doxygen will generate a call dependency graph for every global function 
1470 # or class method. Note that enabling this option will significantly increase 
1471 # the time of a run. So in most cases it will be better to enable call graphs 
1477 # doxygen will generate a caller dependency graph for every global function 
1478 # or class method. Note that enabling this option will significantly increase 
1479 # the time of a run. So in most cases it will be better to enable caller 
1485 # will graphical hierarchy of all classes instead of a textual one.
1490 # then doxygen will show the dependencies a directory has on other directories 
1498 # If left blank png will be used.
1514 # nodes that will be shown in the graph. If the number of nodes in a graph 
1515 # becomes larger than this value, doxygen will truncate the graph, which is 
1518 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note 
1525 # from the root by following a path via at most 3 edges will be shown. Nodes 
1526 # that lay further from the root node will be omitted. Note that setting this 
1548 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 
1554 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will