Lines Matching full:comment
1 /*==-- clang-c/Documentation.h - Utilities for comment processing -*- C -*-===*\
25 * \defgroup CINDEX_COMMENT Comment introspection
35 * A parsed comment.
44 * declaration), return the associated parsed comment as a
50 * Describes the type of the comment AST node (\c CXComment). A comment
56 * Null comment. No AST node is constructed at the requested location
95 * A paragraph, contains inline comment. The paragraph itself is
156 * A full comment attached to a declaration, contains block content.
214 * \param Comment AST node of any kind.
218 CINDEX_LINKAGE enum CXCommentKind clang_Comment_getKind(CXComment Comment);
221 * \param Comment AST node of any kind.
225 CINDEX_LINKAGE unsigned clang_Comment_getNumChildren(CXComment Comment);
228 * \param Comment AST node of any kind.
235 CXComment clang_Comment_getChild(CXComment Comment, unsigned ChildIdx);
244 * \returns non-zero if \c Comment is whitespace.
246 CINDEX_LINKAGE unsigned clang_Comment_isWhitespace(CXComment Comment);
249 * \returns non-zero if \c Comment is inline content and has a newline
250 * immediately following it in the comment text. Newlines between paragraphs
254 unsigned clang_InlineContentComment_hasTrailingNewline(CXComment Comment);
257 * \param Comment a \c CXComment_Text AST node.
261 CINDEX_LINKAGE CXString clang_TextComment_getText(CXComment Comment);
264 * \param Comment a \c CXComment_InlineCommand AST node.
269 CXString clang_InlineCommandComment_getCommandName(CXComment Comment);
272 * \param Comment a \c CXComment_InlineCommand AST node.
278 clang_InlineCommandComment_getRenderKind(CXComment Comment);
281 * \param Comment a \c CXComment_InlineCommand AST node.
286 unsigned clang_InlineCommandComment_getNumArgs(CXComment Comment);
289 * \param Comment a \c CXComment_InlineCommand AST node.
296 CXString clang_InlineCommandComment_getArgText(CXComment Comment,
300 * \param Comment a \c CXComment_HTMLStartTag or \c CXComment_HTMLEndTag AST
305 CINDEX_LINKAGE CXString clang_HTMLTagComment_getTagName(CXComment Comment);
308 * \param Comment a \c CXComment_HTMLStartTag AST node.
313 unsigned clang_HTMLStartTagComment_isSelfClosing(CXComment Comment);
316 * \param Comment a \c CXComment_HTMLStartTag AST node.
320 CINDEX_LINKAGE unsigned clang_HTMLStartTag_getNumAttrs(CXComment Comment);
323 * \param Comment a \c CXComment_HTMLStartTag AST node.
330 CXString clang_HTMLStartTag_getAttrName(CXComment Comment, unsigned AttrIdx);
333 * \param Comment a \c CXComment_HTMLStartTag AST node.
340 CXString clang_HTMLStartTag_getAttrValue(CXComment Comment, unsigned AttrIdx);
343 * \param Comment a \c CXComment_BlockCommand AST node.
348 CXString clang_BlockCommandComment_getCommandName(CXComment Comment);
351 * \param Comment a \c CXComment_BlockCommand AST node.
356 unsigned clang_BlockCommandComment_getNumArgs(CXComment Comment);
359 * \param Comment a \c CXComment_BlockCommand AST node.
366 CXString clang_BlockCommandComment_getArgText(CXComment Comment,
370 * \param Comment a \c CXComment_BlockCommand or
376 CXComment clang_BlockCommandComment_getParagraph(CXComment Comment);
379 * \param Comment a \c CXComment_ParamCommand AST node.
384 CXString clang_ParamCommandComment_getParamName(CXComment Comment);
387 * \param Comment a \c CXComment_ParamCommand AST node.
394 unsigned clang_ParamCommandComment_isParamIndexValid(CXComment Comment);
397 * \param Comment a \c CXComment_ParamCommand AST node.
402 unsigned clang_ParamCommandComment_getParamIndex(CXComment Comment);
405 * \param Comment a \c CXComment_ParamCommand AST node.
408 * the comment.
411 unsigned clang_ParamCommandComment_isDirectionExplicit(CXComment Comment);
414 * \param Comment a \c CXComment_ParamCommand AST node.
420 CXComment Comment);
423 * \param Comment a \c CXComment_TParamCommand AST node.
428 CXString clang_TParamCommandComment_getParamName(CXComment Comment);
431 * \param Comment a \c CXComment_TParamCommand AST node.
440 unsigned clang_TParamCommandComment_isParamPositionValid(CXComment Comment);
443 * \param Comment a \c CXComment_TParamCommand AST node.
456 unsigned clang_TParamCommandComment_getDepth(CXComment Comment);
459 * \param Comment a \c CXComment_TParamCommand AST node.
477 unsigned clang_TParamCommandComment_getIndex(CXComment Comment, unsigned Depth);
480 * \param Comment a \c CXComment_VerbatimBlockLine AST node.
485 CXString clang_VerbatimBlockLineComment_getText(CXComment Comment);
488 * \param Comment a \c CXComment_VerbatimLine AST node.
492 CINDEX_LINKAGE CXString clang_VerbatimLineComment_getText(CXComment Comment);
497 * \param Comment a \c CXComment_HTMLStartTag or \c CXComment_HTMLEndTag AST
502 CINDEX_LINKAGE CXString clang_HTMLTagComment_getAsString(CXComment Comment);
505 * Convert a given full parsed comment to an HTML fragment.
531 * \param Comment a \c CXComment_FullComment AST node.
535 CINDEX_LINKAGE CXString clang_FullComment_getAsHTML(CXComment Comment);
538 * Convert a given full parsed comment to an XML document.
540 * A Relax NG schema for the XML can be found in comment-xml-schema.rng file
543 * \param Comment a \c CXComment_FullComment AST node.
547 CINDEX_LINKAGE CXString clang_FullComment_getAsXML(CXComment Comment);