Comment token. More...

#include "clang/AST/CommentLexer.h"

Public Member Functions
SourceLocation	getLocation () const LLVM_READONLY
void	setLocation (SourceLocation SL)
SourceLocation	getEndLocation () const LLVM_READONLY
tok::TokenKind	getKind () const LLVM_READONLY
void	setKind (tok::TokenKind K)
bool	is (tok::TokenKind K) const LLVM_READONLY
bool	isNot (tok::TokenKind K) const LLVM_READONLY
unsigned	getLength () const LLVM_READONLY
void	setLength (unsigned L)
StringRef	getText () const LLVM_READONLY
void	setText (StringRef Text)
StringRef	getUnknownCommandName () const LLVM_READONLY
void	setUnknownCommandName (StringRef Name)
unsigned	getCommandID () const LLVM_READONLY
void	setCommandID (unsigned ID)
unsigned	getVerbatimBlockID () const LLVM_READONLY
void	setVerbatimBlockID (unsigned ID)
StringRef	getVerbatimBlockText () const LLVM_READONLY
void	setVerbatimBlockText (StringRef Text)
unsigned	getVerbatimLineID () const LLVM_READONLY
void	setVerbatimLineID (unsigned ID)
StringRef	getVerbatimLineText () const LLVM_READONLY
void	setVerbatimLineText (StringRef Text)
StringRef	getHTMLTagStartName () const LLVM_READONLY
void	setHTMLTagStartName (StringRef Name)
StringRef	getHTMLIdent () const LLVM_READONLY
void	setHTMLIdent (StringRef Name)
StringRef	getHTMLQuotedString () const LLVM_READONLY
void	setHTMLQuotedString (StringRef Str)
StringRef	getHTMLTagEndName () const LLVM_READONLY
void	setHTMLTagEndName (StringRef Name)
void	dump (const Lexer &L, const SourceManager &SM) const

Friends
class	Lexer
class	TextTokenRetokenizer

Detailed Description

Comment token.

Definition at line 58 of file CommentLexer.h.

Member Function Documentation

◆ dump()

void clang::comments::Token::dump	(	const Lexer &	L,
		const SourceManager &	SM ) const

Definition at line 22 of file CommentLexer.cpp.

References clang::comments::Lexer::getSpelling(), Lexer, and SM.

◆ getCommandID()

unsigned clang::comments::Token::getCommandID ( ) const

inline

Definition at line 123 of file CommentLexer.h.

References clang::comments::tok::at_command, clang::comments::tok::backslash_command, and is().

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

◆ getEndLocation()

SourceLocation clang::comments::Token::getEndLocation ( ) const

inline

Definition at line 86 of file CommentLexer.h.

References clang::SourceLocation::getLocWithOffset().

Referenced by clang::comments::Parser::parseCommandArgs(), clang::comments::Parser::parseInlineCommand(), clang::comments::Parser::parseParamCommandArgs(), clang::comments::Parser::parseParCommandArgs(), clang::comments::Parser::parseThrowCommandArgs(), clang::comments::Parser::parseTParamCommandArgs(), and clang::comments::Parser::parseVerbatimLine().

◆ getHTMLIdent()

StringRef clang::comments::Token::getHTMLIdent ( ) const

inline

Definition at line 186 of file CommentLexer.h.

References clang::comments::tok::html_ident, and is().

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

◆ getHTMLQuotedString()

StringRef clang::comments::Token::getHTMLQuotedString ( ) const

inline

Definition at line 197 of file CommentLexer.h.

References clang::comments::tok::html_quoted_string, and is().

◆ getHTMLTagEndName()

StringRef clang::comments::Token::getHTMLTagEndName ( ) const

inline

Definition at line 208 of file CommentLexer.h.

References clang::comments::tok::html_end_tag, and is().

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

◆ getHTMLTagStartName()

StringRef clang::comments::Token::getHTMLTagStartName ( ) const

inline

Definition at line 175 of file CommentLexer.h.

References clang::comments::tok::html_start_tag, and is().

◆ getKind()

tok::TokenKind clang::comments::Token::getKind ( ) const

inline

Definition at line 92 of file CommentLexer.h.

◆ getLength()

unsigned clang::comments::Token::getLength ( ) const

inline

Definition at line 98 of file CommentLexer.h.

◆ getLocation()

SourceLocation clang::comments::Token::getLocation ( ) const

inline

Definition at line 83 of file CommentLexer.h.

Referenced by clang::comments::Parser::parseCommandArgs(), clang::comments::Parser::parseHTMLEndTag(), clang::comments::Parser::parseHTMLStartTag(), clang::comments::Parser::parseInlineCommand(), clang::comments::Parser::parseParamCommandArgs(), clang::comments::Parser::parseParCommandArgs(), clang::comments::Parser::parseThrowCommandArgs(), clang::comments::Parser::parseTParamCommandArgs(), and clang::comments::Parser::parseVerbatimLine().

◆ getText()

StringRef clang::comments::Token::getText ( ) const

inline

Definition at line 101 of file CommentLexer.h.

References is(), and clang::comments::tok::text.

Referenced by clang::comments::Parser::parseCommandArgs(), clang::comments::Parser::parseParamCommandArgs(), clang::comments::Parser::parseParCommandArgs(), clang::comments::Parser::parseThrowCommandArgs(), and clang::comments::Parser::parseTParamCommandArgs().

◆ getUnknownCommandName()

StringRef clang::comments::Token::getUnknownCommandName ( ) const

inline

Definition at line 112 of file CommentLexer.h.

References is(), clang::comments::tok::unknown_at_command, and clang::comments::tok::unknown_backslash_command.

◆ getVerbatimBlockID()

unsigned clang::comments::Token::getVerbatimBlockID ( ) const

inline

Definition at line 133 of file CommentLexer.h.

References is(), clang::comments::tok::verbatim_block_begin, and clang::comments::tok::verbatim_block_end.

◆ getVerbatimBlockText()

StringRef clang::comments::Token::getVerbatimBlockText ( ) const

inline

Definition at line 143 of file CommentLexer.h.

References is(), and clang::comments::tok::verbatim_block_line.

◆ getVerbatimLineID()

unsigned clang::comments::Token::getVerbatimLineID ( ) const

inline

Definition at line 154 of file CommentLexer.h.

References is(), and clang::comments::tok::verbatim_line_name.

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

◆ getVerbatimLineText()

StringRef clang::comments::Token::getVerbatimLineText ( ) const

inline

Definition at line 164 of file CommentLexer.h.

References is(), and clang::comments::tok::verbatim_line_text.

◆ is()

bool clang::comments::Token::is ( tok::TokenKind K ) const

inline

◆ isNot()

bool clang::comments::Token::isNot ( tok::TokenKind K ) const

inline

Definition at line 96 of file CommentLexer.h.

◆ setCommandID()

void clang::comments::Token::setCommandID ( unsigned ID )

inline

Definition at line 128 of file CommentLexer.h.

References clang::comments::tok::at_command, clang::comments::tok::backslash_command, and is().

◆ setHTMLIdent()

void clang::comments::Token::setHTMLIdent ( StringRef Name )

inline

Definition at line 191 of file CommentLexer.h.

References clang::comments::tok::html_ident, and is().

◆ setHTMLQuotedString()

void clang::comments::Token::setHTMLQuotedString ( StringRef Str )

inline

Definition at line 202 of file CommentLexer.h.

References clang::comments::tok::html_quoted_string, and is().

◆ setHTMLTagEndName()

void clang::comments::Token::setHTMLTagEndName ( StringRef Name )

inline

Definition at line 213 of file CommentLexer.h.

References clang::comments::tok::html_end_tag, and is().

◆ setHTMLTagStartName()

void clang::comments::Token::setHTMLTagStartName ( StringRef Name )

inline

Definition at line 180 of file CommentLexer.h.

References clang::comments::tok::html_start_tag, and is().

◆ setKind()

void clang::comments::Token::setKind ( tok::TokenKind K )

inline

Definition at line 93 of file CommentLexer.h.

◆ setLength()

void clang::comments::Token::setLength ( unsigned L )

inline

Definition at line 99 of file CommentLexer.h.

◆ setLocation()

void clang::comments::Token::setLocation ( SourceLocation SL )

inline

Definition at line 84 of file CommentLexer.h.

◆ setText()

void clang::comments::Token::setText ( StringRef Text )

inline

Definition at line 106 of file CommentLexer.h.

References is(), clang::Text, and clang::comments::tok::text.

◆ setUnknownCommandName()

void clang::comments::Token::setUnknownCommandName ( StringRef Name )

inline

Definition at line 117 of file CommentLexer.h.

References is(), clang::comments::tok::unknown_at_command, and clang::comments::tok::unknown_backslash_command.

◆ setVerbatimBlockID()

void clang::comments::Token::setVerbatimBlockID ( unsigned ID )

inline

Definition at line 138 of file CommentLexer.h.

References is(), clang::comments::tok::verbatim_block_begin, and clang::comments::tok::verbatim_block_end.

◆ setVerbatimBlockText()

void clang::comments::Token::setVerbatimBlockText ( StringRef Text )

inline

Definition at line 148 of file CommentLexer.h.

References is(), clang::Text, and clang::comments::tok::verbatim_block_line.

◆ setVerbatimLineID()

void clang::comments::Token::setVerbatimLineID ( unsigned ID )

inline

Definition at line 159 of file CommentLexer.h.

References is(), and clang::comments::tok::verbatim_line_name.

◆ setVerbatimLineText()

void clang::comments::Token::setVerbatimLineText ( StringRef Text )

inline

Definition at line 169 of file CommentLexer.h.

References is(), clang::Text, and clang::comments::tok::verbatim_line_text.

◆ Lexer

friend class Lexer

friend

Definition at line 59 of file CommentLexer.h.

References Lexer.

Referenced by dump(), and Lexer.

◆ TextTokenRetokenizer

friend class TextTokenRetokenizer

friend

Definition at line 60 of file CommentLexer.h.

References TextTokenRetokenizer.

Referenced by TextTokenRetokenizer.

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

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

Public Member Functions

Friends

Detailed Description

Member Function Documentation

◆ dump()

◆ getCommandID()

◆ getEndLocation()

◆ getHTMLIdent()

◆ getHTMLQuotedString()

◆ getHTMLTagEndName()

◆ getHTMLTagStartName()

◆ getKind()

◆ getLength()

◆ getLocation()

◆ getText()

◆ getUnknownCommandName()

◆ getVerbatimBlockID()

◆ getVerbatimBlockText()

◆ getVerbatimLineID()

◆ getVerbatimLineText()

◆ is()

◆ isNot()

◆ setCommandID()

◆ setHTMLIdent()

◆ setHTMLQuotedString()

◆ setHTMLTagEndName()

◆ setHTMLTagStartName()

◆ setKind()

◆ setLength()

◆ setLocation()

◆ setText()

◆ setUnknownCommandName()

◆ setVerbatimBlockID()

◆ setVerbatimBlockText()

◆ setVerbatimLineID()

◆ setVerbatimLineText()

Friends And Related Symbol Documentation

◆ Lexer

◆ TextTokenRetokenizer