Classes
struct	CXComment
	A parsed comment. More...
Enumerations
enum	CXCommentKind { CXComment_Null = 0, CXComment_Text = 1, CXComment_InlineCommand = 2, CXComment_HTMLStartTag = 3, CXComment_HTMLEndTag = 4, CXComment_Paragraph = 5, CXComment_BlockCommand = 6, CXComment_ParamCommand = 7, CXComment_TParamCommand = 8, CXComment_VerbatimBlockCommand = 9, CXComment_VerbatimBlockLine = 10, CXComment_VerbatimLine = 11, CXComment_FullComment = 12 }
	Describes the type of the comment AST node (`CXComment`). A comment node can be considered block content (e. g., paragraph), inline content (plain text) or neither (the root AST node). More...
enum	CXCommentInlineCommandRenderKind { CXCommentInlineCommandRenderKind_Normal, CXCommentInlineCommandRenderKind_Bold, CXCommentInlineCommandRenderKind_Monospaced, CXCommentInlineCommandRenderKind_Emphasized }
	The most appropriate rendering mode for an inline command, chosen on command semantics in Doxygen. More...
enum	CXCommentParamPassDirection { CXCommentParamPassDirection_In, CXCommentParamPassDirection_Out, CXCommentParamPassDirection_InOut }
	Describes parameter passing direction for \param or \arg command. More...
Functions
CINDEX_LINKAGE CXComment	clang_Cursor_getParsedComment (CXCursor C)
	Given a cursor that represents a documentable entity (e.g., declaration), return the associated parsed comment as a `CXComment_FullComment` AST node.
CINDEX_LINKAGE enum CXCommentKind	clang_Comment_getKind (CXComment Comment)
CINDEX_LINKAGE unsigned	clang_Comment_getNumChildren (CXComment Comment)
CINDEX_LINKAGE CXComment	clang_Comment_getChild (CXComment Comment, unsigned ChildIdx)
CINDEX_LINKAGE unsigned	clang_Comment_isWhitespace (CXComment Comment)
	A `CXComment_Paragraph` node is considered whitespace if it contains only `CXComment_Text` nodes that are empty or whitespace.
CINDEX_LINKAGE unsigned	clang_InlineContentComment_hasTrailingNewline (CXComment Comment)
CINDEX_LINKAGE CXString	clang_TextComment_getText (CXComment Comment)
CINDEX_LINKAGE CXString	clang_InlineCommandComment_getCommandName (CXComment Comment)
CINDEX_LINKAGE enum CXCommentInlineCommandRenderKind	clang_InlineCommandComment_getRenderKind (CXComment Comment)
CINDEX_LINKAGE unsigned	clang_InlineCommandComment_getNumArgs (CXComment Comment)
CINDEX_LINKAGE CXString	clang_InlineCommandComment_getArgText (CXComment Comment, unsigned ArgIdx)
CINDEX_LINKAGE CXString	clang_HTMLTagComment_getTagName (CXComment Comment)
CINDEX_LINKAGE unsigned	clang_HTMLStartTagComment_isSelfClosing (CXComment Comment)
CINDEX_LINKAGE unsigned	clang_HTMLStartTag_getNumAttrs (CXComment Comment)
CINDEX_LINKAGE CXString	clang_HTMLStartTag_getAttrName (CXComment Comment, unsigned AttrIdx)
CINDEX_LINKAGE CXString	clang_HTMLStartTag_getAttrValue (CXComment Comment, unsigned AttrIdx)
CINDEX_LINKAGE CXString	clang_BlockCommandComment_getCommandName (CXComment Comment)
CINDEX_LINKAGE unsigned	clang_BlockCommandComment_getNumArgs (CXComment Comment)
CINDEX_LINKAGE CXString	clang_BlockCommandComment_getArgText (CXComment Comment, unsigned ArgIdx)
CINDEX_LINKAGE CXComment	clang_BlockCommandComment_getParagraph (CXComment Comment)
CINDEX_LINKAGE CXString	clang_ParamCommandComment_getParamName (CXComment Comment)
CINDEX_LINKAGE unsigned	clang_ParamCommandComment_isParamIndexValid (CXComment Comment)
CINDEX_LINKAGE unsigned	clang_ParamCommandComment_getParamIndex (CXComment Comment)
CINDEX_LINKAGE unsigned	clang_ParamCommandComment_isDirectionExplicit (CXComment Comment)
CINDEX_LINKAGE enum CXCommentParamPassDirection	clang_ParamCommandComment_getDirection (CXComment Comment)
CINDEX_LINKAGE CXString	clang_TParamCommandComment_getParamName (CXComment Comment)
CINDEX_LINKAGE unsigned	clang_TParamCommandComment_isParamPositionValid (CXComment Comment)
CINDEX_LINKAGE unsigned	clang_TParamCommandComment_getDepth (CXComment Comment)
CINDEX_LINKAGE unsigned	clang_TParamCommandComment_getIndex (CXComment Comment, unsigned Depth)
CINDEX_LINKAGE CXString	clang_VerbatimBlockLineComment_getText (CXComment Comment)
CINDEX_LINKAGE CXString	clang_VerbatimLineComment_getText (CXComment Comment)
CINDEX_LINKAGE CXString	clang_HTMLTagComment_getAsString (CXComment Comment)
	Convert an HTML tag AST node to string.
