enum CXCommentKind
Description
Describes the type of the comment AST node (\c CXComment). A comment node can be considered block content (e. g., paragraph), inline content (plain text) or neither (the root AST node).
Declared at: clang/include/clang-c/Documentation.h:53
Enumerators
| Name | Value | Comment |
|---|---|---|
| CXComment_Null | 0 | Null comment. No AST node is constructed at the requested location because there is no text or a syntax error. |
| CXComment_Text | 1 | Plain text. Inline content. |
| CXComment_InlineCommand | 2 | A command with word-like arguments that is considered inline content.For example: \ c command. |
| CXComment_HTMLStartTag | 3 | HTML start tag with attributes (name-value pairs). Considered inline content.For example: |
| CXComment_HTMLEndTag | 4 | HTML end tag. Considered inline content.For example: |
| CXComment_Paragraph | 5 | A paragraph, contains inline comment. The paragraph itself is block content. |
| CXComment_BlockCommand | 6 | A command that has zero or more word-like arguments (number of word-like arguments depends on command name) and a paragraph as an argument. Block command is block content.Paragraph argument is also a child of the block command.For example: \has0 word-like arguments and a paragraph argument.AST nodes of special kinds that parser knows about (e. g., \ param command) have their own node kinds. |
| CXComment_ParamCommand | 7 | A \ param or \ arg command that describes the function parameter (name, passing direction, description).For example: \ param [in] ParamName description. |
| CXComment_TParamCommand | 8 | A \ tparam command that describes a template parameter (name and description).For example: \ tparam T description. |
| CXComment_VerbatimBlockCommand | 9 | A verbatim block command (e. g., preformatted code). Verbatim block has an opening and a closing command and contains multiple lines of text (\c CXComment_VerbatimBlockLine child nodes).For example: \ verbatim aaa \ endverbatim |
| CXComment_VerbatimBlockLine | 10 | A line of text that is contained within a CXComment_VerbatimBlockCommand node. |
| CXComment_VerbatimLine | 11 | A verbatim line command. Verbatim line has an opening command, a single line of text (up to the newline after the opening command) and has no closing command. |
| CXComment_FullComment | 12 | A full comment attached to a declaration, contains block content. |