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 212 of file RawCommentList.h.

Constructor & Destructor Documentation

RawCommentList()

clang::RawCommentList::RawCommentList ( SourceManager &  SourceMgr )

inline

Definition at line 214 of file RawCommentList.h.

Member Function Documentation

addComment()

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

Definition at line 274 of file RawCommentList.cpp.

References empty(), clang::RawComment::getBeginLoc(), clang::SourceManager::getDecomposedLoc(), clang::RawComment::getEndLoc(), clang::RawComment::getKind(), clang::RawComment::isInvalid(), clang::RawComment::isOrdinary(), isOrdinaryKind(), clang::RawComment::isTrailingComment(), onlyWhitespaceBetween(), and clang::CommentOptions::ParseAllComments.

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

empty()

bool RawCommentList::empty

(

)

const

Definition at line 338 of file RawCommentList.cpp.

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

getCommentBeginLine()

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

Definition at line 340 of file RawCommentList.cpp.

References clang::C, clang::File, clang::SourceManager::getLineNumber(), and clang::Line.

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

getCommentEndOffset()

unsigned RawCommentList::getCommentEndOffset

(

RawComment *

C

)

const

Definition at line 350 of file RawCommentList.cpp.

References clang::C, and clang::SourceManager::getDecomposedLoc().

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

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 330 of file RawCommentList.cpp.

References clang::File.

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

Friends And Related Function Documentation

ASTReader

friend class ASTReader

friend

Definition at line 236 of file RawCommentList.h.

ASTWriter

friend class ASTWriter

friend

Definition at line 237 of file RawCommentList.h.

---

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

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