CINDEX_LINKAGE CXString	clang_FullComment_getAsHTML (CXComment Comment)
	Convert a given full parsed comment to an HTML fragment.
CINDEX_LINKAGE CXString	clang_FullComment_getAsXML (CXComment Comment)
	Convert a given full parsed comment to an XML document.

Detailed Description

The routines in this group provide access to information in documentation comments. These facilities are distinct from the core and may be subject to their own schedule of stability and deprecation.

Enumeration Type Documentation

enum CXCommentInlineCommandRenderKind

The most appropriate rendering mode for an inline command, chosen on command semantics in Doxygen.

Enumerator:

CXCommentInlineCommandRenderKind_Normal	Command argument should be rendered in a normal font.
CXCommentInlineCommandRenderKind_Bold	Command argument should be rendered in a bold font.
CXCommentInlineCommandRenderKind_Monospaced	Command argument should be rendered in a monospaced font.
CXCommentInlineCommandRenderKind_Emphasized	Command argument should be rendered emphasized (typically italic font).

Definition at line 165 of file Documentation.h.

enum CXCommentKind

Describes the type of the comment AST node (CXComment). A comment node can be considered block content (e. g., paragraph), inline content (plain text) or neither (the root AST node).

Enumerator:

CXComment_Null	Null comment. No AST node is constructed at the requested location because there is no text or a syntax error.
CXComment_Text	Plain text. Inline content.
CXComment_InlineCommand	A command with word-like arguments that is considered inline content. For example: \c command.
CXComment_HTMLStartTag	HTML start tag with attributes (name-value pairs). Considered inline content. For example: * <br> <br /> <a href="http://example.org/"> *
CXComment_HTMLEndTag	HTML end tag. Considered inline content. For example: * </a> *
CXComment_Paragraph	A paragraph, contains inline comment. The paragraph itself is block content.
CXComment_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: \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.
CXComment_ParamCommand	A \param or \arg command that describes the function parameter (name, passing direction, description). For example: \param [in] ParamName description.
CXComment_TParamCommand	A \tparam command that describes a template parameter (name and description). For example: \tparam T description.
CXComment_VerbatimBlockCommand	A verbatim block command (e. g., preformatted code). Verbatim block has an opening and a closing command and contains multiple lines of text (`CXComment_VerbatimBlockLine` child nodes). For example: \verbatim aaa \endverbatim
CXComment_VerbatimBlockLine	A line of text that is contained within a CXComment_VerbatimBlockCommand node.
CXComment_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.
CXComment_FullComment	A full comment attached to a declaration, contains block content.

Definition at line 54 of file Documentation.h.

enum CXCommentParamPassDirection

Describes parameter passing direction for \param or \arg command.

Enumerator:

CXCommentParamPassDirection_In	The parameter is an input parameter.
CXCommentParamPassDirection_Out	The parameter is an output parameter.
CXCommentParamPassDirection_InOut	The parameter is an input and output parameter.

Definition at line 191 of file Documentation.h.

Function Documentation

CINDEX_LINKAGE CXString clang_BlockCommandComment_getArgText	(	CXComment	Comment,
		unsigned	ArgIdx
	)

Parameters:

Comment	a `CXComment_BlockCommand` AST node.
ArgIdx	argument index (zero-based).

Returns:: text of the specified word-like argument.

CINDEX_LINKAGE CXString clang_BlockCommandComment_getCommandName ( CXComment Comment )

Parameters:

Comment a CXComment_BlockCommand AST node.

Returns:: name of the block command.

CINDEX_LINKAGE unsigned clang_BlockCommandComment_getNumArgs ( CXComment Comment )

Parameters:

Comment a CXComment_BlockCommand AST node.

Returns:: number of word-like arguments.

CINDEX_LINKAGE CXComment clang_BlockCommandComment_getParagraph ( CXComment Comment )

Parameters:

Comment a CXComment_BlockCommand or CXComment_VerbatimBlockCommand AST node.

Returns:: paragraph argument of the block command.

CINDEX_LINKAGE CXComment clang_Comment_getChild	(	CXComment	Comment,
		unsigned	ChildIdx
	)

