clang  12.0.0git
Public Member Functions | Friends | List of all members
clang::RawCommentList Class Reference

This class represents all comments included in the translation unit, sorted in order of appearance in the translation unit. More...

#include "clang/AST/RawCommentList.h"

Public Member Functions

 RawCommentList (SourceManager &SourceMgr)
 
void addComment (const RawComment &RC, const CommentOptions &CommentOpts, llvm::BumpPtrAllocator &Allocator)
 
const std::map< unsigned, RawComment * > * getCommentsInFile (FileID File) const
 
bool empty () const
 
unsigned getCommentBeginLine (RawComment *C, FileID File, unsigned Offset) const
 
unsigned getCommentEndOffset (RawComment *C) const
 

Friends

class ASTReader
 
class ASTWriter
 

Detailed Description

This class represents all comments included in the translation unit, sorted in order of appearance in the translation unit.

Definition at line 180 of file RawCommentList.h.

Constructor & Destructor Documentation

◆ RawCommentList()

clang::RawCommentList::RawCommentList ( SourceManager SourceMgr)
inline

Definition at line 182 of file RawCommentList.h.

Member Function Documentation

◆ addComment()

void RawCommentList::addComment ( const RawComment RC,
const CommentOptions CommentOpts,
llvm::BumpPtrAllocator &  Allocator 
)

Definition at line 273 of file RawCommentList.cpp.

Referenced by clang::ASTContext::addComment().

◆ empty()

bool RawCommentList::empty ( ) const

◆ getCommentBeginLine()

unsigned RawCommentList::getCommentBeginLine ( RawComment C,
FileID  File,
unsigned  Offset 
) const

◆ getCommentEndOffset()

unsigned RawCommentList::getCommentEndOffset ( RawComment C) const

◆ getCommentsInFile()

const std::map< unsigned, RawComment * > * RawCommentList::getCommentsInFile ( FileID  File) const
Returns
A mapping from an offset of the start of the comment to the comment itself, or nullptr in case there are no comments in File.

Definition at line 329 of file RawCommentList.cpp.

Referenced by clang::ASTContext::attachCommentsToJustParsedDecls(), and clang::ASTContext::getRawCommentForDeclNoCache().

Friends And Related Function Documentation

◆ ASTReader

friend class ASTReader
friend

Definition at line 204 of file RawCommentList.h.

◆ ASTWriter

friend class ASTWriter
friend

Definition at line 205 of file RawCommentList.h.


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