public class ClangDocumentation
extends java.lang.Object
| Modifier and Type | Class and Description |
|---|---|
static class |
ClangDocumentation.Functions
Contains the function pointers loaded from
ClangIndex.getLibrary(). |
| Modifier and Type | Field and Description |
|---|---|
static int |
CXComment_BlockCommand
Describes the type of the comment AST node (
CXComment). |
static int |
CXComment_FullComment
Describes the type of the comment AST node (
CXComment). |
static int |
CXComment_HTMLEndTag
Describes the type of the comment AST node (
CXComment). |
static int |
CXComment_HTMLStartTag
Describes the type of the comment AST node (
CXComment). |
static int |
CXComment_InlineCommand
Describes the type of the comment AST node (
CXComment). |
static int |
CXComment_Null
Describes the type of the comment AST node (
CXComment). |
static int |
CXComment_Paragraph
Describes the type of the comment AST node (
CXComment). |
static int |
CXComment_ParamCommand
Describes the type of the comment AST node (
CXComment). |
static int |
CXComment_Text
Describes the type of the comment AST node (
CXComment). |
static int |
CXComment_TParamCommand
Describes the type of the comment AST node (
CXComment). |
static int |
CXComment_VerbatimBlockCommand
Describes the type of the comment AST node (
CXComment). |
static int |
CXComment_VerbatimBlockLine
Describes the type of the comment AST node (
CXComment). |
static int |
CXComment_VerbatimLine
Describes the type of the comment AST node (
CXComment). |
static int |
CXCommentInlineCommandRenderKind_Bold
The most appropriate rendering mode for an inline command, chosen on command semantics in Doxygen.
|
static int |
CXCommentInlineCommandRenderKind_Emphasized
The most appropriate rendering mode for an inline command, chosen on command semantics in Doxygen.
|
static int |
CXCommentInlineCommandRenderKind_Monospaced
The most appropriate rendering mode for an inline command, chosen on command semantics in Doxygen.
|
static int |
CXCommentInlineCommandRenderKind_Normal
The most appropriate rendering mode for an inline command, chosen on command semantics in Doxygen.
|
static int |
CXCommentParamPassDirection_In
Describes parameter passing direction for \param or \arg command.
|
static int |
CXCommentParamPassDirection_InOut
Describes parameter passing direction for \param or \arg command.
|
static int |
CXCommentParamPassDirection_Out
Describes parameter passing direction for \param or \arg command.
|
public static final int CXComment_Null
CXComment). A comment node can be considered block content (e. g., paragraph), inline content
(plain text) or neither (the root AST node).
(enum CXCommentKind)
Comment_Null - Null comment. No AST node is constructed at the requested location because there is no text or a syntax error.Comment_Text - Plain text. Inline content.Comment_InlineCommand -
A command with word-like arguments that is considered inline content.
For example: \c command.
Comment_HTMLStartTag -
HTML start tag with attributes (name-value pairs). Considered inline content.
For example:
<br> <br /> <a href="http://example.org/">Comment_HTMLEndTag -
HTML end tag. Considered inline content.
For example:
</a>Comment_Paragraph - A paragraph, contains inline comment. The paragraph itself is block content.Comment_BlockCommand -
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: 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.
Comment_ParamCommand -
A \param or \arg command that describes the function parameter (name, passing direction, description).
For example: \param [in] ParamName description.
Comment_TParamCommand -
A \tparam command that describes a template parameter (name and description).
For example: \tparam T description.
Comment_VerbatimBlockCommand -
A verbatim block command (e. g., preformatted code). Verbatim block has an opening and a closing command and contains multiple lines of text (
Comment_VerbatimBlockLine child nodes).
For example: \verbatim aaa \endverbatim
Comment_VerbatimBlockLine - A line of text that is contained within a CXComment_VerbatimBlockCommand node.Comment_VerbatimLine -
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.
Comment_FullComment - A full comment attached to a declaration, contains block content.public static final int CXComment_Text
CXComment). A comment node can be considered block content (e. g., paragraph), inline content
(plain text) or neither (the root AST node).
(enum CXCommentKind)
Comment_Null - Null comment. No AST node is constructed at the requested location because there is no text or a syntax error.Comment_Text - Plain text. Inline content.Comment_InlineCommand -
A command with word-like arguments that is considered inline content.
For example: \c command.
Comment_HTMLStartTag -
HTML start tag with attributes (name-value pairs). Considered inline content.
For example:
<br> <br /> <a href="http://example.org/">Comment_HTMLEndTag -
HTML end tag. Considered inline content.
For example:
</a>Comment_Paragraph - A paragraph, contains inline comment. The paragraph itself is block content.Comment_BlockCommand -
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: 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.
Comment_ParamCommand -
A \param or \arg command that describes the function parameter (name, passing direction, description).
For example: \param [in] ParamName description.
Comment_TParamCommand -
A \tparam command that describes a template parameter (name and description).
For example: \tparam T description.
Comment_VerbatimBlockCommand -
A verbatim block command (e. g., preformatted code). Verbatim block has an opening and a closing command and contains multiple lines of text (
Comment_VerbatimBlockLine child nodes).
For example: \verbatim aaa \endverbatim
Comment_VerbatimBlockLine - A line of text that is contained within a CXComment_VerbatimBlockCommand node.Comment_VerbatimLine -
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.
Comment_FullComment - A full comment attached to a declaration, contains block content.public static final int CXComment_InlineCommand
CXComment). A comment node can be considered block content (e. g., paragraph), inline content
(plain text) or neither (the root AST node).
(enum CXCommentKind)
Comment_Null - Null comment. No AST node is constructed at the requested location because there is no text or a syntax error.Comment_Text - Plain text. Inline content.Comment_InlineCommand -
A command with word-like arguments that is considered inline content.
For example: \c command.
Comment_HTMLStartTag -
HTML start tag with attributes (name-value pairs). Considered inline content.
For example:
<br> <br /> <a href="http://example.org/">Comment_HTMLEndTag -
HTML end tag. Considered inline content.
For example:
</a>Comment_Paragraph - A paragraph, contains inline comment. The paragraph itself is block content.Comment_BlockCommand -
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: 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.
Comment_ParamCommand -
A \param or \arg command that describes the function parameter (name, passing direction, description).
For example: \param [in] ParamName description.
Comment_TParamCommand -
A \tparam command that describes a template parameter (name and description).
For example: \tparam T description.
Comment_VerbatimBlockCommand -
A verbatim block command (e. g., preformatted code). Verbatim block has an opening and a closing command and contains multiple lines of text (
Comment_VerbatimBlockLine child nodes).
For example: \verbatim aaa \endverbatim
Comment_VerbatimBlockLine - A line of text that is contained within a CXComment_VerbatimBlockCommand node.Comment_VerbatimLine -
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.
Comment_FullComment - A full comment attached to a declaration, contains block content.public static final int CXComment_HTMLStartTag
CXComment). A comment node can be considered block content (e. g., paragraph), inline content
(plain text) or neither (the root AST node).
(enum CXCommentKind)
Comment_Null - Null comment. No AST node is constructed at the requested location because there is no text or a syntax error.Comment_Text - Plain text. Inline content.Comment_InlineCommand -
A command with word-like arguments that is considered inline content.
For example: \c command.
Comment_HTMLStartTag -
HTML start tag with attributes (name-value pairs). Considered inline content.
For example:
<br> <br /> <a href="http://example.org/">Comment_HTMLEndTag -
HTML end tag. Considered inline content.
For example:
</a>Comment_Paragraph - A paragraph, contains inline comment. The paragraph itself is block content.Comment_BlockCommand -
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: 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.
Comment_ParamCommand -
A \param or \arg command that describes the function parameter (name, passing direction, description).
For example: \param [in] ParamName description.
Comment_TParamCommand -
A \tparam command that describes a template parameter (name and description).
For example: \tparam T description.
Comment_VerbatimBlockCommand -
A verbatim block command (e. g., preformatted code). Verbatim block has an opening and a closing command and contains multiple lines of text (
Comment_VerbatimBlockLine child nodes).
For example: \verbatim aaa \endverbatim
Comment_VerbatimBlockLine - A line of text that is contained within a CXComment_VerbatimBlockCommand node.Comment_VerbatimLine -
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.
Comment_FullComment - A full comment attached to a declaration, contains block content.public static final int CXComment_HTMLEndTag
CXComment). A comment node can be considered block content (e. g., paragraph), inline content
(plain text) or neither (the root AST node).
(enum CXCommentKind)
Comment_Null - Null comment. No AST node is constructed at the requested location because there is no text or a syntax error.Comment_Text - Plain text. Inline content.Comment_InlineCommand -
A command with word-like arguments that is considered inline content.
For example: \c command.
Comment_HTMLStartTag -
HTML start tag with attributes (name-value pairs). Considered inline content.
For example:
<br> <br /> <a href="http://example.org/">Comment_HTMLEndTag -
HTML end tag. Considered inline content.
For example:
</a>Comment_Paragraph - A paragraph, contains inline comment. The paragraph itself is block content.Comment_BlockCommand -
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: 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.
Comment_ParamCommand -
A \param or \arg command that describes the function parameter (name, passing direction, description).
For example: \param [in] ParamName description.
Comment_TParamCommand -
A \tparam command that describes a template parameter (name and description).
For example: \tparam T description.
Comment_VerbatimBlockCommand -
A verbatim block command (e. g., preformatted code). Verbatim block has an opening and a closing command and contains multiple lines of text (
Comment_VerbatimBlockLine child nodes).
For example: \verbatim aaa \endverbatim
Comment_VerbatimBlockLine - A line of text that is contained within a CXComment_VerbatimBlockCommand node.Comment_VerbatimLine -
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.
Comment_FullComment - A full comment attached to a declaration, contains block content.public static final int CXComment_Paragraph
CXComment). A comment node can be considered block content (e. g., paragraph), inline content
(plain text) or neither (the root AST node).
(enum CXCommentKind)
Comment_Null - Null comment. No AST node is constructed at the requested location because there is no text or a syntax error.Comment_Text - Plain text. Inline content.Comment_InlineCommand -
A command with word-like arguments that is considered inline content.
For example: \c command.
Comment_HTMLStartTag -
HTML start tag with attributes (name-value pairs). Considered inline content.
For example:
<br> <br /> <a href="http://example.org/">Comment_HTMLEndTag -
HTML end tag. Considered inline content.
For example:
</a>Comment_Paragraph - A paragraph, contains inline comment. The paragraph itself is block content.Comment_BlockCommand -
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: 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.
Comment_ParamCommand -
A \param or \arg command that describes the function parameter (name, passing direction, description).
For example: \param [in] ParamName description.
Comment_TParamCommand -
A \tparam command that describes a template parameter (name and description).
For example: \tparam T description.
Comment_VerbatimBlockCommand -
A verbatim block command (e. g., preformatted code). Verbatim block has an opening and a closing command and contains multiple lines of text (
Comment_VerbatimBlockLine child nodes).
For example: \verbatim aaa \endverbatim
Comment_VerbatimBlockLine - A line of text that is contained within a CXComment_VerbatimBlockCommand node.Comment_VerbatimLine -
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.
Comment_FullComment - A full comment attached to a declaration, contains block content.public static final int CXComment_BlockCommand
CXComment). A comment node can be considered block content (e. g., paragraph), inline content
(plain text) or neither (the root AST node).
(enum CXCommentKind)
Comment_Null - Null comment. No AST node is constructed at the requested location because there is no text or a syntax error.Comment_Text - Plain text. Inline content.Comment_InlineCommand -
A command with word-like arguments that is considered inline content.
For example: \c command.
Comment_HTMLStartTag -
HTML start tag with attributes (name-value pairs). Considered inline content.
For example:
<br> <br /> <a href="http://example.org/">Comment_HTMLEndTag -
HTML end tag. Considered inline content.
For example:
</a>Comment_Paragraph - A paragraph, contains inline comment. The paragraph itself is block content.Comment_BlockCommand -
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: 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.
Comment_ParamCommand -
A \param or \arg command that describes the function parameter (name, passing direction, description).
For example: \param [in] ParamName description.
Comment_TParamCommand -
A \tparam command that describes a template parameter (name and description).
For example: \tparam T description.
Comment_VerbatimBlockCommand -
A verbatim block command (e. g., preformatted code). Verbatim block has an opening and a closing command and contains multiple lines of text (
Comment_VerbatimBlockLine child nodes).
For example: \verbatim aaa \endverbatim
Comment_VerbatimBlockLine - A line of text that is contained within a CXComment_VerbatimBlockCommand node.Comment_VerbatimLine -
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.
Comment_FullComment - A full comment attached to a declaration, contains block content.public static final int CXComment_ParamCommand
CXComment). A comment node can be considered block content (e. g., paragraph), inline content
(plain text) or neither (the root AST node).
(enum CXCommentKind)
Comment_Null - Null comment. No AST node is constructed at the requested location because there is no text or a syntax error.Comment_Text - Plain text. Inline content.Comment_InlineCommand -
A command with word-like arguments that is considered inline content.
For example: \c command.
Comment_HTMLStartTag -
HTML start tag with attributes (name-value pairs). Considered inline content.
For example:
<br> <br /> <a href="http://example.org/">Comment_HTMLEndTag -
HTML end tag. Considered inline content.
For example:
</a>Comment_Paragraph - A paragraph, contains inline comment. The paragraph itself is block content.Comment_BlockCommand -
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: 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.
Comment_ParamCommand -
A \param or \arg command that describes the function parameter (name, passing direction, description).
For example: \param [in] ParamName description.
Comment_TParamCommand -
A \tparam command that describes a template parameter (name and description).
For example: \tparam T description.
Comment_VerbatimBlockCommand -
A verbatim block command (e. g., preformatted code). Verbatim block has an opening and a closing command and contains multiple lines of text (
Comment_VerbatimBlockLine child nodes).
For example: \verbatim aaa \endverbatim
Comment_VerbatimBlockLine - A line of text that is contained within a CXComment_VerbatimBlockCommand node.Comment_VerbatimLine -
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.
Comment_FullComment - A full comment attached to a declaration, contains block content.public static final int CXComment_TParamCommand
CXComment). A comment node can be considered block content (e. g., paragraph), inline content
(plain text) or neither (the root AST node).
(enum CXCommentKind)
Comment_Null - Null comment. No AST node is constructed at the requested location because there is no text or a syntax error.Comment_Text - Plain text. Inline content.Comment_InlineCommand -
A command with word-like arguments that is considered inline content.
For example: \c command.
Comment_HTMLStartTag -
HTML start tag with attributes (name-value pairs). Considered inline content.
For example:
<br> <br /> <a href="http://example.org/">Comment_HTMLEndTag -
HTML end tag. Considered inline content.
For example:
</a>Comment_Paragraph - A paragraph, contains inline comment. The paragraph itself is block content.Comment_BlockCommand -
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: 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.
Comment_ParamCommand -
A \param or \arg command that describes the function parameter (name, passing direction, description).
For example: \param [in] ParamName description.
Comment_TParamCommand -
A \tparam command that describes a template parameter (name and description).
For example: \tparam T description.
Comment_VerbatimBlockCommand -
A verbatim block command (e. g., preformatted code). Verbatim block has an opening and a closing command and contains multiple lines of text (
Comment_VerbatimBlockLine child nodes).
For example: \verbatim aaa \endverbatim
Comment_VerbatimBlockLine - A line of text that is contained within a CXComment_VerbatimBlockCommand node.Comment_VerbatimLine -
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.
Comment_FullComment - A full comment attached to a declaration, contains block content.public static final int CXComment_VerbatimBlockCommand
CXComment). A comment node can be considered block content (e. g., paragraph), inline content
(plain text) or neither (the root AST node).
(enum CXCommentKind)
Comment_Null - Null comment. No AST node is constructed at the requested location because there is no text or a syntax error.Comment_Text - Plain text. Inline content.Comment_InlineCommand -
A command with word-like arguments that is considered inline content.
For example: \c command.
Comment_HTMLStartTag -
HTML start tag with attributes (name-value pairs). Considered inline content.
For example:
<br> <br /> <a href="http://example.org/">Comment_HTMLEndTag -
HTML end tag. Considered inline content.
For example:
</a>Comment_Paragraph - A paragraph, contains inline comment. The paragraph itself is block content.Comment_BlockCommand -
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: 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.
Comment_ParamCommand -
A \param or \arg command that describes the function parameter (name, passing direction, description).
For example: \param [in] ParamName description.
Comment_TParamCommand -
A \tparam command that describes a template parameter (name and description).
For example: \tparam T description.
Comment_VerbatimBlockCommand -
A verbatim block command (e. g., preformatted code). Verbatim block has an opening and a closing command and contains multiple lines of text (
Comment_VerbatimBlockLine child nodes).
For example: \verbatim aaa \endverbatim
Comment_VerbatimBlockLine - A line of text that is contained within a CXComment_VerbatimBlockCommand node.Comment_VerbatimLine -
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.
Comment_FullComment - A full comment attached to a declaration, contains block content.public static final int CXComment_VerbatimBlockLine
CXComment). A comment node can be considered block content (e. g., paragraph), inline content
(plain text) or neither (the root AST node).
(enum CXCommentKind)
Comment_Null - Null comment. No AST node is constructed at the requested location because there is no text or a syntax error.Comment_Text - Plain text. Inline content.Comment_InlineCommand -
A command with word-like arguments that is considered inline content.
For example: \c command.
Comment_HTMLStartTag -
HTML start tag with attributes (name-value pairs). Considered inline content.
For example:
<br> <br /> <a href="http://example.org/">Comment_HTMLEndTag -
HTML end tag. Considered inline content.
For example:
</a>Comment_Paragraph - A paragraph, contains inline comment. The paragraph itself is block content.Comment_BlockCommand -
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: 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.
Comment_ParamCommand -
A \param or \arg command that describes the function parameter (name, passing direction, description).
For example: \param [in] ParamName description.
Comment_TParamCommand -
A \tparam command that describes a template parameter (name and description).
For example: \tparam T description.
Comment_VerbatimBlockCommand -
A verbatim block command (e. g., preformatted code). Verbatim block has an opening and a closing command and contains multiple lines of text (
Comment_VerbatimBlockLine child nodes).
For example: \verbatim aaa \endverbatim
Comment_VerbatimBlockLine - A line of text that is contained within a CXComment_VerbatimBlockCommand node.Comment_VerbatimLine -
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.
Comment_FullComment - A full comment attached to a declaration, contains block content.public static final int CXComment_VerbatimLine
CXComment). A comment node can be considered block content (e. g., paragraph), inline content
(plain text) or neither (the root AST node).
(enum CXCommentKind)
Comment_Null - Null comment. No AST node is constructed at the requested location because there is no text or a syntax error.Comment_Text - Plain text. Inline content.Comment_InlineCommand -
A command with word-like arguments that is considered inline content.
For example: \c command.
Comment_HTMLStartTag -
HTML start tag with attributes (name-value pairs). Considered inline content.
For example:
<br> <br /> <a href="http://example.org/">Comment_HTMLEndTag -
HTML end tag. Considered inline content.
For example:
</a>Comment_Paragraph - A paragraph, contains inline comment. The paragraph itself is block content.Comment_BlockCommand -
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: 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.
Comment_ParamCommand -
A \param or \arg command that describes the function parameter (name, passing direction, description).
For example: \param [in] ParamName description.
Comment_TParamCommand -
A \tparam command that describes a template parameter (name and description).
For example: \tparam T description.
Comment_VerbatimBlockCommand -
A verbatim block command (e. g., preformatted code). Verbatim block has an opening and a closing command and contains multiple lines of text (
Comment_VerbatimBlockLine child nodes).
For example: \verbatim aaa \endverbatim
Comment_VerbatimBlockLine - A line of text that is contained within a CXComment_VerbatimBlockCommand node.Comment_VerbatimLine -
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.
Comment_FullComment - A full comment attached to a declaration, contains block content.public static final int CXComment_FullComment
CXComment). A comment node can be considered block content (e. g., paragraph), inline content
(plain text) or neither (the root AST node).
(enum CXCommentKind)
Comment_Null - Null comment. No AST node is constructed at the requested location because there is no text or a syntax error.Comment_Text - Plain text. Inline content.Comment_InlineCommand -
A command with word-like arguments that is considered inline content.
For example: \c command.
Comment_HTMLStartTag -
HTML start tag with attributes (name-value pairs). Considered inline content.
For example:
<br> <br /> <a href="http://example.org/">Comment_HTMLEndTag -
HTML end tag. Considered inline content.
For example:
</a>Comment_Paragraph - A paragraph, contains inline comment. The paragraph itself is block content.Comment_BlockCommand -
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: 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.
Comment_ParamCommand -
A \param or \arg command that describes the function parameter (name, passing direction, description).
For example: \param [in] ParamName description.
Comment_TParamCommand -
A \tparam command that describes a template parameter (name and description).
For example: \tparam T description.
Comment_VerbatimBlockCommand -
A verbatim block command (e. g., preformatted code). Verbatim block has an opening and a closing command and contains multiple lines of text (
Comment_VerbatimBlockLine child nodes).
For example: \verbatim aaa \endverbatim
Comment_VerbatimBlockLine - A line of text that is contained within a CXComment_VerbatimBlockCommand node.Comment_VerbatimLine -
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.
Comment_FullComment - A full comment attached to a declaration, contains block content.public static final int CXCommentInlineCommandRenderKind_Normal
(enum CXCommentInlineCommandRenderKind)
CommentInlineCommandRenderKind_Normal - Command argument should be rendered in a normal font.CommentInlineCommandRenderKind_Bold - Command argument should be rendered in a bold font.CommentInlineCommandRenderKind_Monospaced - Command argument should be rendered in a monospaced font.CommentInlineCommandRenderKind_Emphasized - Command argument should be rendered emphasized (typically italic font).public static final int CXCommentInlineCommandRenderKind_Bold
(enum CXCommentInlineCommandRenderKind)
CommentInlineCommandRenderKind_Normal - Command argument should be rendered in a normal font.CommentInlineCommandRenderKind_Bold - Command argument should be rendered in a bold font.CommentInlineCommandRenderKind_Monospaced - Command argument should be rendered in a monospaced font.CommentInlineCommandRenderKind_Emphasized - Command argument should be rendered emphasized (typically italic font).public static final int CXCommentInlineCommandRenderKind_Monospaced
(enum CXCommentInlineCommandRenderKind)
CommentInlineCommandRenderKind_Normal - Command argument should be rendered in a normal font.CommentInlineCommandRenderKind_Bold - Command argument should be rendered in a bold font.CommentInlineCommandRenderKind_Monospaced - Command argument should be rendered in a monospaced font.CommentInlineCommandRenderKind_Emphasized - Command argument should be rendered emphasized (typically italic font).public static final int CXCommentInlineCommandRenderKind_Emphasized
(enum CXCommentInlineCommandRenderKind)
CommentInlineCommandRenderKind_Normal - Command argument should be rendered in a normal font.CommentInlineCommandRenderKind_Bold - Command argument should be rendered in a bold font.CommentInlineCommandRenderKind_Monospaced - Command argument should be rendered in a monospaced font.CommentInlineCommandRenderKind_Emphasized - Command argument should be rendered emphasized (typically italic font).public static final int CXCommentParamPassDirection_In
(enum CXCommentParamPassDirection)
CommentParamPassDirection_In - The parameter is an input parameter.CommentParamPassDirection_Out - The parameter is an output parameter.CommentParamPassDirection_InOut - The parameter is an input and output parameter.public static final int CXCommentParamPassDirection_Out
(enum CXCommentParamPassDirection)
CommentParamPassDirection_In - The parameter is an input parameter.CommentParamPassDirection_Out - The parameter is an output parameter.CommentParamPassDirection_InOut - The parameter is an input and output parameter.public static final int CXCommentParamPassDirection_InOut
(enum CXCommentParamPassDirection)
CommentParamPassDirection_In - The parameter is an input parameter.CommentParamPassDirection_Out - The parameter is an output parameter.CommentParamPassDirection_InOut - The parameter is an input and output parameter.public static void nclang_Cursor_getParsedComment(long C,
long __functionAddress,
long __result)
Cursor_getParsedCommentpublic static void nclang_Cursor_getParsedComment(long C,
long __result)
Cursor_getParsedCommentpublic static CXComment clang_Cursor_getParsedComment(CXCursor C, CXComment __result)
Comment_FullComment AST node.public static int nclang_Comment_getKind(long Comment,
long __functionAddress)
Comment_getKindpublic static int nclang_Comment_getKind(long Comment)
Comment_getKindpublic static int clang_Comment_getKind(CXComment Comment)
Comment - AST node of any kindpublic static int nclang_Comment_getNumChildren(long Comment,
long __functionAddress)
Comment_getNumChildrenpublic static int nclang_Comment_getNumChildren(long Comment)
Comment_getNumChildrenpublic static int clang_Comment_getNumChildren(CXComment Comment)
Comment - AST node of any kindpublic static void nclang_Comment_getChild(long Comment,
int ChildIdx,
long __functionAddress,
long __result)
Comment_getChildpublic static void nclang_Comment_getChild(long Comment,
int ChildIdx,
long __result)
Comment_getChildpublic static CXComment clang_Comment_getChild(CXComment Comment, int ChildIdx, CXComment __result)
Comment - AST node of any kindChildIdx - child index (zero-based)__result - the specified child of the AST nodepublic static int nclang_Comment_isWhitespace(long Comment,
long __functionAddress)
Comment_isWhitespacepublic static int nclang_Comment_isWhitespace(long Comment)
Comment_isWhitespacepublic static boolean clang_Comment_isWhitespace(CXComment Comment)
Comment_Paragraph node is considered whitespace if it contains only Comment_Text nodes that are empty or whitespace.
Other AST nodes (except CXComment_Paragraph and CXComment_Text) are never considered whitespace.
Comment is whitespacepublic static int nclang_InlineContentComment_hasTrailingNewline(long Comment,
long __functionAddress)
InlineContentComment_hasTrailingNewlinepublic static int nclang_InlineContentComment_hasTrailingNewline(long Comment)
InlineContentComment_hasTrailingNewlinepublic static boolean clang_InlineContentComment_hasTrailingNewline(CXComment Comment)
Comment is inline content and has a newline immediately following it in the comment text. Newlines between paragraphs do not count.public static void nclang_TextComment_getText(long Comment,
long __functionAddress,
long __result)
TextComment_getTextpublic static void nclang_TextComment_getText(long Comment,
long __result)
TextComment_getTextpublic static CXString clang_TextComment_getText(CXComment Comment, CXString __result)
Comment - a Comment_Text AST node__result - text contained in the AST nodepublic static void nclang_InlineCommandComment_getCommandName(long Comment,
long __functionAddress,
long __result)
InlineCommandComment_getCommandNamepublic static void nclang_InlineCommandComment_getCommandName(long Comment,
long __result)
InlineCommandComment_getCommandNamepublic static CXString clang_InlineCommandComment_getCommandName(CXComment Comment, CXString __result)
Comment - a Comment_InlineCommand AST node__result - name of the inline commandpublic static int nclang_InlineCommandComment_getRenderKind(long Comment,
long __functionAddress)
InlineCommandComment_getRenderKindpublic static int nclang_InlineCommandComment_getRenderKind(long Comment)
InlineCommandComment_getRenderKindpublic static int clang_InlineCommandComment_getRenderKind(CXComment Comment)
Comment - a Comment_InlineCommand AST nodepublic static int nclang_InlineCommandComment_getNumArgs(long Comment,
long __functionAddress)
InlineCommandComment_getNumArgspublic static int nclang_InlineCommandComment_getNumArgs(long Comment)
InlineCommandComment_getNumArgspublic static int clang_InlineCommandComment_getNumArgs(CXComment Comment)
Comment - a Comment_InlineCommand AST nodepublic static void nclang_InlineCommandComment_getArgText(long Comment,
int ArgIdx,
long __functionAddress,
long __result)
InlineCommandComment_getArgTextpublic static void nclang_InlineCommandComment_getArgText(long Comment,
int ArgIdx,
long __result)
InlineCommandComment_getArgTextpublic static CXString clang_InlineCommandComment_getArgText(CXComment Comment, int ArgIdx, CXString __result)
Comment - a Comment_InlineCommand AST nodeArgIdx - argument index (zero-based)__result - text of the specified argumentpublic static void nclang_HTMLTagComment_getTagName(long Comment,
long __functionAddress,
long __result)
HTMLTagComment_getTagNamepublic static void nclang_HTMLTagComment_getTagName(long Comment,
long __result)
HTMLTagComment_getTagNamepublic static CXString clang_HTMLTagComment_getTagName(CXComment Comment, CXString __result)
Comment - a Comment_HTMLStartTag or Comment_HTMLEndTag AST node__result - HTML tag namepublic static int nclang_HTMLStartTagComment_isSelfClosing(long Comment,
long __functionAddress)
HTMLStartTagComment_isSelfClosingpublic static int nclang_HTMLStartTagComment_isSelfClosing(long Comment)
HTMLStartTagComment_isSelfClosingpublic static boolean clang_HTMLStartTagComment_isSelfClosing(CXComment Comment)
Comment - a Comment_HTMLStartTag AST nodepublic static int nclang_HTMLStartTag_getNumAttrs(long Comment,
long __functionAddress)
HTMLStartTag_getNumAttrspublic static int nclang_HTMLStartTag_getNumAttrs(long Comment)
HTMLStartTag_getNumAttrspublic static int clang_HTMLStartTag_getNumAttrs(CXComment Comment)
Comment - a Comment_HTMLStartTag AST nodepublic static void nclang_HTMLStartTag_getAttrName(long Comment,
int AttrIdx,
long __functionAddress,
long __result)
HTMLStartTag_getAttrNamepublic static void nclang_HTMLStartTag_getAttrName(long Comment,
int AttrIdx,
long __result)
HTMLStartTag_getAttrNamepublic static CXString clang_HTMLStartTag_getAttrName(CXComment Comment, int AttrIdx, CXString __result)
Comment - a Comment_HTMLStartTag AST nodeAttrIdx - attribute index (zero-based)__result - name of the specified attributepublic static void nclang_HTMLStartTag_getAttrValue(long Comment,
int AttrIdx,
long __functionAddress,
long __result)
HTMLStartTag_getAttrValuepublic static void nclang_HTMLStartTag_getAttrValue(long Comment,
int AttrIdx,
long __result)
HTMLStartTag_getAttrValuepublic static CXString clang_HTMLStartTag_getAttrValue(CXComment Comment, int AttrIdx, CXString __result)
Comment - a Comment_HTMLStartTag AST nodeAttrIdx - attribute index (zero-based)__result - value of the specified attributepublic static void nclang_BlockCommandComment_getCommandName(long Comment,
long __functionAddress,
long __result)
BlockCommandComment_getCommandNamepublic static void nclang_BlockCommandComment_getCommandName(long Comment,
long __result)
BlockCommandComment_getCommandNamepublic static CXString clang_BlockCommandComment_getCommandName(CXComment Comment, CXString __result)
Comment - a Comment_BlockCommand AST node__result - name of the block commandpublic static int nclang_BlockCommandComment_getNumArgs(long Comment,
long __functionAddress)
BlockCommandComment_getNumArgspublic static int nclang_BlockCommandComment_getNumArgs(long Comment)
BlockCommandComment_getNumArgspublic static int clang_BlockCommandComment_getNumArgs(CXComment Comment)
Comment - a Comment_BlockCommand AST nodepublic static void nclang_BlockCommandComment_getArgText(long Comment,
int ArgIdx,
long __functionAddress,
long __result)
BlockCommandComment_getArgTextpublic static void nclang_BlockCommandComment_getArgText(long Comment,
int ArgIdx,
long __result)
BlockCommandComment_getArgTextpublic static CXString clang_BlockCommandComment_getArgText(CXComment Comment, int ArgIdx, CXString __result)
Comment - a Comment_BlockCommand AST nodeArgIdx - argument index (zero-based)__result - text of the specified word-like argumentpublic static void nclang_BlockCommandComment_getParagraph(long Comment,
long __functionAddress,
long __result)
BlockCommandComment_getParagraphpublic static void nclang_BlockCommandComment_getParagraph(long Comment,
long __result)
BlockCommandComment_getParagraphpublic static CXComment clang_BlockCommandComment_getParagraph(CXComment Comment, CXComment __result)
Comment - a Comment_BlockCommand or Comment_VerbatimBlockCommand AST node__result - paragraph argument of the block commandpublic static void nclang_ParamCommandComment_getParamName(long Comment,
long __functionAddress,
long __result)
ParamCommandComment_getParamNamepublic static void nclang_ParamCommandComment_getParamName(long Comment,
long __result)
ParamCommandComment_getParamNamepublic static CXString clang_ParamCommandComment_getParamName(CXComment Comment, CXString __result)
Comment - a Comment_ParamCommand AST node__result - parameter namepublic static int nclang_ParamCommandComment_isParamIndexValid(long Comment,
long __functionAddress)
ParamCommandComment_isParamIndexValidpublic static int nclang_ParamCommandComment_isParamIndexValid(long Comment)
ParamCommandComment_isParamIndexValidpublic static boolean clang_ParamCommandComment_isParamIndexValid(CXComment Comment)
Comment - a Comment_ParamCommand AST nodeParamCommandComment_getParamIndex function will
return a meaningful valuepublic static int nclang_ParamCommandComment_getParamIndex(long Comment,
long __functionAddress)
ParamCommandComment_getParamIndexpublic static int nclang_ParamCommandComment_getParamIndex(long Comment)
ParamCommandComment_getParamIndexpublic static int clang_ParamCommandComment_getParamIndex(CXComment Comment)
Comment - a Comment_ParamCommand AST nodepublic static int nclang_ParamCommandComment_isDirectionExplicit(long Comment,
long __functionAddress)
ParamCommandComment_isDirectionExplicitpublic static int nclang_ParamCommandComment_isDirectionExplicit(long Comment)
ParamCommandComment_isDirectionExplicitpublic static boolean clang_ParamCommandComment_isDirectionExplicit(CXComment Comment)
Comment - a Comment_ParamCommand AST nodepublic static int nclang_ParamCommandComment_getDirection(long Comment,
long __functionAddress)
ParamCommandComment_getDirectionpublic static int nclang_ParamCommandComment_getDirection(long Comment)
ParamCommandComment_getDirectionpublic static int clang_ParamCommandComment_getDirection(CXComment Comment)
Comment - a Comment_ParamCommand AST nodepublic static void nclang_TParamCommandComment_getParamName(long Comment,
long __functionAddress,
long __result)
TParamCommandComment_getParamNamepublic static void nclang_TParamCommandComment_getParamName(long Comment,
long __result)
TParamCommandComment_getParamNamepublic static CXString clang_TParamCommandComment_getParamName(CXComment Comment, CXString __result)
Comment - a Comment_TParamCommand AST node__result - template parameter namepublic static int nclang_TParamCommandComment_isParamPositionValid(long Comment,
long __functionAddress)
TParamCommandComment_isParamPositionValidpublic static int nclang_TParamCommandComment_isParamPositionValid(long Comment)
TParamCommandComment_isParamPositionValidpublic static boolean clang_TParamCommandComment_isParamPositionValid(CXComment Comment)
Comment - a Comment_TParamCommand AST nodeTParamCommandComment_getDepth and
TParamCommandComment_getIndex functions will return a meaningful valuepublic static int nclang_TParamCommandComment_getDepth(long Comment,
long __functionAddress)
TParamCommandComment_getDepthpublic static int nclang_TParamCommandComment_getDepth(long Comment)
TParamCommandComment_getDepthpublic static int clang_TParamCommandComment_getDepth(CXComment Comment)
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.
Comment - a Comment_TParamCommand AST nodepublic static int nclang_TParamCommandComment_getIndex(long Comment,
int Depth,
long __functionAddress)
TParamCommandComment_getIndexpublic static int nclang_TParamCommandComment_getIndex(long Comment,
int Depth)
TParamCommandComment_getIndexpublic static int clang_TParamCommandComment_getIndex(CXComment Comment, int Depth)
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.
Comment - a Comment_TParamCommand AST nodepublic static void nclang_VerbatimBlockLineComment_getText(long Comment,
long __functionAddress,
long __result)
VerbatimBlockLineComment_getTextpublic static void nclang_VerbatimBlockLineComment_getText(long Comment,
long __result)
VerbatimBlockLineComment_getTextpublic static CXString clang_VerbatimBlockLineComment_getText(CXComment Comment, CXString __result)
Comment - a Comment_VerbatimBlockLine AST node__result - text contained in the AST nodepublic static void nclang_VerbatimLineComment_getText(long Comment,
long __functionAddress,
long __result)
VerbatimLineComment_getTextpublic static void nclang_VerbatimLineComment_getText(long Comment,
long __result)
VerbatimLineComment_getTextpublic static CXString clang_VerbatimLineComment_getText(CXComment Comment, CXString __result)
Comment - a Comment_VerbatimLine AST node__result - text contained in the AST nodepublic static void nclang_HTMLTagComment_getAsString(long Comment,
long __functionAddress,
long __result)
HTMLTagComment_getAsStringpublic static void nclang_HTMLTagComment_getAsString(long Comment,
long __result)
HTMLTagComment_getAsStringpublic static CXString clang_HTMLTagComment_getAsString(CXComment Comment, CXString __result)
Comment - a Comment_HTMLStartTag or Comment_HTMLEndTag AST node__result - string containing an HTML tagpublic static void nclang_FullComment_getAsHTML(long Comment,
long __functionAddress,
long __result)
FullComment_getAsHTMLpublic static void nclang_FullComment_getAsHTML(long Comment,
long __result)
FullComment_getAsHTMLpublic static CXString clang_FullComment_getAsHTML(CXComment Comment, CXString __result)
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:
Function argument documentation is rendered as a <dl> list with arguments sorted in function prototype order. CSS classes used:
Template parameter documentation is rendered as a <dl> list with parameters sorted in template parameter list order. CSS classes used:
Comment - a Comment_FullComment AST node__result - string containing an HTML fragmentpublic static void nclang_FullComment_getAsXML(long Comment,
long __functionAddress,
long __result)
FullComment_getAsXMLpublic static void nclang_FullComment_getAsXML(long Comment,
long __result)
FullComment_getAsXMLpublic static CXString clang_FullComment_getAsXML(CXComment Comment, CXString __result)
A Relax NG schema for the XML can be found in comment-xml-schema.rng file inside clang source tree.
Comment - a Comment_FullComment AST node__result - string containing an XML documentCopyright LWJGL. All Rights Reserved. License terms.