clang
9.0.0
|
#include "clang/AST/RawCommentList.h"
Public Types | |
enum | CommentKind { RCK_Invalid, RCK_OrdinaryBCPL, RCK_OrdinaryC, RCK_BCPLSlash, RCK_BCPLExcl, RCK_JavaDoc, RCK_Qt, RCK_Merged } |
Public Member Functions | |
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? More... | |
void | setAttached () |
bool | isTrailingComment () const LLVM_READONLY |
Returns true if it is a comment that should be put after a member: More... | |
bool | isAlmostTrailingComment () const LLVM_READONLY |
Returns true if it is a probable typo: More... | |
bool | isOrdinary () const LLVM_READONLY |
Returns true if this comment is not a documentation comment. More... | |
bool | isDocumentation () const LLVM_READONLY |
Returns true if this comment any kind of a documentation comment. More... | |
StringRef | getRawText (const SourceManager &SourceMgr) const |
Returns raw comment text with comment markers. More... | |
SourceRange | getSourceRange () const LLVM_READONLY |
SourceLocation | getBeginLoc () const LLVM_READONLY |
SourceLocation | getEndLoc () const LLVM_READONLY |
const char * | getBriefText (const ASTContext &Context) const |
comments::FullComment * | parse (const ASTContext &Context, const Preprocessor *PP, const Decl *D) const |
Parse the comment, assuming it is attached to decl D . More... | |
Public Attributes | |
*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: * * and * * will both turn into: * "This is a first line.\n" * " This is a second line. It is indented.\n" * "This is a third line." */ std::string getFormattedText(const SourceManager &SourceMgr |
Returns sanitized comment text, suitable for presentation in editor UIs. More... | |
*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 DiagnosticsEngine &Diags | const |
Friends | |
class | ASTReader |
Definition at line 27 of file RawCommentList.h.
Definition at line 29 of file RawCommentList.h.
|
inline |
Definition at line 40 of file RawCommentList.h.
RawComment::RawComment | ( | const SourceManager & | SourceMgr, |
SourceRange | SR, | ||
const CommentOptions & | CommentOpts, | ||
bool | Merged | ||
) |
Definition at line 108 of file RawCommentList.cpp.
References clang::SourceRange::getBegin(), clang::SourceManager::getBufferData(), clang::SourceManager::getDecomposedLoc(), clang::SourceRange::getEnd(), getRawText(), isOrdinaryKind(), onlyWhitespaceOnLineBefore(), clang::CommentOptions::ParseAllComments, RCK_Invalid, and RCK_Merged.
|
inline |
Definition at line 103 of file RawCommentList.h.
Referenced by clang::BeforeThanCompare< RawComment >::operator()().
|
inline |
Definition at line 106 of file RawCommentList.h.
|
inline |
Definition at line 104 of file RawCommentList.h.
|
inline |
Definition at line 45 of file RawCommentList.h.
Referenced by clang::Sema::ActOnComment().
|
inline |
Returns raw comment text with comment markers.
Definition at line 93 of file RawCommentList.h.
Referenced by parse(), and RawComment().
|
inline |
Definition at line 102 of file RawCommentList.h.
Referenced by clang::ASTContext::addComment(), and parse().
|
inline |
Returns true if it is a probable typo:
Definition at line 78 of file RawCommentList.h.
Referenced by clang::Sema::ActOnComment().
|
inline |
Is this comment attached to any declaration?
Definition at line 58 of file RawCommentList.h.
|
inline |
Returns true if this comment any kind of a documentation comment.
Definition at line 88 of file RawCommentList.h.
References isInvalid().
Referenced by clang::ASTContext::getRawCommentForAnyRedecl().
|
inline |
Definition at line 49 of file RawCommentList.h.
|
inline |
Definition at line 53 of file RawCommentList.h.
|
inline |
Returns true if this comment is not a documentation comment.
Definition at line 83 of file RawCommentList.h.
|
inline |
Returns true if it is a comment that should be put after a member:
Definition at line 71 of file RawCommentList.h.
comments::FullComment * RawComment::parse | ( | const ASTContext & | Context, |
const Preprocessor * | PP, | ||
const Decl * | D | ||
) | const |
Parse the comment, assuming it is attached to decl D
.
Definition at line 202 of file RawCommentList.cpp.
References clang::ASTContext::getAllocator(), clang::SourceRange::getBegin(), clang::ASTContext::getCommentCommandTraits(), clang::ASTContext::getDiagnostics(), getRawText(), clang::ASTContext::getSourceManager(), and getSourceRange().
Referenced by clang::ASTContext::getCommentForDecl(), and clang::ASTContext::getLocalCommentForDeclUncached().
|
inline |
Definition at line 62 of file RawCommentList.h.
|
friend |
Definition at line 170 of file RawCommentList.h.
* 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 clang::RawComment::cases |
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.
Definition at line 134 of file RawCommentList.h.
* 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 DiagnosticsEngine& Diags clang::RawComment::const |
Definition at line 134 of file RawCommentList.h.