• Home
  • Raw
  • Download

Lines Matching refs:will

6 # All text after a hash (#) is considered a comment and will be ignored
30 # base path where the generated documentation will be put.
31 # If a relative path is entered, it will be relative to the location
32 # where doxygen was started. If left blank the current directory will be used.
36 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
38 # format and will distribute the generated files over these directories.
46 # documentation generated by doxygen is written. Doxygen will use this
57 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
64 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
67 # brief descriptions will be completely suppressed.
73 # in this list, if found as the leading text of the brief description, will be
83 # Doxygen will generate a detailed section even if there is only a brief
88 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited
91 # the base classes will not be shown.
95 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
97 # to NO the shortest path that makes the file name unique will be used.
119 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
126 # will interpret the first line (until the first dot) of a JavaDoc-style
128 # comments will behave just like the Qt-style comments (thus requiring an
142 # will output the detailed description near the top, like JavaDoc.
155 # tag is set to YES, then doxygen will reuse the documentation of the first
168 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
170 # will result in a user-defined paragraph with heading "Side Effects:".
176 # only. Doxygen will then generate output that is more tailored for C.
177 # For instance, some of the names that are used will be different. The list
178 # of all members will be omitted, etc.
183 # only. Doxygen will then generate output that is more tailored for Java.
184 # For instance, namespaces will be presented as packages, qualified scopes
185 # will look different, etc.
201 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
203 # Private class members and static file members will be hidden unless
209 # will be included in the documentation.
214 # will be included in the documentation.
219 # defined locally in source files will be included in the documentation.
231 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
233 # If set to NO (the default) these members will be included in the
239 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
241 # If set to NO (the default) these classes will be included in the various
246 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
248 # If set to NO (the default) these declarations will be included in the
253 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
255 # If set to NO (the default) these blocks will be appended to the
262 # to NO (the default) then the documentation will be excluded.
267 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
276 # will show members with their full class and namespace scopes in the
277 # documentation. If set to YES the scope will be hidden.
282 # will put a list of the files that are included by a file in the documentation
293 # will sort the (detailed) documentation of file and class members
294 # alphabetically by member name. If set to NO the members will appear in
299 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
301 # by member name. If set to NO (the default) the members will appear in
306 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
308 # NO (the default), the class list will be sorted only by class name,
348 # here it will be hidden. Use a value of 0 to hide initializers completely.
357 # list will mention the files that were used to generate the documentation.
362 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
384 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
385 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
391 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
401 # tags, which will be replaced by the file and line number from which the
470 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
484 # invoke to filter for each input file. Doxygen will invoke the filter program
487 # input file. Doxygen will then use the output that the filter program writes
488 # to standard output. If FILTER_PATTERNS is specified, this tag will be
494 # basis. Doxygen will compare the file name with each pattern and apply the
503 # INPUT_FILTER) will be used to filter the input files when producing source
512 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
513 # be generated. Documented entities will be cross-referenced with these sources.
519 # Setting the INLINE_SOURCES tag to YES will include the body
524 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
526 # fragments. Normal C and C++ comments will always remain visible.
532 # functions referencing it will be listed.
538 # called/used by that function will be listed.
543 # will generate a verbatim copy of the header file for each class for
553 # of all compounds will be generated. Enable this if the project
560 # in which this list will be split (can be a number in the range [1..20])
565 # classes will be put under the same header in the alphabetical index.
575 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
580 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
581 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
582 # put in front of it. If left blank `html' will be used as the default path.
588 # doxygen will generate files with .html extension.
593 # each generated HTML page. If it is left blank doxygen will generate a
600 # each generated HTML page. If it is left blank doxygen will generate a
608 # will generate a default style sheet. Note that doxygen will try to copy
610 # stylesheet in the HTML output directory as well, or it will be erased!
615 # files or namespaces will be aligned in HTML using tables. If set to
616 # NO a bullet list will be used.
621 # will be generated that can be used as input for tools like the
636 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
665 # that doxygen will group on one line in the generated HTML documentation.
669 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
688 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
693 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
694 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
695 # put in front of it. If left blank `latex' will be used as the default path.
700 # invoked. If left blank `latex' will be used as the default command name.
705 # generate index for LaTeX. If left blank `makeindex' will be used as the
718 # executive. If left blank a4wide will be used.
729 # the first chapter. If it is left blank doxygen will generate a
735 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
741 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
747 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
748 # command to the generated LaTeX files. This will instruct LaTeX to keep
754 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
764 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
770 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
771 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
772 # put in front of it. If left blank `rtf' will be used as the default path.
783 # will contain hyperlink fields. The RTF file will
806 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
811 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
812 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
813 # put in front of it. If left blank `man' will be used as the default path.
823 # then it will generate one additional man file for each entity
834 # If the GENERATE_XML tag is set to YES Doxygen will
840 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
841 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
842 # put in front of it. If left blank `xml' will be used as the default path.
858 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
861 # enabling this will significantly increase the size of the XML output.
869 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
881 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
889 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
895 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
898 # tag is set to NO the size of the Perl module output will be much smaller
899 # and Perl will parse it just the same.
914 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
920 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
922 # compilation will be performed. Macro expansion can be done in a controlled
934 # in the INCLUDE_PATH (see below) will be search if a #include is found.
946 # directories. If left blank, the patterns specified with FILE_PATTERNS will
963 # The macro definition that is found in the sources will be used.
969 # doxygen's preprocessor will remove all function-like macros that are alone
971 # function macros are typically used for boiler-plate code, and will confuse the
997 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1002 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1004 # will be listed.
1008 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1009 # in the modules index. If set to NO, only the current project's groups will
1023 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1031 # If set to YES, the inheritance and collaboration graphs will hide
1037 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1045 # will generate a graph for each documented class showing the direct and
1046 # indirect inheritance relations. Setting this tag to YES will force the
1052 # will generate a graph for each documented class showing the direct and
1058 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1064 # If set to YES, the inheritance and collaboration graphs will show the
1070 # tags are set to YES then doxygen will generate a graph for each documented
1077 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1083 # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
1085 # Note that enabling this option will significantly increase the time of a run.
1086 # So in most cases it will be better to enable call graphs for selected
1092 # will graphical hierarchy of all classes instead of a textual one.
1098 # If left blank png will be used.
1115 # from the root by following a path via at most 3 edges will be shown. Nodes that
1116 # lay further from the root node will be omitted. Note that setting this option to
1124 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1130 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1141 # used. If set to NO the values of all tags below this one will be ignored.