clang
3.7.0
|
Classes | |
struct | CXComment |
A parsed comment. More... | |
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.
The most appropriate rendering mode for an inline command, chosen on command semantics in Doxygen.
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).
Definition at line 54 of file Documentation.h.
Describes parameter passing direction for \param or \arg command.
Definition at line 191 of file Documentation.h.
CINDEX_LINKAGE CXString clang_BlockCommandComment_getArgText | ( | CXComment | Comment, |
unsigned | ArgIdx | ||
) |
Comment | a CXComment_BlockCommand AST node. |
ArgIdx | argument index (zero-based). |
CINDEX_LINKAGE CXString clang_BlockCommandComment_getCommandName | ( | CXComment | Comment | ) |
Comment | a CXComment_BlockCommand AST node. |
CINDEX_LINKAGE unsigned clang_BlockCommandComment_getNumArgs | ( | CXComment | Comment | ) |
Comment | a CXComment_BlockCommand AST node. |
CINDEX_LINKAGE CXComment clang_BlockCommandComment_getParagraph | ( | CXComment | Comment | ) |
Comment | a CXComment_BlockCommand or CXComment_VerbatimBlockCommand AST node. |
CINDEX_LINKAGE CXComment clang_Comment_getChild | ( | CXComment | Comment, |
unsigned | ChildIdx | ||
) |
Comment | AST node of any kind. |
ChildIdx | child index (zero-based). |
CINDEX_LINKAGE enum CXCommentKind clang_Comment_getKind | ( | CXComment | Comment | ) |
Comment | AST node of any kind. |
CINDEX_LINKAGE unsigned clang_Comment_getNumChildren | ( | CXComment | Comment | ) |
Comment | AST node of any kind. |
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.
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:
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 CXComment_FullComment AST node. |
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.
Comment | a CXComment_FullComment AST node. |
CINDEX_LINKAGE CXString clang_HTMLStartTag_getAttrName | ( | CXComment | Comment, |
unsigned | AttrIdx | ||
) |
Comment | a CXComment_HTMLStartTag AST node. |
AttrIdx | attribute index (zero-based). |
CINDEX_LINKAGE CXString clang_HTMLStartTag_getAttrValue | ( | CXComment | Comment, |
unsigned | AttrIdx | ||
) |
Comment | a CXComment_HTMLStartTag AST node. |
AttrIdx | attribute index (zero-based). |
CINDEX_LINKAGE unsigned clang_HTMLStartTag_getNumAttrs | ( | CXComment | Comment | ) |
Comment | a CXComment_HTMLStartTag AST node. |
CINDEX_LINKAGE unsigned clang_HTMLStartTagComment_isSelfClosing | ( | CXComment | Comment | ) |
Comment | a CXComment_HTMLStartTag AST node. |
CINDEX_LINKAGE CXString clang_HTMLTagComment_getAsString | ( | CXComment | Comment | ) |
Convert an HTML tag AST node to string.
Comment | a CXComment_HTMLStartTag or CXComment_HTMLEndTag AST node. |
CINDEX_LINKAGE CXString clang_HTMLTagComment_getTagName | ( | CXComment | Comment | ) |
Comment | a CXComment_HTMLStartTag or CXComment_HTMLEndTag AST node. |
CINDEX_LINKAGE CXString clang_InlineCommandComment_getArgText | ( | CXComment | Comment, |
unsigned | ArgIdx | ||
) |
Comment | a CXComment_InlineCommand AST node. |
ArgIdx | argument index (zero-based). |
CINDEX_LINKAGE CXString clang_InlineCommandComment_getCommandName | ( | CXComment | Comment | ) |
Comment | a CXComment_InlineCommand AST node. |
CINDEX_LINKAGE unsigned clang_InlineCommandComment_getNumArgs | ( | CXComment | Comment | ) |
Comment | a CXComment_InlineCommand AST node. |
CINDEX_LINKAGE enum CXCommentInlineCommandRenderKind clang_InlineCommandComment_getRenderKind | ( | CXComment | Comment | ) |
Comment | a CXComment_InlineCommand AST node. |
CINDEX_LINKAGE unsigned 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. CINDEX_LINKAGE enum CXCommentParamPassDirection clang_ParamCommandComment_getDirection | ( | CXComment | Comment | ) |
Comment | a CXComment_ParamCommand AST node. |
CINDEX_LINKAGE unsigned clang_ParamCommandComment_getParamIndex | ( | CXComment | Comment | ) |
Comment | a CXComment_ParamCommand AST node. |
CINDEX_LINKAGE CXString clang_ParamCommandComment_getParamName | ( | CXComment | Comment | ) |
Comment | a CXComment_ParamCommand AST node. |
CINDEX_LINKAGE unsigned clang_ParamCommandComment_isDirectionExplicit | ( | CXComment | Comment | ) |
Comment | a CXComment_ParamCommand AST node. |
CINDEX_LINKAGE unsigned clang_ParamCommandComment_isParamIndexValid | ( | CXComment | Comment | ) |
Comment | a CXComment_ParamCommand AST node. |
clang_ParamCommandComment_getParamIndex
function will return a meaningful value. CINDEX_LINKAGE CXString clang_TextComment_getText | ( | CXComment | Comment | ) |
Comment | a CXComment_Text AST node. |
CINDEX_LINKAGE unsigned clang_TParamCommandComment_getDepth | ( | CXComment | Comment | ) |
Comment | a CXComment_TParamCommand AST node. |
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.
CINDEX_LINKAGE unsigned clang_TParamCommandComment_getIndex | ( | CXComment | Comment, |
unsigned | Depth | ||
) |
Comment | a CXComment_TParamCommand AST node. |
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.
CINDEX_LINKAGE CXString clang_TParamCommandComment_getParamName | ( | CXComment | Comment | ) |
Comment | a CXComment_TParamCommand AST node. |
CINDEX_LINKAGE unsigned clang_TParamCommandComment_isParamPositionValid | ( | CXComment | Comment | ) |
Comment | a CXComment_TParamCommand AST node. |
clang_TParamCommandComment_getDepth
and clang_TParamCommandComment_getIndex
functions will return a meaningful value. CINDEX_LINKAGE CXString clang_VerbatimBlockLineComment_getText | ( | CXComment | Comment | ) |
Comment | a CXComment_VerbatimBlockLine AST node. |
CINDEX_LINKAGE CXString clang_VerbatimLineComment_getText | ( | CXComment | Comment | ) |
Comment | a CXComment_VerbatimLine AST node. |