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
45 PROJECT_NAME = "Zephyr API Documentation"
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
73 # into which the generated documentation will be written. If a relative path is
110 # documentation generated by Doxygen is written. Doxygen will use this
126 # documentation (similar to Javadoc). Set to NO to disable this.
159 # inherited members of a class in the documentation of that class as if those
186 # path mentioned in the documentation of a class, which tells the reader which
243 # documentation blocks is shown as Doxygen documentation.
249 # documentation from any documented member that it re-implements.
255 # page for each member. If set to NO, the documentation of a member will be part
268 # the documentation. An alias has the form:
273 # documentation, which will result in a user-defined paragraph with heading
360 # documentation. See https://daringfireball.net/projects/markdown/ for details.
389 # classes, or namespaces to their corresponding documentation. Such a link can
422 # Doxygen to replace the get and set methods by a property in the documentation.
430 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
431 # tag is set to YES then Doxygen will reuse the documentation of the first
467 # the documentation of the scope in which they are defined (i.e. file,
468 # namespace, or group documentation), provided this scope is documented. If set
477 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
525 # documentation are documented, even if no documentation was available. Private
535 # be included in the documentation.
541 # methods of a class will be included in the documentation.
547 # scope will be included in the documentation.
553 # included in the documentation.
559 # locally in source files will be included in the documentation. If set to NO,
568 # included in the documentation. If set to NO, only methods in the interface are
575 # extracted and appear in the documentation as a namespace called
592 # members will be included in the various overviews, but no documentation
609 # documentation.
615 # documentation blocks found inside the body of a function. If set to NO, these
616 # blocks will be appended to the function's detailed documentation block.
621 # The INTERNAL_DOCS tag determines if documentation that is typed after a
622 # \internal command is included. If the tag is set to NO then the documentation
623 # will be excluded. Set it to YES to include the internal documentation.
646 # their full class and namespace scopes in the documentation. If set to YES, the
659 # If the SHOW_HEADERFILE tag is set to YES then the documentation for a class
666 # the files that are included by a file in the documentation of that file.
672 # grouped member an include statement to the documentation, telling the reader
679 # files with double quotes in the documentation rather than with sharp brackets.
685 # documentation for inline members.
691 # (detailed) documentation of file and class members alphabetically by member
706 # (brief and detailed) documentation of class members so that constructors and
710 # member documentation.
712 # detailed member documentation.
745 # list. This list is created by putting \todo commands in the documentation.
751 # list. This list is created by putting \test commands in the documentation.
757 # list. This list is created by putting \bug commands in the documentation.
764 # the documentation.
769 # The ENABLED_SECTIONS tag can be used to enable conditional documentation
777 # documentation. If the initializer consists of more lines than specified here
781 # documentation regardless of this setting.
787 # the bottom of the documentation of classes and structs. If set to YES, the
788 # list will mention the files that were used to generate the documentation.
813 # version. For an example see the documentation.
872 # Tip: Turn warnings on while writing the documentation.
885 # potential errors in the documentation, such as documenting some parameters in
893 # function parameter documentation. If set to NO, Doxygen will accept that some
894 # parameters have no documentation without warning.
900 # are documented, but have no documentation for their parameters or return
902 # documentation, but not about the absence of documentation. If EXTRACT_ALL is
987 # documentation (see:
1091 # that contain images that are to be included in the documentation (see the
1181 # documentation.
1208 # link to the documentation.
1215 # brief description and links to the definition and documentation. Since this
1352 # of the possible markers and block names see the documentation.
1392 # documentation.
1455 # documentation will contain a main index with vertical navigation menus that
1466 # documentation will contain sections that can be hidden and shown after the
1517 # create a documentation set, Doxygen will generate a Makefile in the HTML
1520 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1528 # This tag determines the name of the docset feed. A documentation feed provides
1529 # an umbrella under which multiple documentation sets from a single provider
1536 # This tag determines the URL of the docset feed. A documentation feed provides
1537 # an umbrella under which multiple documentation sets from a single provider
1543 # This tag specifies a string that should uniquely identify the documentation
1552 # the documentation publisher. This should be a reverse domain-name style
1553 # string, e.g. com.mycompany.MyDocSet.documentation.
1559 # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1580 # words in the documentation. The HTML workshop also contains a viewer for
1624 # the table of contents of the HTML help documentation and to the tree view.
1631 # generated documentation will be placed on the server by the user during the
1632 # deployment of the documentation. The generated sitemap is called sitemap.xml
1643 # (.qch) of the generated HTML documentation.
1718 # name. Each documentation set should have its own identifier.
1765 # Doxygen will group on one line in the generated HTML documentation.
1813 # the HTML documentation. When you change the font size after a successful
1896 # example see the documentation.
1983 # to a relative location where the documentation can be found. The format is:
2079 # description of the possible markers and block names see the documentation.
2126 # files. Set this option to YES, to get a higher quality PDF documentation.
2285 # captures the structure of the code including all documentation.
2338 # the structure of the code including all documentation. Note that this feature
2375 # file that captures the structure of the code including all documentation.
2554 # file the location of the external documentation should be added. The format of
2560 # section "Linking to external documentation" for more information about the use
2570 # external documentation" for more information about the usage of tag files.
2639 # href=https://graphviz.org/doc/info/arrows.html>Complete documentation about
2826 # output formats in the documentation of the dot tool (Graphviz (see:
2858 # contain dot files that are included in the documentation (see the \dotfile
2864 # You can include diagrams made with dia in Doxygen documentation. Doxygen will
2865 # then run dia to produce the diagram and insert it in the documentation. The
2872 # contain dia files that are included in the documentation (see the \diafile
2958 # contain msc files that are included in the documentation (see the \mscfile