Parameters:

Comment	AST node of any kind.
ChildIdx	child index (zero-based).

Returns:: the specified child of the AST node.

CINDEX_LINKAGE enum CXCommentKind clang_Comment_getKind ( CXComment Comment )

Parameters:

Comment AST node of any kind.

Returns:: the type of the AST node.

CINDEX_LINKAGE unsigned clang_Comment_getNumChildren ( CXComment Comment )

Parameters:

Comment AST node of any kind.

Returns:: number of children of the AST node.

CINDEX_LINKAGE unsigned clang_Comment_isWhitespace ( CXComment Comment )

A CXComment_Paragraph node is considered whitespace if it contains only CXComment_Text nodes that are empty or whitespace.

Other AST nodes (except CXComment_Paragraph and CXComment_Text) are never considered whitespace.

Returns:: non-zero if Comment is whitespace.

CINDEX_LINKAGE CXComment clang_Cursor_getParsedComment ( CXCursor C )

Given a cursor that represents a documentable entity (e.g., declaration), return the associated parsed comment as a CXComment_FullComment AST node.

CINDEX_LINKAGE CXString clang_FullComment_getAsHTML ( CXComment Comment )

Convert a given full parsed comment to 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.

Parameters:

Comment a CXComment_FullComment AST node.

Returns:: string containing an HTML fragment.

CINDEX_LINKAGE CXString clang_FullComment_getAsXML ( CXComment Comment )

Convert a given full parsed comment to an XML document.

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

Parameters:

Comment a CXComment_FullComment AST node.

Returns:: string containing an XML document.

CINDEX_LINKAGE CXString clang_HTMLStartTag_getAttrName	(	CXComment	Comment,
		unsigned	AttrIdx
	)

Parameters:

Comment	a `CXComment_HTMLStartTag` AST node.
AttrIdx	attribute index (zero-based).

Returns:: name of the specified attribute.

CINDEX_LINKAGE CXString clang_HTMLStartTag_getAttrValue	(	CXComment	Comment,
		unsigned	AttrIdx
	)

Parameters:

Comment	a `CXComment_HTMLStartTag` AST node.
AttrIdx	attribute index (zero-based).

Returns:: value of the specified attribute.

CINDEX_LINKAGE unsigned clang_HTMLStartTag_getNumAttrs ( CXComment Comment )

Parameters:

Comment a CXComment_HTMLStartTag AST node.

Returns:: number of attributes (name-value pairs) attached to the start tag.

CINDEX_LINKAGE unsigned clang_HTMLStartTagComment_isSelfClosing ( CXComment Comment )

Parameters:

Comment a CXComment_HTMLStartTag AST node.

Returns:: non-zero if tag is self-closing (for example, <br />).

CINDEX_LINKAGE CXString clang_HTMLTagComment_getAsString ( CXComment Comment )

Convert an HTML tag AST node to string.

Parameters:

Comment a CXComment_HTMLStartTag or CXComment_HTMLEndTag AST node.

Returns:: string containing an HTML tag.

CINDEX_LINKAGE CXString clang_HTMLTagComment_getTagName ( CXComment Comment )

Parameters:

Comment a CXComment_HTMLStartTag or CXComment_HTMLEndTag AST node.

Returns:: HTML tag name.

CINDEX_LINKAGE CXString clang_InlineCommandComment_getArgText	(	CXComment	Comment,
		unsigned	ArgIdx
	)

Parameters:

Comment	a `CXComment_InlineCommand` AST node.
ArgIdx	argument index (zero-based).

Returns:: text of the specified argument.

CINDEX_LINKAGE CXString clang_InlineCommandComment_getCommandName ( CXComment Comment )

Parameters:

Comment a CXComment_InlineCommand AST node.

Returns:: name of the inline command.

CINDEX_LINKAGE unsigned clang_InlineCommandComment_getNumArgs ( CXComment Comment )

Parameters:

Comment a CXComment_InlineCommand AST node.

Returns:: number of command arguments.

CINDEX_LINKAGE enum CXCommentInlineCommandRenderKind clang_InlineCommandComment_getRenderKind ( CXComment Comment )

Parameters:

Comment a CXComment_InlineCommand AST node.

Returns:: the most appropriate rendering mode, chosen on command semantics in Doxygen.

CINDEX_LINKAGE unsigned clang_InlineContentComment_hasTrailingNewline ( CXComment Comment )

Returns:: non-zero if Comment is inline content and has a newline immediately following it in the comment text. Newlines between paragraphs do not count.

CINDEX_LINKAGE enum CXCommentParamPassDirection clang_ParamCommandComment_getDirection ( CXComment Comment )

Parameters: