#include "clang/AST/CommentSema.h"

Public Member Functions
	Sema (llvm::BumpPtrAllocator &Allocator, const SourceManager &SourceMgr, DiagnosticsEngine &Diags, CommandTraits &Traits, const Preprocessor *PP)

void	setDecl (const Decl *D)

template<typename T >
ArrayRef< T >	copyArray (ArrayRef< T > Source)
	Returns a copy of array, owned by Sema's allocator.

ParagraphComment *	actOnParagraphComment (ArrayRef< InlineContentComment * > Content)

BlockCommandComment *	actOnBlockCommandStart (SourceLocation LocBegin, SourceLocation LocEnd, unsigned CommandID, CommandMarkerKind CommandMarker)

void	actOnBlockCommandArgs (BlockCommandComment *Command, ArrayRef< BlockCommandComment::Argument > Args)

void	actOnBlockCommandFinish (BlockCommandComment Command, ParagraphComment Paragraph)

ParamCommandComment *	actOnParamCommandStart (SourceLocation LocBegin, SourceLocation LocEnd, unsigned CommandID, CommandMarkerKind CommandMarker)

void	actOnParamCommandDirectionArg (ParamCommandComment *Command, SourceLocation ArgLocBegin, SourceLocation ArgLocEnd, StringRef Arg)

void	actOnParamCommandParamNameArg (ParamCommandComment *Command, SourceLocation ArgLocBegin, SourceLocation ArgLocEnd, StringRef Arg)

void	actOnParamCommandFinish (ParamCommandComment Command, ParagraphComment Paragraph)

TParamCommandComment *	actOnTParamCommandStart (SourceLocation LocBegin, SourceLocation LocEnd, unsigned CommandID, CommandMarkerKind CommandMarker)

void	actOnTParamCommandParamNameArg (TParamCommandComment *Command, SourceLocation ArgLocBegin, SourceLocation ArgLocEnd, StringRef Arg)

void	actOnTParamCommandFinish (TParamCommandComment Command, ParagraphComment Paragraph)

InlineCommandComment *	actOnInlineCommand (SourceLocation CommandLocBegin, SourceLocation CommandLocEnd, unsigned CommandID, ArrayRef< Comment::Argument > Args)

InlineContentComment *	actOnUnknownCommand (SourceLocation LocBegin, SourceLocation LocEnd, StringRef CommandName)

InlineContentComment *	actOnUnknownCommand (SourceLocation LocBegin, SourceLocation LocEnd, unsigned CommandID)

TextComment *	actOnText (SourceLocation LocBegin, SourceLocation LocEnd, StringRef Text)

VerbatimBlockComment *	actOnVerbatimBlockStart (SourceLocation Loc, unsigned CommandID)

VerbatimBlockLineComment *	actOnVerbatimBlockLine (SourceLocation Loc, StringRef Text)

void	actOnVerbatimBlockFinish (VerbatimBlockComment Block, SourceLocation CloseNameLocBegin, StringRef CloseName, ArrayRef< VerbatimBlockLineComment > Lines)

VerbatimLineComment *	actOnVerbatimLine (SourceLocation LocBegin, unsigned CommandID, SourceLocation TextBegin, StringRef Text)

HTMLStartTagComment *	actOnHTMLStartTagStart (SourceLocation LocBegin, StringRef TagName)

void	actOnHTMLStartTagFinish (HTMLStartTagComment *Tag, ArrayRef< HTMLStartTagComment::Attribute > Attrs, SourceLocation GreaterLoc, bool IsSelfClosing)

HTMLEndTagComment *	actOnHTMLEndTag (SourceLocation LocBegin, SourceLocation LocEnd, StringRef TagName)

FullComment *	actOnFullComment (ArrayRef< BlockContentComment * > Blocks)

Detailed Description

Definition at line 32 of file CommentSema.h.

Constructor & Destructor Documentation

◆ Sema()

clang::comments::Sema::Sema	(	llvm::BumpPtrAllocator &	Allocator,
		const SourceManager &	SourceMgr,
		DiagnosticsEngine &	Diags,
		CommandTraits &	Traits,
		const Preprocessor *	PP
	)

Definition at line 28 of file CommentSema.cpp.

