clang 20.0.0git
Public Member Functions | Friends | List of all members
clang::comments::Parser Class Reference

Doxygen comment parser. More...

#include "clang/AST/CommentParser.h"

Public Member Functions

 Parser (Lexer &L, Sema &S, llvm::BumpPtrAllocator &Allocator, const SourceManager &SourceMgr, DiagnosticsEngine &Diags, const CommandTraits &Traits)
 
void parseParamCommandArgs (ParamCommandComment *PC, TextTokenRetokenizer &Retokenizer)
 Parse arguments for \param command.
 
void parseTParamCommandArgs (TParamCommandComment *TPC, TextTokenRetokenizer &Retokenizer)
 Parse arguments for \tparam command.
 
ArrayRef< Comment::Argument > parseCommandArgs (TextTokenRetokenizer &Retokenizer, unsigned NumArgs)
 
ArrayRef< Comment::Argument > parseThrowCommandArgs (TextTokenRetokenizer &Retokenizer, unsigned NumArgs)
 Parse arguments for.
 
ArrayRef< Comment::Argument > parseParCommandArgs (TextTokenRetokenizer &Retokenizer, unsigned NumArgs)
 
BlockCommandComment * parseBlockCommand ()
 
InlineCommandComment * parseInlineCommand ()
 
HTMLStartTagComment * parseHTMLStartTag ()
 
HTMLEndTagComment * parseHTMLEndTag ()
 
BlockContentComment * parseParagraphOrBlockCommand ()
 
VerbatimBlockComment * parseVerbatimBlock ()
 
VerbatimLineComment * parseVerbatimLine ()
 
BlockContentComment * parseBlockContent ()
 
FullComment * parseFullComment ()
 

Friends

class TextTokenRetokenizer
 

Detailed Description

Doxygen comment parser.

Definition at line 29 of file CommentParser.h.

Constructor & Destructor Documentation

◆ Parser()

clang::comments::Parser::Parser ( Lexer &  L,
Sema &  S,
llvm::BumpPtrAllocator &  Allocator,
const SourceManager &  SourceMgr,
DiagnosticsEngine &  Diags,
const CommandTraits &  Traits 
)

Definition at line 386 of file CommentParser.cpp.

Member Function Documentation

◆ parseBlockCommand()

BlockCommandComment * clang::comments::Parser::parseBlockCommand ( )

Definition at line 472 of file CommentParser.cpp.

References clang::comments::Sema::actOnBlockCommandArgs(), clang::comments::Sema::actOnBlockCommandFinish(), clang::comments::Sema::actOnBlockCommandStart(), clang::comments::Sema::actOnParagraphComment(), clang::comments::Sema::actOnParamCommandFinish(), clang::comments::Sema::actOnParamCommandStart(), clang::comments::Sema::actOnTParamCommandFinish(), clang::comments::Sema::actOnTParamCommandStart(), clang::comments::tok::at_command, clang::comments::tok::backslash_command, clang::Block, clang::comments::CMK_At, clang::comments::CMK_Backslash, clang::comments::Token::getCommandID(), clang::comments::CommandTraits::getCommandInfo(), clang::comments::Token::getEndLocation(), clang::comments::Token::getLocation(), clang::comments::Token::is(), clang::comments::CommandInfo::IsParamCommand, clang::comments::CommandInfo::IsParCommand, clang::comments::CommandInfo::IsThrowsCommand, clang::comments::CommandInfo::IsTParamCommand, clang::comments::tok::newline, clang::comments::CommandInfo::NumArgs, parseCommandArgs(), parseParagraphOrBlockCommand(), parseParamCommandArgs(), parseParCommandArgs(), parseThrowCommandArgs(), parseTParamCommandArgs(), and clang::comments::TextTokenRetokenizer::putBackLeftoverTokens().

Referenced by parseParagraphOrBlockCommand().

◆ parseBlockContent()

BlockContentComment * clang::comments::Parser::parseBlockContent ( )

Definition at line 887 of file CommentParser.cpp.

References clang::comments::tok::at_command, clang::comments::tok::backslash_command, clang::comments::tok::eof, clang::comments::Token::getKind(), clang::comments::tok::html_end_tag, clang::comments::tok::html_equals, clang::comments::tok::html_greater, clang::comments::tok::html_ident, clang::comments::tok::html_quoted_string, clang::comments::tok::html_slash_greater, clang::comments::tok::html_start_tag, clang::comments::tok::newline, parseParagraphOrBlockCommand(), parseVerbatimBlock(), parseVerbatimLine(), clang::comments::tok::text, clang::comments::tok::unknown_command, clang::comments::tok::verbatim_block_begin, clang::comments::tok::verbatim_block_end, clang::comments::tok::verbatim_block_line, clang::comments::tok::verbatim_line_name, and clang::comments::tok::verbatim_line_text.

