record TComment

Kind of comment

Number of comment children of this node

Comment children of this node

Whether this comment is whitespace. A Paragraph node is considered whitespace if it contains only Text nodes that are empty or whitespace.

Other AST nodes (except Paragraph and Text) are never considered whitespace.

Whether this is an inline content and has a newline immediately following it in the comment text. Newlines between paragraphs do not count.

For Text AST nodes, the text of the comment

For InlineCommand AST nodes, the name of the command

For InlineCommand AST nodes, the most appropriate rendering mode, chosen on command semantics in Doxygen.

For InlineCommand AST nodes, the number of command arguments

For InlineCommand AST nodes, the command arguments

For HtmlStartTag and HtmlEndTag AST nodes, the tag name

For HtmlStartTag AST nodes, whether the tag is self-closing (for example <br />)

For HtmlStartTag AST nodes, the number of attributes (name-value pairs) attached to the tag.

For HtmlStartTag AST nodes, the attribute names.

For HtmlStartTag AST nodes, the attribute values.

For BlockCommand AST nodes, the name of the block command.

For BlockCommand AST nodes, the number of word-like arguments

For BlockCommand AST nodes, the word-like arguments

For BlockCommand or VerbatimBlockCommand AST nodes, the paragraph argument of the block command

For ParamCommand AST nodes, the parameter name

For ParamCommand AST nodes, whether the parameter that this AST node represents was found in the function prototype and ParamCommandParamIndex function will return a meaningful value.

For ParamCommand AST nodes, the zero-based parameter index in function prototype.

For ParamCommand AST nodes, whether a parameter passing direction was specified explicitly in the comment.

For ParamCommand AST nodes, the parameter passing direction.

For TParamCommand AST nodes, the template parameter name.

For TParamCommand AST nodes, whether the parameter that this AST node represents was found in the template parameter list and TParamCommandDepth and TParamCommandIndex functions will return meaningful values.

For TParamCommand AST nodes, the zero-based nesting depth of this parameter in the template parameter list.

For example,

        template<typename C, template<typename T> class TT>
        void test(TT<int> aaa);
      

For C and TT nesting depth is 0, for T nesting depth is 1.

For TParamCommand AST nodes, the zero-based parameter index in the template parameter list at a given nesting depth.

For example,

        template<typename C, template<typename T> class TT>
        void test(TT<int> aaa);
      

For C and TT nesting depth is 0, so we can ask for index at depth 0: at depth 0 C's index is 0, TT's index is 1.

For T nesting depth is 1, so we can ask for index at depth 0 and 1: at depth 0 T's index is 1 (same as TT's), at depth 1 T's index is 0.

For VerbatimBlockLine AST nodes, the text contained in the AST node.

For VerbatimLine AST nodes, the text contained in the AST node.

For HtmlStartTag and HtmlEndTag AST nodes, the tag converted to a string

For FullComment AST nodes, the full parsed comment as an HTML fragment.

Specific details of HTML layout are subject to change. Don't try to parse this HTML back into an AST, use other APIs instead.

Currently the following CSS classes are used:

• "para-brief" for \brief paragraph and equivalent commands;

• "para-returns" for \returns paragraph and equivalent commands;

• "word-returns" for the "Returns" word in \returns paragraph.

Function argument documentation is rendered as a <dl\> list with arguments sorted in function prototype order. CSS classes used:

• "param-name-index-NUMBER" for parameter name (<dt\>);

• "param-descr-index-NUMBER" for parameter description (<dd\>);

• "param-name-index-invalid" and "param-descr-index-invalid" are used if parameter index is invalid.

Template parameter documentation is rendered as a <dl\> list with parameters sorted in template parameter list order. CSS classes used:

• "tparam-name-index-NUMBER" for parameter name (<dt\>);

• "tparam-descr-index-NUMBER" for parameter description (<dd\>);

• "tparam-name-index-other" and "tparam-descr-index-other" are used for names inside template template parameters;

• "tparam-name-index-invalid" and "tparam-descr-index-invalid" are used if parameter position is invalid.

For FullComment AST nodes, the full parsed comment as an XML document.

A Relax NG schema for the XML can be found in comment-xml-schema.rng file inside clang source tree.

Internal handle to C API