Member Function Documentation

◆ actOnBlockCommandArgs()

void clang::comments::Sema::actOnBlockCommandArgs	(	BlockCommandComment *	Command,
		ArrayRef< BlockCommandComment::Argument >	Args
	)

Definition at line 62 of file CommentSema.cpp.

References clang::comments::BlockCommandComment::setArgs().

Referenced by clang::comments::Parser::parseBlockCommand().

◆ actOnBlockCommandFinish()

void clang::comments::Sema::actOnBlockCommandFinish	(	BlockCommandComment *	Command,
		ParagraphComment *	Paragraph
	)

Definition at line 67 of file CommentSema.cpp.

References clang::comments::BlockCommandComment::setParagraph().

Referenced by clang::comments::Parser::parseBlockCommand().

◆ actOnBlockCommandStart()

BlockCommandComment * clang::comments::Sema::actOnBlockCommandStart	(	SourceLocation	LocBegin,
		SourceLocation	LocEnd,
		unsigned	CommandID,
		CommandMarkerKind	CommandMarker
	)

Definition at line 50 of file CommentSema.cpp.

Referenced by clang::comments::Parser::parseBlockCommand().

◆ actOnFullComment()

FullComment * clang::comments::Sema::actOnFullComment ( ArrayRef< BlockContentComment * > Blocks )

Definition at line 517 of file CommentSema.cpp.

References clang::comments::Comment::getLocation(), clang::comments::Comment::getSourceRange(), clang::comments::HTMLTagComment::getTagName(), and clang::comments::HTMLTagComment::setIsMalformed().

Referenced by clang::comments::Parser::parseFullComment().

◆ actOnHTMLEndTag()

HTMLEndTagComment * clang::comments::Sema::actOnHTMLEndTag	(	SourceLocation	LocBegin,
		SourceLocation	LocEnd,
		StringRef	TagName
	)

Definition at line 449 of file CommentSema.cpp.

References E, clang::comments::Comment::getLocation(), clang::SourceManager::getPresumedLineNumber(), clang::comments::Comment::getSourceRange(), clang::comments::HTMLTagComment::getTagName(), clang::comments::HTMLTagComment::isMalformed(), and clang::comments::HTMLTagComment::setIsMalformed().

Referenced by clang::comments::Parser::parseHTMLEndTag().

◆ actOnHTMLStartTagFinish()

void clang::comments::Sema::actOnHTMLStartTagFinish	(	HTMLStartTagComment *	Tag,
		ArrayRef< HTMLStartTagComment::Attribute >	Attrs,
		SourceLocation	GreaterLoc,
		bool	IsSelfClosing
	)

Definition at line 436 of file CommentSema.cpp.

Referenced by clang::comments::Parser::parseHTMLStartTag().

◆ actOnHTMLStartTagStart()

HTMLStartTagComment * clang::comments::Sema::actOnHTMLStartTagStart	(	SourceLocation	LocBegin,
		StringRef	TagName
	)

Definition at line 431 of file CommentSema.cpp.

Referenced by clang::comments::Parser::parseHTMLStartTag().

◆ actOnInlineCommand()

InlineCommandComment * clang::comments::Sema::actOnInlineCommand	(	SourceLocation	CommandLocBegin,
		SourceLocation	CommandLocEnd,
		unsigned	CommandID,
		ArrayRef< Comment::Argument >	Args
	)

Definition at line 362 of file CommentSema.cpp.

References clang::comments::CommandTraits::getCommandInfo(), and clang::comments::CommandInfo::Name.

Referenced by clang::comments::Parser::parseInlineCommand().

◆ actOnParagraphComment()

ParagraphComment * clang::comments::Sema::actOnParagraphComment ( ArrayRef< InlineContentComment * > Content )

Definition at line 45 of file CommentSema.cpp.

Referenced by clang::comments::Parser::parseBlockCommand(), and clang::comments::Parser::parseParagraphOrBlockCommand().

◆ actOnParamCommandDirectionArg()

void clang::comments::Sema::actOnParamCommandDirectionArg	(	ParamCommandComment *	Command,
		SourceLocation	ArgLocBegin,
		SourceLocation	ArgLocEnd,
		StringRef	Arg
	)

