RetroSearch Browse

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://clang.llvm.org/doxygen/classclang_1_1RawComment.html below:

clang: clang::RawComment Class Reference

#include "clang/AST/RawCommentList.h"

RawComment () RawComment (const SourceManager &SourceMgr, SourceRange SR, const CommentOptions &CommentOpts, bool Merged) CommentKind getKind () const LLVM_READONLY bool isInvalid () const LLVM_READONLY bool isMerged () const LLVM_READONLY bool isAttached () const LLVM_READONLY Is this comment attached to any declaration?
void setAttached () bool isTrailingComment () const LLVM_READONLY Returns true if it is a comment that should be put after a member:
bool isAlmostTrailingComment () const LLVM_READONLY Returns true if it is a probable typo:
bool isOrdinary () const LLVM_READONLY Returns true if this comment is not a documentation comment.
bool isDocumentation () const LLVM_READONLY Returns true if this comment any kind of a documentation comment.
StringRef getRawText (const SourceManager &SourceMgr) const Returns raw comment text with comment markers.
SourceRange getSourceRange () const LLVM_READONLY SourceLocation getBeginLoc () const LLVM_READONLY SourceLocation getEndLoc () const LLVM_READONLY const char * getBriefText (const ASTContext &Context) const bool hasUnsupportedSplice (const SourceManager &SourceMgr) const std::string getFormattedText (const SourceManager &SourceMgr, DiagnosticsEngine &Diags) const Returns sanitized comment text, suitable for presentation in editor UIs.
std::vector< CommentLine > getFormattedLines (const SourceManager &SourceMgr, DiagnosticsEngine &Diags) const Returns sanitized comment text as separated lines with locations in source, suitable for further processing and rendering requiring source locations.
comments::FullComment * parse (const ASTContext &Context, const Preprocessor *PP, const Decl *D) const Parse the comment, assuming it is attached to decl D.

Definition at line 32 of file RawCommentList.h.

◆ CommentKind Enumerator RCK_Invalid

Invalid comment.

RCK_OrdinaryBCPL

Any normal BCPL comments.

RCK_OrdinaryC

Any normal C comment.

RCK_BCPLSlash RCK_BCPLExcl RCK_JavaDoc RCK_Qt

, also used by HeaderDoc

RCK_Merged

Two or more documentation comments merged together.

Definition at line 34 of file RawCommentList.h.

◆ RawComment() [1/2] ◆ RawComment() [2/2]

Definition at line 108 of file RawCommentList.cpp.

References clang::SourceRange::getBegin(), clang::SourceManager::getBufferData(), clang::SourceManager::getDecomposedLoc(), clang::SourceRange::getEnd(), getRawText(), clang::Invalid, isOrdinaryKind(), onlyWhitespaceOnLineBefore(), clang::CommentOptions::ParseAllComments, RCK_Invalid, and RCK_Merged.

◆ getBeginLoc() ◆ getBriefText() ◆ getEndLoc() ◆ getFormattedLines()

Returns sanitized comment text as separated lines with locations in source, suitable for further processing and rendering requiring source locations.

Definition at line 376 of file RawCommentList.cpp.

References Begin, clang::comments::tok::eof, clang::comments::Token::getLocation(), clang::SourceLocation::getLocWithOffset(), clang::SourceManager::getPresumedLoc(), getRawText(), getSourceRange(), clang::comments::Lexer::getSpelling(), clang::SourceManager::getSpellingColumnNumber(), clang::comments::Token::is(), clang::comments::Token::isNot(), clang::comments::Lexer::lex(), clang::Line, Loc, clang::comments::tok::newline, and clang::Result.

◆ getFormattedText()

Returns sanitized comment text, suitable for presentation in editor UIs.

E.g. will transform: // This is a long multiline comment. // Parts of it might be indented. /* The comments styles might be mixed. *‍/ into "This is a long multiline comment.\n" " Parts of it might be indented.\n" "The comments styles might be mixed." Also removes leading indentation and sanitizes some common cases: /* This is a first line.

This is a second line. It is indented.
This is a third line. ‍/ and / This is a first line. This is a second line. It is indented. This is a third line. *‍/ will both turn into: "This is a first line.\n" " This is a second line. It is indented.\n" "This is a third line."

Definition at line 358 of file RawCommentList.cpp.

References getFormattedLines(), getRawText(), clang::Line, and clang::Result.

◆ getKind() ◆ getRawText() StringRef clang::RawComment::getRawText ( const SourceManager & SourceMgr ) const inline ◆ getSourceRange() SourceRange clang::RawComment::getSourceRange ( ) const inline ◆ hasUnsupportedSplice() bool clang::RawComment::hasUnsupportedSplice ( const SourceManager & SourceMgr ) const inline ◆ isAlmostTrailingComment() bool clang::RawComment::isAlmostTrailingComment ( ) const inline ◆ isAttached() bool clang::RawComment::isAttached ( ) const inline

Is this comment attached to any declaration?

Definition at line 63 of file RawCommentList.h.

◆ isDocumentation() bool clang::RawComment::isDocumentation ( ) const inline ◆ isInvalid() bool clang::RawComment::isInvalid ( ) const inline ◆ isMerged() bool clang::RawComment::isMerged ( ) const inline ◆ isOrdinary() bool clang::RawComment::isOrdinary ( ) const inline ◆ isTrailingComment() bool clang::RawComment::isTrailingComment ( ) const inline ◆ parse() ◆ setAttached() void clang::RawComment::setAttached ( ) inline

Definition at line 67 of file RawCommentList.h.

◆ ASTReader

The documentation for this class was generated from the following files:

include/clang/AST/RawCommentList.h
lib/AST/RawCommentList.cpp

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4