Lines Matching full:documentation
3 # This file describes the settings to be used by the documentation system
41 # project for which the documentation is generated. This name is used in the
48 # could be handy for archiving the generated documentation or if some version
60 # in the documentation. The maximum height of the logo should not exceed 55
67 # into which the generated documentation will be written. If a relative path is
104 # documentation generated by doxygen is written. Doxygen will use this
120 # documentation (similar to Javadoc). Set to NO to disable this.
153 # inherited members of a class in the documentation of that class as if those
180 # path mentioned in the documentation of a class, which tells the reader which
237 # documentation blocks is shown as doxygen documentation.
243 # documentation from any documented member that it re-implements.
249 # page for each member. If set to NO, the documentation of a member will be part
262 # the documentation. An alias has the form:
267 # documentation, which will result in a user-defined paragraph with heading
340 # documentation. See https://daringfireball.net/projects/markdown/ for details.
358 # classes, or namespaces to their corresponding documentation. Such a link can
391 # doxygen to replace the get and set methods by a property in the documentation.
399 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
400 # tag is set to YES then doxygen will reuse the documentation of the first
436 # the documentation of the scope in which they are defined (i.e. file,
437 # namespace, or group documentation), provided this scope is documented. If set
446 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
486 # documentation are documented, even if no documentation was available. Private
496 # be included in the documentation.
502 # methods of a class will be included in the documentation.
508 # scope will be included in the documentation.
514 # included in the documentation.
520 # locally in source files will be included in the documentation. If set to NO,
529 # included in the documentation. If set to NO, only methods in the interface are
536 # extracted and appear in the documentation as a namespace called
553 # members will be included in the various overviews, but no documentation
570 # documentation.
576 # documentation blocks found inside the body of a function. If set to NO, these
577 # blocks will be appended to the function's detailed documentation block.
582 # The INTERNAL_DOCS tag determines if documentation that is typed after a
583 # \internal command is included. If the tag is set to NO then the documentation
584 # will be excluded. Set it to YES to include the internal documentation.
607 # their full class and namespace scopes in the documentation. If set to YES, the
620 # If the SHOW_HEADERFILE tag is set to YES then the documentation for a class
627 # the files that are included by a file in the documentation of that file.
633 # grouped member an include statement to the documentation, telling the reader
640 # files with double quotes in the documentation rather than with sharp brackets.
646 # documentation for inline members.
652 # (detailed) documentation of file and class members alphabetically by member
667 # (brief and detailed) documentation of class members so that constructors and
671 # member documentation.
673 # detailed member documentation.
706 # list. This list is created by putting \todo commands in the documentation.
712 # list. This list is created by putting \test commands in the documentation.
718 # list. This list is created by putting \bug commands in the documentation.
725 # the documentation.
730 # The ENABLED_SECTIONS tag can be used to enable conditional documentation
738 # documentation. If the initializer consists of more lines than specified here
742 # documentation regardless of this setting.
748 # the bottom of the documentation of classes and structs. If set to YES, the
749 # list will mention the files that were used to generate the documentation.
774 # version. For an example see the documentation.
817 # Tip: Turn warnings on while writing the documentation.
830 # potential errors in the documentation, such as documenting some parameters in
838 # function parameter documentation. If set to NO, doxygen will accept that some
839 # parameters have no documentation without warning.
845 # are documented, but have no documentation for their parameters or return
847 # documentation, but not about the absence of documentation. If EXTRACT_ALL is
917 # documentation (see:
1017 # that contain images that are to be included in the documentation (see the
1106 # classes and enums directly into the documentation.
1133 # link to the documentation.
1140 # brief description and links to the definition and documentation. Since this
1237 # of the possible markers and block names see the documentation.
1277 # documentation.
1338 # documentation is up to date.
1345 # documentation will contain a main index with vertical navigation menus that
1356 # documentation will contain sections that can be hidden and shown after the
1380 # create a documentation set, doxygen will generate a Makefile in the HTML
1383 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1391 # This tag determines the name of the docset feed. A documentation feed provides
1392 # an umbrella under which multiple documentation sets from a single provider
1399 # This tag determines the URL of the docset feed. A documentation feed provides
1400 # an umbrella under which multiple documentation sets from a single provider
1406 # This tag specifies a string that should uniquely identify the documentation
1415 # the documentation publisher. This should be a reverse domain-name style
1416 # string, e.g. com.mycompany.MyDocSet.documentation.
1422 # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1443 # words in the documentation. The HTML workshop also contains a viewer for
1487 # the table of contents of the HTML help documentation and to the tree view.
1496 # (.qch) of the generated HTML documentation.
1571 # name. Each documentation set should have its own identifier.
1618 # doxygen will group on one line in the generated HTML documentation.
1660 # the HTML documentation. When you change the font size after a successful
1743 # example see the documentation.
1830 # to a relative location where the documentation can be found. The format is:
1926 # description of the possible markers and block names see the documentation.
1973 # files. Set this option to YES, to get a higher quality PDF documentation.
2125 # captures the structure of the code including all documentation.
2178 # the structure of the code including all documentation. Note that this feature
2189 # file that captures the structure of the code including all documentation.
2308 # file the location of the external documentation should be added. The format of
2314 # section "Linking to external documentation" for more information about the use
2324 # external documentation" for more information about the usage of tag files.
2353 # You can include diagrams made with dia in doxygen documentation. Doxygen will
2354 # then run dia to produce the diagram and insert it in the documentation. The
2400 # href=https://graphviz.org/doc/info/arrows.html>Complete documentation about
2567 # output formats in the documentation of the dot tool (Graphviz (see:
2599 # contain dot files that are included in the documentation (see the \dotfile
2606 # contain msc files that are included in the documentation (see the \mscfile
2612 # contain dia files that are included in the documentation (see the \diafile