Definition at line 230 of file CommentSema.cpp.

References clang::FixItHint::CreateReplacement(), clang::comments::ParamCommandComment::getDirectionAsString(), clang::comments::getParamPassDirection(), clang::comments::In, clang::isWhitespace(), and clang::comments::ParamCommandComment::setDirection().

Referenced by clang::comments::Parser::parseParamCommandArgs().

◆ actOnParamCommandFinish()

void clang::comments::Sema::actOnParamCommandFinish	(	ParamCommandComment *	Command,
		ParagraphComment *	Paragraph
	)

Definition at line 274 of file CommentSema.cpp.

References clang::comments::BlockCommandComment::setParagraph().

Referenced by clang::comments::Parser::parseBlockCommand().

◆ actOnParamCommandParamNameArg()

void clang::comments::Sema::actOnParamCommandParamNameArg	(	ParamCommandComment *	Command,
		SourceLocation	ArgLocBegin,
		SourceLocation	ArgLocEnd,
		StringRef	Arg
	)

Definition at line 257 of file CommentSema.cpp.

References clang::comments::BlockCommandComment::getNumArgs(), clang::comments::In, clang::comments::ParamCommandComment::isDirectionExplicit(), clang::comments::BlockCommandComment::setArgs(), and clang::comments::ParamCommandComment::setDirection().

Referenced by clang::comments::Parser::parseParamCommandArgs().

◆ actOnParamCommandStart()

ParamCommandComment * clang::comments::Sema::actOnParamCommandStart	(	SourceLocation	LocBegin,
		SourceLocation	LocEnd,
		unsigned	CommandID,
		CommandMarkerKind	CommandMarker
	)

Definition at line 80 of file CommentSema.cpp.

References clang::comments::BlockCommandComment::getCommandNameRange(), and clang::comments::Comment::getLocation().

Referenced by clang::comments::Parser::parseBlockCommand().

◆ actOnText()

TextComment * clang::comments::Sema::actOnText	(	SourceLocation	LocBegin,
		SourceLocation	LocEnd,
		StringRef	Text
	)

Definition at line 387 of file CommentSema.cpp.

References Text.

Referenced by clang::comments::Parser::parseParagraphOrBlockCommand().

◆ actOnTParamCommandFinish()

void clang::comments::Sema::actOnTParamCommandFinish	(	TParamCommandComment *	Command,
		ParagraphComment *	Paragraph
	)

Definition at line 355 of file CommentSema.cpp.

References clang::comments::BlockCommandComment::setParagraph().

Referenced by clang::comments::Parser::parseBlockCommand().

◆ actOnTParamCommandParamNameArg()

void clang::comments::Sema::actOnTParamCommandParamNameArg	(	TParamCommandComment *	Command,
		SourceLocation	ArgLocBegin,
		SourceLocation	ArgLocEnd,
		StringRef	Arg
	)

Definition at line 298 of file CommentSema.cpp.

References copyArray(), clang::FixItHint::CreateReplacement(), clang::NamedDecl::getIdentifier(), clang::comments::Comment::getLocation(), clang::IdentifierInfo::getName(), clang::comments::BlockCommandComment::getNumArgs(), clang::TemplateParameterList::getParam(), clang::comments::TParamCommandComment::getParamNameRange(), clang::comments::BlockCommandComment::setArgs(), clang::comments::TParamCommandComment::setPosition(), clang::TemplateParameterList::size(), and clang::comments::DeclInfo::TemplateParameters.

Referenced by clang::comments::Parser::parseTParamCommandArgs().

◆ actOnTParamCommandStart()

TParamCommandComment * clang::comments::Sema::actOnTParamCommandStart	(	SourceLocation	LocBegin,
		SourceLocation	LocEnd,
		unsigned	CommandID,
		CommandMarkerKind	CommandMarker
	)

Definition at line 280 of file CommentSema.cpp.

References clang::comments::BlockCommandComment::getCommandNameRange(), and clang::comments::Comment::getLocation().

Referenced by clang::comments::Parser::parseBlockCommand().

◆ actOnUnknownCommand() [1/2]

InlineContentComment * clang::comments::Sema::actOnUnknownCommand	(	SourceLocation	LocBegin,
		SourceLocation	LocEnd,
		StringRef	CommandName
	)

