Value | Meaning |
---|---|
null_0 | \brief Null comment. No AST node is constructed at the requested location because there is no text or a syntax error. |
text1 | \brief Plain text. Inline content. |
inlineCommand2 | \brief A command with word-like arguments that is considered inline content. For example: \\c command. |
htmlStartTag3 | \brief HTML start tag with attributes (name-value pairs). Considered inline content. For example: \verbatim <br> <br /> <a href="http://example.org/"> \endverbatim |
htmlEndTag4 | \brief HTML end tag. Considered inline content. For example: \verbatim </a> \endverbatim |
paragraph5 | \brief A paragraph, contains inline comment. The paragraph itself is block content. |
blockCommand6 | \brief 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: \\brief has 0 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. |
paramCommand7 | \brief A \\param or \\arg command that describes the function parameter (name, passing direction, description). For example: \\param in ParamName description. |
tParamCommand8 | \brief A \\tparam command that describes a template parameter (name and description). For example: \\tparam T description. |
verbatimBlockCommand9 | \brief 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 |
verbatimBlockLine10 | \brief A line of text that is contained within a CXComment_VerbatimBlockCommand node. |
verbatimLine11 | \brief 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. |
fullComment12 | \brief A full comment attached to a declaration, contains block content. |
\brief 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).