Referenced by parseFullComment().

◆ parseCommandArgs()

ArrayRef< Comment::Argument > clang::comments::Parser::parseCommandArgs ( TextTokenRetokenizer &  Retokenizer,
unsigned  NumArgs 
)

Definition at line 423 of file CommentParser.cpp.

References clang::comments::Token::getEndLocation(), clang::comments::Token::getLocation(), clang::comments::Token::getText(), and clang::comments::TextTokenRetokenizer::lexWord().

Referenced by parseBlockCommand(), and parseInlineCommand().

◆ parseFullComment()

FullComment * clang::comments::Parser::parseFullComment ( )

Definition at line 918 of file CommentParser.cpp.

References clang::comments::Sema::actOnFullComment(), clang::comments::Sema::copyArray(), clang::comments::tok::eof, clang::comments::Token::is(), clang::comments::Token::isNot(), clang::comments::tok::newline, and parseBlockContent().

◆ parseHTMLEndTag()

HTMLEndTagComment * clang::comments::Parser::parseHTMLEndTag ( )

Definition at line 699 of file CommentParser.cpp.

References clang::comments::Sema::actOnHTMLEndTag(), clang::comments::Token::getHTMLTagEndName(), clang::comments::Token::getLocation(), clang::comments::tok::html_end_tag, clang::comments::tok::html_greater, clang::comments::Token::is(), and Loc.

Referenced by parseParagraphOrBlockCommand().

◆ parseHTMLStartTag()

HTMLStartTagComment * clang::comments::Parser::parseHTMLStartTag ( )

Definition at line 598 of file CommentParser.cpp.

References clang::comments::Sema::actOnHTMLStartTagFinish(), clang::comments::Sema::actOnHTMLStartTagStart(), clang::comments::Sema::copyArray(), clang::comments::Token::getEndLocation(), clang::comments::Token::getHTMLIdent(), clang::comments::Token::getHTMLQuotedString(), clang::comments::Token::getHTMLTagStartName(), clang::comments::Token::getKind(), clang::comments::Comment::getLocation(), clang::comments::Token::getLocation(), clang::SourceManager::getPresumedLineNumber(), clang::comments::Comment::getSourceRange(), clang::comments::tok::html_equals, clang::comments::tok::html_greater, clang::comments::tok::html_ident, clang::comments::tok::html_quoted_string, clang::comments::tok::html_slash_greater, clang::comments::tok::html_start_tag, clang::comments::Token::is(), and clang::comments::Token::isNot().

Referenced by parseParagraphOrBlockCommand().

◆ parseInlineCommand()

InlineCommandComment * clang::comments::Parser::parseInlineCommand ( )

Definition at line 570 of file CommentParser.cpp.

References clang::comments::Sema::actOnInlineCommand(), clang::comments::tok::at_command, clang::comments::tok::backslash_command, clang::comments::Token::getCommandID(), clang::comments::CommandTraits::getCommandInfo(), clang::comments::Token::getEndLocation(), clang::comments::Token::getLocation(), clang::SourceLocation::getLocWithOffset(), clang::comments::Token::is(), clang::comments::CommandInfo::Name, clang::comments::CommandInfo::NumArgs, parseCommandArgs(), and clang::comments::TextTokenRetokenizer::putBackLeftoverTokens().

Referenced by parseParagraphOrBlockCommand().

◆ parseParagraphOrBlockCommand()

BlockContentComment * clang::comments::Parser::parseParagraphOrBlockCommand ( )

Definition at line 714 of file CommentParser.cpp.

References clang::comments::Sema::actOnParagraphComment(), clang::comments::Sema::actOnText(), clang::comments::Sema::actOnUnknownCommand(), clang::comments::tok::at_command, clang::comments::tok::backslash_command, clang::comments::Sema::copyArray(), clang::comments::tok::eof, clang::comments::Token::getCommandID(), clang::comments::CommandTraits::getCommandInfo(), clang::comments::Token::getEndLocation(), clang::comments::CommandInfo::getID(), clang::comments::Token::getKind(), clang::comments::Token::getLocation(), clang::comments::Token::getText(), clang::comments::Token::getUnknownCommandName(), clang::comments::tok::html_end_tag, clang::comments::tok::html_equals, clang::comments::tok::html_greater, clang::comments::tok::html_ident, clang::comments::tok::html_quoted_string, clang::comments::tok::html_slash_greater, clang::comments::tok::html_start_tag, clang::comments::Token::is(), clang::comments::CommandInfo::IsBlockCommand, clang::comments::CommandInfo::IsInlineCommand, clang::comments::CommandInfo::IsUnknownCommand, clang::comments::CommandInfo::IsVerbatimBlockEndCommand, clang::isWhitespace(), clang::comments::CommandInfo::Name, clang::comments::tok::newline, parseBlockCommand(), parseHTMLEndTag(), parseHTMLStartTag(), parseInlineCommand(), clang::comments::tok::text, clang::comments::tok::unknown_command, clang::comments::tok::verbatim_block_begin, clang::comments::tok::verbatim_block_end, clang::comments::tok::verbatim_block_line, clang::comments::tok::verbatim_line_name, and clang::comments::tok::verbatim_line_text.

