Lines Matching refs:of
7 # in front of the TAG it is preceding .
21 # text before the first occurrence of this tag. Doxygen uses libiconv (or the
23 # http://www.gnu.org/software/libiconv for the list of possible encodings.
27 # The PROJECT_NAME tag is a single word (or sequence of words) that should
40 # for a project that appears at the top of each page and should give viewer
41 # a quick idea about the purpose of the project. Keep the description short.
46 # included in the documentation. The maximum height of the logo should not
60 # 4096 sub-directories (in 2 levels) under the output directory of each output
62 # Enabling this option can be useful when feeding doxygen a huge amount of
89 # the brief description of a member or function before the detailed description.
97 # in this list, if found as the leading text of the brief description, will be
101 # replaced with the name of the entity): "The $name class" "The $name widget"
124 # inherited members of a class in the documentation of that class as if those
126 # operators of the base classes will not be shown.
137 # can be used to strip a user-defined part of the path. Stripping is
138 # only done if one of the specified strings matches the left-hand part of
147 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
148 # the path mentioned in the documentation of a class, which tells
150 # If left blank only the name of the header file containing the class
163 # will interpret the first line (until the first dot) of a JavaDoc-style
171 # interpret the first line (until the first dot) of a Qt-style
179 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
193 # a new page for each member. If set to NO, the documentation of a member will
194 # be part of the file/class/namespace that contains it.
198 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
203 # This tag can be used to specify a number of aliases that acts
208 # You can put \n's in the value part of an alias to insert newlines.
212 # This tag can be used to specify a number of word-keyword mappings (TCL only).
219 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
221 # For instance, some of the names that are used will be different. The list
222 # of all members will be omitted, etc.
226 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
233 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
239 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
245 # Doxygen selects the parser to use depending on the extension of the files it
249 # and language is one of the parsers supported by doxygen: IDL, Java,
261 # The output of markdown processing is further processed by doxygen, so you
263 # Disable only in case of backward compatibilities issues.
269 # be prevented in individual cases by by putting a % sign in front of the word
288 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
290 # instead of private inheritance when no explicit protection keyword is present.
304 # tag is set to YES, then doxygen will reuse the documentation of the first
305 # member in the group (if any) for the other members of the group. By default
306 # all members of a group must be documented explicitly.
310 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
311 # the same type (for instance a group of public functions) to be put as a
312 # subgroup of that type (e.g. under the Public Functions section). Set it to
320 # @ingroup) instead of on a separate page (for HTML and Man pages) or
327 # inline in the documentation of the scope in which they are defined (i.e. file,
334 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
335 # is documented as struct, union, or enum with the name of the typedef. So
337 # with name TypeT. When disabled the typedef will appear as a member of a file,
344 # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
347 # the code, doxygen keeps a cache of pre-resolved symbols. If the cache is too
350 # range is 0..9, the default is 0, corresponding to a cache size of 2^16 = 65536
366 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
376 # If the EXTRACT_STATIC tag is set to YES all static members of a file
394 # If this flag is set to YES, the members of anonymous namespaces will be
397 # name of the file that contains the anonymous namespace. By default
403 # undocumented members of documented classes, files or namespaces.
425 # documentation blocks found inside the body of a function.
453 # will put a list of the files that are included by a file in the documentation
454 # of that file.
470 # will sort the (detailed) documentation of file and class members
477 # brief documentation of file, namespace and class members alphabetically
484 # will sort the (brief and detailed) documentation of class members so that
494 # hierarchy of group names into alphabetical order. If set to NO (the default)
510 # do proper type resolution of all parameters of a function it will reject a
511 # match between the prototype and the implementation of a member function even
548 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
549 # the initial value of a variable or macro consists of for it to appear in
550 # the documentation. If the initializer consists of more lines than specified
551 # here it will be hidden. Use a value of 0 to hide initializers completely.
552 # The appearance of the initializer of individual variables and macros in the
554 # command in the documentation regardless of this setting.
558 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
559 # at the bottom of the documentation of classes and structs. If set to YES the
564 # Set the SHOW_FILES tag to NO to disable the generation of the Files page.
570 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the
580 # popen()) the command <command> <input-file>, where <command> is the value of
581 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
588 # by doxygen. The layout file controls the global structure of the generated
592 # DoxygenLayout.xml will be used as the name of the layout file.
597 # containing the references data. This must be a list of .bib files. The
601 # of the bibliography can be controlled using LATEX_BIB_STYLE. To use this
638 # wrong or incomplete parameter documentation, but not about the absence of
643 # The WARN_FORMAT tag determines the format of the warning messages that
647 # $version, which will be replaced by the version of the file (if it could
669 # This tag can be used to specify the character encoding of the source files
673 # the list of possible encodings.
677 # If the value of the INPUT tag contains directories, you can use the
707 # If the value of the INPUT tag contains directories, you can use the
729 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
738 # commands irrespective of the value of the RECURSIVE tag.
752 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
766 # The filters are a list of the form:
769 # non of the patterns match the file name, INPUT_FILTER is applied.
787 # If the USE_MD_FILE_AS_MAINPAGE tag refers to the name of a markdown file that
788 # is part of the input, its contents will be placed on the main page
798 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
800 # Note: To get rid of all source code in the generated output, make sure also
806 # of functions and classes directly in the documentation.
837 # will point to the HTML generated by the htags(1) tool instead of doxygen
838 # built-in source browser. The htags tool is part of GNU's global source
845 # will generate a verbatim copy of the header file for each class for
855 # of all compounds will be generated. Enable this if the project
856 # contains a lot of classes, structs, unions or interfaces.
861 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
883 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
884 # put in front of it. If left blank `html' will be used as the default path.
897 # for the proper inclusion of any scripts and style sheets that doxygen
902 # have to redo this when upgrading to a newer version of doxygen or when
903 # changing the value of configuration settings such as GENERATE_TREEVIEW!
915 # fine-tune the look of the HTML output. If left blank doxygen will
917 # HTML_EXTRA_STYLESHEET instead of this one, as it is more robust and this
941 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
951 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
952 # the colors in the HTML output. For a value of 0 the output will use
953 # grayscales only. A value of 255 will produce the most vivid colors.
958 # the luminance component of the colors in the HTML output. Values below
961 # so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
966 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
968 # this to NO can help when comparing the output of multiple runs.
978 # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of
981 # the tree to such a level that at most the specified number of entries are
983 # So setting the number of entries 1 will produce a full collapsed tree by
984 # default. 0 is a special value representing an infinite number of entries
1002 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
1029 # of the generated HTML documentation.
1034 # be used to specify the file name of the resulting .chm file. You
1035 # can add a path in front of the file if the result should not be
1041 # be used to specify the location (absolute path including file name) of
1060 # controls whether a binary table of contents is generated (YES) or a
1061 # normal table of contents (NO) in the .chm file.
1066 # to the contents of the HTML help documentation and to the tree view.
1073 # Qt Compressed Help (.qch) of the generated HTML documentation.
1078 # be used to specify the file name of the resulting .qch file.
1095 # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
1101 # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
1108 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1117 # be used to specify the location of Qt's qhelpgenerator.
1126 # menu in Eclipse, the contents of the directory containing the HTML and XML
1127 # files needs to be copied into the plugins directory of eclipse. The name of
1141 # at top of each HTML page. The value NO (the default) enables the index and
1160 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
1162 # documentation. Note that a value of 0 will completely suppress the enum
1168 # used to set the initial width (in pixels) of the frame in which the tree
1178 # Use this tag to change the font size of Latex formulas included
1196 # rendering instead of using prerendered bitmaps. Use this if you do not
1218 # copy of MathJax from http://www.mathjax.org before deployment.
1228 # pieces of code that will be used on startup of the MathJax code.
1243 # implemented using a web server instead of a web client using Javascript.
1244 # There are two flavours of web server based search depending on the
1272 # SEARCHDATA_FILE tag the name of this file can be specified.
1287 # of to a relative location where the documentation can be found.
1302 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1303 # put in front of it. If left blank `latex' will be used as the default path.
1333 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1361 # contain links (just like the HTML output) instead of page references
1366 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1374 # running if errors occur, instead of asking the user for help.
1409 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1410 # put in front of it. If left blank `rtf' will be used as the default path.
1422 # contain links (just like the HTML output) instead of page references.
1430 # config file, i.e. a series of assignments. You only have to provide
1435 # Set optional variables used in the generation of an rtf document.
1450 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1451 # put in front of it. If left blank `man' will be used as the default path.
1473 # generate an XML file that captures the structure of
1479 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1480 # put in front of it. If left blank `xml' will be used as the default path.
1486 # syntax of the XML files.
1492 # syntax of the XML files.
1499 # enabling this will significantly increase the size of the XML output.
1513 # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
1514 # front of it. If left blank docbook will be used as the default path.
1524 # that captures the structure of the code including all
1535 # generate a Perl module file that captures the structure of
1553 # tag is set to NO the size of the Perl module output will be much smaller
1558 # The names of the make variables in the generated doxyrules.make file
1607 # are defined before the preprocessor is started (similar to the -D option of
1608 # gcc). The argument of the tag is a list of macros of the form: name
1612 # instead of the = operator.
1628 # this tag can be used to specify a list of macro names that should be expanded.
1647 # tag file the location of the external documentation should be added. The
1648 # format of a tag file without this location is as follows:
1684 # The PERL_PATH should be the absolute path and name of the perl script
1685 # interpreter (i.e. the result of `which perl').
1717 # available from the path. This tool is part of Graphviz, a graph visualization
1723 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
1725 # base this on the number of processors available in the system. You can set it
1740 # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1761 # class references variables) of the class with other documented classes.
1779 # threshold limits the number of items for each type to make the size more
1792 # file showing the direct and indirect include dependencies of the file with
1807 # the time of a run. So in most cases it will be better to enable call graphs
1815 # the time of a run. So in most cases it will be better to enable caller
1821 # will generate a graphical hierarchy of all classes instead of a textual one.
1832 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1841 # enable generation of interactive SVG images that allow zooming and panning.
1845 # visible. Older versions of IE do not have SVG support.
1866 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1867 # nodes that will be shown in the graph. If the number of nodes in a graph
1870 # number of direct children of the root node in a graph is already larger than
1872 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1876 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1877 # graphs generated by dot. A depth value of 3 means that only nodes reachable
1881 # code bases. Also note that the size of a graph can be further restricted by
1882 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1888 # seem to support this out of the box. Warning: Depending on the platform used,
1889 # enabling this option may lead to badly anti-aliased labels on the edges of
1896 # makes dot run faster, but since only newer versions of dot (>1.8.10)
1902 # generate a legend page explaining the meaning of the various boxes and