clang.c.documentation

Undocumented in source.

Members

Aliases

CXCommentInlineCommandRenderKind_Anchor
alias CXCommentInlineCommandRenderKind_Anchor = CXCommentInlineCommandRenderKind.CXCommentInlineCommandRenderKind_Anchor
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
CXCommentInlineCommandRenderKind_Bold
alias CXCommentInlineCommandRenderKind_Bold = CXCommentInlineCommandRenderKind.CXCommentInlineCommandRenderKind_Bold
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
CXCommentInlineCommandRenderKind_Emphasized
alias CXCommentInlineCommandRenderKind_Emphasized = CXCommentInlineCommandRenderKind.CXCommentInlineCommandRenderKind_Emphasized
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
CXCommentInlineCommandRenderKind_Monospaced
alias CXCommentInlineCommandRenderKind_Monospaced = CXCommentInlineCommandRenderKind.CXCommentInlineCommandRenderKind_Monospaced
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
CXCommentInlineCommandRenderKind_Normal
alias CXCommentInlineCommandRenderKind_Normal = CXCommentInlineCommandRenderKind.CXCommentInlineCommandRenderKind_Normal
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
CXCommentParamPassDirection_In
alias CXCommentParamPassDirection_In = CXCommentParamPassDirection.CXCommentParamPassDirection_In
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
CXCommentParamPassDirection_InOut
alias CXCommentParamPassDirection_InOut = CXCommentParamPassDirection.CXCommentParamPassDirection_InOut
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
CXCommentParamPassDirection_Out
alias CXCommentParamPassDirection_Out = CXCommentParamPassDirection.CXCommentParamPassDirection_Out
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
CXComment_BlockCommand
alias CXComment_BlockCommand = CXCommentKind.CXComment_BlockCommand
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
CXComment_FullComment
alias CXComment_FullComment = CXCommentKind.CXComment_FullComment
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
CXComment_HTMLEndTag
alias CXComment_HTMLEndTag = CXCommentKind.CXComment_HTMLEndTag
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
CXComment_HTMLStartTag
alias CXComment_HTMLStartTag = CXCommentKind.CXComment_HTMLStartTag
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
CXComment_InlineCommand
alias CXComment_InlineCommand = CXCommentKind.CXComment_InlineCommand
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
CXComment_Null
alias CXComment_Null = CXCommentKind.CXComment_Null
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
CXComment_Paragraph
alias CXComment_Paragraph = CXCommentKind.CXComment_Paragraph
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
CXComment_ParamCommand
alias CXComment_ParamCommand = CXCommentKind.CXComment_ParamCommand
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
CXComment_TParamCommand
alias CXComment_TParamCommand = CXCommentKind.CXComment_TParamCommand
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
CXComment_Text
alias CXComment_Text = CXCommentKind.CXComment_Text
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
CXComment_VerbatimBlockCommand
alias CXComment_VerbatimBlockCommand = CXCommentKind.CXComment_VerbatimBlockCommand
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
CXComment_VerbatimBlockLine
alias CXComment_VerbatimBlockLine = CXCommentKind.CXComment_VerbatimBlockLine
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
CXComment_VerbatimLine
alias CXComment_VerbatimLine = CXCommentKind.CXComment_VerbatimLine
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.

Enums

CXCommentInlineCommandRenderKind
enum CXCommentInlineCommandRenderKind

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

CXCommentKind
enum CXCommentKind
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
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)
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
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