Referenced by parseBlockCommand(), and parseBlockContent().

◆ parseParamCommandArgs()

void clang::comments::Parser::parseParamCommandArgs ( ParamCommandComment *  PC,
TextTokenRetokenizer &  Retokenizer 
)

Parse arguments for \param command.

Definition at line 394 of file CommentParser.cpp.

References clang::comments::Sema::actOnParamCommandDirectionArg(), clang::comments::Sema::actOnParamCommandParamNameArg(), clang::comments::Token::getEndLocation(), clang::comments::Token::getLocation(), clang::comments::Token::getText(), clang::comments::TextTokenRetokenizer::lexDelimitedSeq(), and clang::comments::TextTokenRetokenizer::lexWord().

Referenced by parseBlockCommand().

◆ parseParCommandArgs()

ArrayRef< Comment::Argument > clang::comments::Parser::parseParCommandArgs ( TextTokenRetokenizer &  Retokenizer,
unsigned  NumArgs 
)

Definition at line 455 of file CommentParser.cpp.

References clang::comments::Token::getEndLocation(), clang::comments::Token::getLocation(), clang::comments::Token::getText(), and clang::comments::TextTokenRetokenizer::lexParHeading().

Referenced by parseBlockCommand().

◆ parseThrowCommandArgs()

ArrayRef< Comment::Argument > clang::comments::Parser::parseThrowCommandArgs ( TextTokenRetokenizer &  Retokenizer,
unsigned  NumArgs 
)

Parse arguments for.

Exceptions
commandsupported args are in form of class or template.

Definition at line 438 of file CommentParser.cpp.

References clang::comments::Token::getEndLocation(), clang::comments::Token::getLocation(), clang::comments::Token::getText(), and clang::comments::TextTokenRetokenizer::lexType().

Referenced by parseBlockCommand().

◆ parseTParamCommandArgs()

void clang::comments::Parser::parseTParamCommandArgs ( TParamCommandComment *  TPC,
TextTokenRetokenizer &  Retokenizer 
)

Parse arguments for \tparam command.

Definition at line 412 of file CommentParser.cpp.

References clang::comments::Sema::actOnTParamCommandParamNameArg(), clang::comments::Token::getEndLocation(), clang::comments::Token::getLocation(), clang::comments::Token::getText(), and clang::comments::TextTokenRetokenizer::lexWord().

Referenced by parseBlockCommand().

◆ parseVerbatimBlock()

VerbatimBlockComment * clang::comments::Parser::parseVerbatimBlock ( )

Definition at line 815 of file CommentParser.cpp.

References clang::comments::Sema::actOnVerbatimBlockFinish(), clang::comments::Sema::actOnVerbatimBlockLine(), clang::comments::Sema::actOnVerbatimBlockStart(), clang::comments::Sema::copyArray(), clang::comments::CommandTraits::getCommandInfo(), clang::comments::Token::getLocation(), clang::comments::Token::getVerbatimBlockID(), clang::comments::Token::getVerbatimBlockText(), clang::comments::Token::is(), clang::Line, clang::comments::CommandInfo::Name, clang::comments::tok::newline, clang::comments::tok::verbatim_block_begin, clang::comments::tok::verbatim_block_end, and clang::comments::tok::verbatim_block_line.

Referenced by parseBlockContent().

◆ parseVerbatimLine()

VerbatimLineComment * clang::comments::Parser::parseVerbatimLine ( )

Definition at line 861 of file CommentParser.cpp.

References clang::comments::Sema::actOnVerbatimLine(), clang::comments::Token::getEndLocation(), clang::comments::Token::getLocation(), clang::comments::Token::getVerbatimLineID(), clang::comments::Token::getVerbatimLineText(), clang::comments::Token::is(), Text, clang::comments::tok::verbatim_line_name, and clang::comments::tok::verbatim_line_text.

Referenced by parseBlockContent().

Friends And Related Function Documentation

◆ TextTokenRetokenizer

friend class TextTokenRetokenizer
friend

Definition at line 33 of file CommentParser.h.

The documentation for this class was generated from the following files:
Generated on Thu Jul 25 2024 03:43:38 for clang by doxygen 1.9.6