Definition at line 372 of file CommentSema.cpp.

References actOnUnknownCommand(), clang::comments::CommandInfo::getID(), and clang::comments::CommandTraits::registerUnknownCommand().

Referenced by actOnUnknownCommand(), and clang::comments::Parser::parseParagraphOrBlockCommand().

◆ actOnUnknownCommand() [2/2]

InlineContentComment * clang::comments::Sema::actOnUnknownCommand	(	SourceLocation	LocBegin,
		SourceLocation	LocEnd,
		unsigned	CommandID
	)

Definition at line 379 of file CommentSema.cpp.

References clang::comments::Normal.

◆ actOnVerbatimBlockFinish()

void clang::comments::Sema::actOnVerbatimBlockFinish	(	VerbatimBlockComment *	Block,
		SourceLocation	CloseNameLocBegin,
		StringRef	CloseName,
		ArrayRef< VerbatimBlockLineComment * >	Lines
	)

Definition at line 407 of file CommentSema.cpp.

References clang::Block.

Referenced by clang::comments::Parser::parseVerbatimBlock().

◆ actOnVerbatimBlockLine()

VerbatimBlockLineComment * clang::comments::Sema::actOnVerbatimBlockLine	(	SourceLocation	Loc,
		StringRef	Text
	)

Definition at line 402 of file CommentSema.cpp.

References Loc, and Text.

Referenced by clang::comments::Parser::parseVerbatimBlock().

◆ actOnVerbatimBlockStart()

VerbatimBlockComment * clang::comments::Sema::actOnVerbatimBlockStart	(	SourceLocation	Loc,
		unsigned	CommandID
	)

Definition at line 393 of file CommentSema.cpp.

References clang::comments::CommandTraits::getCommandInfo(), Loc, and clang::comments::CommandInfo::Name.

Referenced by clang::comments::Parser::parseVerbatimBlock().

◆ actOnVerbatimLine()

VerbatimLineComment * clang::comments::Sema::actOnVerbatimLine	(	SourceLocation	LocBegin,
		unsigned	CommandID,
		SourceLocation	TextBegin,
		StringRef	Text
	)

Definition at line 416 of file CommentSema.cpp.

References clang::SourceLocation::getLocWithOffset(), and Text.

Referenced by clang::comments::Parser::parseVerbatimLine().

◆ copyArray()

template<typename T >

ArrayRef< T > clang::comments::Sema::copyArray ( ArrayRef< T > Source )

inline

Returns a copy of array, owned by Sema's allocator.

Definition at line 80 of file CommentSema.h.

Referenced by actOnTParamCommandParamNameArg(), clang::comments::Parser::parseFullComment(), clang::comments::Parser::parseHTMLStartTag(), clang::comments::Parser::parseParagraphOrBlockCommand(), and clang::comments::Parser::parseVerbatimBlock().

◆ setDecl()

void clang::comments::Sema::setDecl ( const Decl * D )

Definition at line 36 of file CommentSema.cpp.

References clang::comments::DeclInfo::CommentDecl, D, and clang::comments::DeclInfo::IsFilled.

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

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

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Sema()

Member Function Documentation

◆ actOnBlockCommandArgs()

◆ actOnBlockCommandFinish()

◆ actOnBlockCommandStart()

◆ actOnFullComment()

◆ actOnHTMLEndTag()

◆ actOnHTMLStartTagFinish()

◆ actOnHTMLStartTagStart()

◆ actOnInlineCommand()

◆ actOnParagraphComment()

◆ actOnParamCommandDirectionArg()

◆ actOnParamCommandFinish()

◆ actOnParamCommandParamNameArg()

◆ actOnParamCommandStart()

◆ actOnText()

◆ actOnTParamCommandFinish()

◆ actOnTParamCommandParamNameArg()

◆ actOnTParamCommandStart()

◆ actOnUnknownCommand() [1/2]

◆ actOnUnknownCommand() [2/2]

◆ actOnVerbatimBlockFinish()

◆ actOnVerbatimBlockLine()

◆ actOnVerbatimBlockStart()

◆ actOnVerbatimLine()

◆ copyArray()

◆ setDecl()