Cross Reference: /src/external/apache2/llvm/dist/clang/include/clang-c/Documentation.h

Lines Matching refs:Comment
1 /*==-- clang-c/Documentation.h - Utilities for comment processing -*- C -*-===*\
24  * \defgroup CINDEX_COMMENT Comment introspection
34  * A parsed comment.
43  * declaration), return the associated parsed comment as a
49  * Describes the type of the comment AST node (\c CXComment).  A comment
55    * Null comment.  No AST node is constructed at the requested location
94    * A paragraph, contains inline comment.  The paragraph itself is
155    * A full comment attached to a declaration, contains block content.
213  * \param Comment AST node of any kind.
217 CINDEX_LINKAGE enum CXCommentKind clang_Comment_getKind(CXComment Comment);
220  * \param Comment AST node of any kind.
224 CINDEX_LINKAGE unsigned clang_Comment_getNumChildren(CXComment Comment);
227  * \param Comment AST node of any kind.
234 CXComment clang_Comment_getChild(CXComment Comment, unsigned ChildIdx);
243  * \returns non-zero if \c Comment is whitespace.
245 CINDEX_LINKAGE unsigned clang_Comment_isWhitespace(CXComment Comment);
248  * \returns non-zero if \c Comment is inline content and has a newline
249  * immediately following it in the comment text.  Newlines between paragraphs
253 unsigned clang_InlineContentComment_hasTrailingNewline(CXComment Comment);
256  * \param Comment a \c CXComment_Text AST node.
260 CINDEX_LINKAGE CXString clang_TextComment_getText(CXComment Comment);
263  * \param Comment a \c CXComment_InlineCommand AST node.
268 CXString clang_InlineCommandComment_getCommandName(CXComment Comment);
271  * \param Comment a \c CXComment_InlineCommand AST node.
277 clang_InlineCommandComment_getRenderKind(CXComment Comment);
280  * \param Comment a \c CXComment_InlineCommand AST node.
285 unsigned clang_InlineCommandComment_getNumArgs(CXComment Comment);
288  * \param Comment a \c CXComment_InlineCommand AST node.
295 CXString clang_InlineCommandComment_getArgText(CXComment Comment,
299  * \param Comment a \c CXComment_HTMLStartTag or \c CXComment_HTMLEndTag AST
304 CINDEX_LINKAGE CXString clang_HTMLTagComment_getTagName(CXComment Comment);
307  * \param Comment a \c CXComment_HTMLStartTag AST node.
312 unsigned clang_HTMLStartTagComment_isSelfClosing(CXComment Comment);
315  * \param Comment a \c CXComment_HTMLStartTag AST node.
319 CINDEX_LINKAGE unsigned clang_HTMLStartTag_getNumAttrs(CXComment Comment);
322  * \param Comment a \c CXComment_HTMLStartTag AST node.
329 CXString clang_HTMLStartTag_getAttrName(CXComment Comment, unsigned AttrIdx);
332  * \param Comment a \c CXComment_HTMLStartTag AST node.
339 CXString clang_HTMLStartTag_getAttrValue(CXComment Comment, unsigned AttrIdx);
342  * \param Comment a \c CXComment_BlockCommand AST node.
347 CXString clang_BlockCommandComment_getCommandName(CXComment Comment);
350  * \param Comment a \c CXComment_BlockCommand AST node.
355 unsigned clang_BlockCommandComment_getNumArgs(CXComment Comment);
358  * \param Comment a \c CXComment_BlockCommand AST node.
365 CXString clang_BlockCommandComment_getArgText(CXComment Comment,
369  * \param Comment a \c CXComment_BlockCommand or
375 CXComment clang_BlockCommandComment_getParagraph(CXComment Comment);
378  * \param Comment a \c CXComment_ParamCommand AST node.
383 CXString clang_ParamCommandComment_getParamName(CXComment Comment);
386  * \param Comment a \c CXComment_ParamCommand AST node.
393 unsigned clang_ParamCommandComment_isParamIndexValid(CXComment Comment);
396  * \param Comment a \c CXComment_ParamCommand AST node.
401 unsigned clang_ParamCommandComment_getParamIndex(CXComment Comment);
404  * \param Comment a \c CXComment_ParamCommand AST node.
407  * the comment.
410 unsigned clang_ParamCommandComment_isDirectionExplicit(CXComment Comment);
413  * \param Comment a \c CXComment_ParamCommand AST node.
419                                                             CXComment Comment);
422  * \param Comment a \c CXComment_TParamCommand AST node.
427 CXString clang_TParamCommandComment_getParamName(CXComment Comment);
430  * \param Comment a \c CXComment_TParamCommand AST node.
439 unsigned clang_TParamCommandComment_isParamPositionValid(CXComment Comment);
442  * \param Comment a \c CXComment_TParamCommand AST node.
455 unsigned clang_TParamCommandComment_getDepth(CXComment Comment);
458  * \param Comment a \c CXComment_TParamCommand AST node.
476 unsigned clang_TParamCommandComment_getIndex(CXComment Comment, unsigned Depth);
479  * \param Comment a \c CXComment_VerbatimBlockLine AST node.
484 CXString clang_VerbatimBlockLineComment_getText(CXComment Comment);
487  * \param Comment a \c CXComment_VerbatimLine AST node.
491 CINDEX_LINKAGE CXString clang_VerbatimLineComment_getText(CXComment Comment);
496  * \param Comment a \c CXComment_HTMLStartTag or \c CXComment_HTMLEndTag AST
501 CINDEX_LINKAGE CXString clang_HTMLTagComment_getAsString(CXComment Comment);
504  * Convert a given full parsed comment to an HTML fragment.
530  * \param Comment a \c CXComment_FullComment AST node.
534 CINDEX_LINKAGE CXString clang_FullComment_getAsHTML(CXComment Comment);
537  * Convert a given full parsed comment to an XML document.
539  * A Relax NG schema for the XML can be found in comment-xml-schema.rng file
542  * \param Comment a \c CXComment_FullComment AST node.
546 CINDEX_LINKAGE CXString clang_FullComment_getAsXML(CXComment Comment);
OpenGrok
