clang.c.Documentation

Undocumented in source.

Public Imports

clang.c.CXString
public import clang.c.CXString;
Undocumented in source.
clang.c.Index
public import clang.c.Index;
Undocumented in source.

Members

Enums

CXCommentInlineCommandRenderKind
enum CXCommentInlineCommandRenderKind

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

CXCommentKind
enum CXCommentKind

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).

CXCommentParamPassDirection
enum CXCommentParamPassDirection

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

Functions

clang_BlockCommandComment_getArgText
CXString clang_BlockCommandComment_getArgText(CXComment Comment, uint ArgIdx)

\param Comment a \c CXComment_BlockCommand AST node.

clang_BlockCommandComment_getCommandName
CXString clang_BlockCommandComment_getCommandName(CXComment Comment)

\param Comment a \c CXComment_BlockCommand AST node.

clang_BlockCommandComment_getNumArgs
uint clang_BlockCommandComment_getNumArgs(CXComment Comment)

\param Comment a \c CXComment_BlockCommand AST node.

clang_BlockCommandComment_getParagraph
CXComment clang_BlockCommandComment_getParagraph(CXComment Comment)

\param Comment a \c CXComment_BlockCommand or \c CXComment_VerbatimBlockCommand AST node.

clang_Comment_getChild
CXComment clang_Comment_getChild(CXComment Comment, uint ChildIdx)

\param Comment AST node of any kind.

clang_Comment_getKind
CXCommentKind clang_Comment_getKind(CXComment Comment)

\param Comment AST node of any kind.

clang_Comment_getNumChildren
uint clang_Comment_getNumChildren(CXComment Comment)

\param Comment AST node of any kind.

clang_Comment_isWhitespace
uint clang_Comment_isWhitespace(CXComment Comment)

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

clang_Cursor_getParsedComment
CXComment clang_Cursor_getParsedComment(CXCursor C)

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

clang_FullComment_getAsHTML
CXString clang_FullComment_getAsHTML(CXComment Comment)

Convert a given full parsed comment to an HTML fragment.

clang_FullComment_getAsXML
CXString clang_FullComment_getAsXML(CXComment Comment)

Convert a given full parsed comment to an XML document.

clang_HTMLStartTagComment_isSelfClosing
uint clang_HTMLStartTagComment_isSelfClosing(CXComment Comment)

\param Comment a \c CXComment_HTMLStartTag AST node.

clang_HTMLStartTag_getAttrName
CXString clang_HTMLStartTag_getAttrName(CXComment Comment, uint AttrIdx)

\param Comment a \c CXComment_HTMLStartTag AST node.

clang_HTMLStartTag_getAttrValue
CXString clang_HTMLStartTag_getAttrValue(CXComment Comment, uint AttrIdx)

\param Comment a \c CXComment_HTMLStartTag AST node.

clang_HTMLStartTag_getNumAttrs
uint clang_HTMLStartTag_getNumAttrs(CXComment Comment)

\param Comment a \c CXComment_HTMLStartTag AST node.

clang_HTMLTagComment_getAsString
CXString clang_HTMLTagComment_getAsString(CXComment Comment)

Convert an HTML tag AST node to string.

clang_HTMLTagComment_getTagName
CXString clang_HTMLTagComment_getTagName(CXComment Comment)

\param Comment a \c CXComment_HTMLStartTag or \c CXComment_HTMLEndTag AST node.

clang_InlineCommandComment_getArgText
CXString clang_InlineCommandComment_getArgText(CXComment Comment, uint ArgIdx)

\param Comment a \c CXComment_InlineCommand AST node.

clang_InlineCommandComment_getCommandName
CXString clang_InlineCommandComment_getCommandName(CXComment Comment)

\param Comment a \c CXComment_InlineCommand AST node.

clang_InlineCommandComment_getNumArgs
uint clang_InlineCommandComment_getNumArgs(CXComment Comment)

\param Comment a \c CXComment_InlineCommand AST node.

clang_InlineCommandComment_getRenderKind
CXCommentInlineCommandRenderKind clang_InlineCommandComment_getRenderKind(CXComment Comment)

\param Comment a \c CXComment_InlineCommand AST node.

clang_InlineContentComment_hasTrailingNewline
uint clang_InlineContentComment_hasTrailingNewline(CXComment Comment)

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

clang_ParamCommandComment_getDirection
CXCommentParamPassDirection clang_ParamCommandComment_getDirection(CXComment Comment)

\param Comment a \c CXComment_ParamCommand AST node.

clang_ParamCommandComment_getParamIndex
uint clang_ParamCommandComment_getParamIndex(CXComment Comment)

\param Comment a \c CXComment_ParamCommand AST node.

clang_ParamCommandComment_getParamName
CXString clang_ParamCommandComment_getParamName(CXComment Comment)

\param Comment a \c CXComment_ParamCommand AST node.

clang_ParamCommandComment_isDirectionExplicit
uint clang_ParamCommandComment_isDirectionExplicit(CXComment Comment)

\param Comment a \c CXComment_ParamCommand AST node.

clang_ParamCommandComment_isParamIndexValid
uint clang_ParamCommandComment_isParamIndexValid(CXComment Comment)

\param Comment a \c CXComment_ParamCommand AST node.

clang_TParamCommandComment_getDepth
uint clang_TParamCommandComment_getDepth(CXComment Comment)

\param Comment a \c CXComment_TParamCommand AST node.

clang_TParamCommandComment_getIndex
uint clang_TParamCommandComment_getIndex(CXComment Comment, uint Depth)

\param Comment a \c CXComment_TParamCommand AST node.

clang_TParamCommandComment_getParamName
CXString clang_TParamCommandComment_getParamName(CXComment Comment)

\param Comment a \c CXComment_TParamCommand AST node.

clang_TParamCommandComment_isParamPositionValid
uint clang_TParamCommandComment_isParamPositionValid(CXComment Comment)

\param Comment a \c CXComment_TParamCommand AST node.

clang_TextComment_getText
CXString clang_TextComment_getText(CXComment Comment)

\param Comment a \c CXComment_Text AST node.

clang_VerbatimBlockLineComment_getText
CXString clang_VerbatimBlockLineComment_getText(CXComment Comment)

\param Comment a \c CXComment_VerbatimBlockLine AST node.

clang_VerbatimLineComment_getText
CXString clang_VerbatimLineComment_getText(CXComment Comment)

\param Comment a \c CXComment_VerbatimLine AST node.

Structs

CXComment
struct CXComment

A parsed comment.

Meta