clang  6.0.0svn
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. More...
 
void parseTParamCommandArgs (TParamCommandComment *TPC, TextTokenRetokenizer &Retokenizer)
 Parse arguments for \tparam command. More...
 
void parseBlockCommandArgs (BlockCommandComment *BC, TextTokenRetokenizer &Retokenizer, unsigned NumArgs)
 
BlockCommandCommentparseBlockCommand ()
 
InlineCommandCommentparseInlineCommand ()
 
HTMLStartTagCommentparseHTMLStartTag ()
 
HTMLEndTagCommentparseHTMLEndTag ()
 
BlockContentCommentparseParagraphOrBlockCommand ()
 
VerbatimBlockCommentparseVerbatimBlock ()
 
VerbatimLineCommentparseVerbatimLine ()
 
BlockContentCommentparseBlockContent ()
 
FullCommentparseFullComment ()
 

Friends

class TextTokenRetokenizer
 

Detailed Description

Doxygen comment parser.

Definition at line 30 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 257 of file CommentParser.cpp.

Member Function Documentation

◆ parseBlockCommand()

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

◆ parseBlockCommandArgs()

void clang::comments::Parser::parseBlockCommandArgs ( BlockCommandComment BC,
TextTokenRetokenizer Retokenizer,
unsigned  NumArgs 
)

◆ parseBlockContent()

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

◆ parseFullComment()

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

◆ parseHTMLEndTag()

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

◆ parseHTMLStartTag()

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

◆ parseInlineCommand()

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

◆ parseParagraphOrBlockCommand()

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

Definition at line 553 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 
)

◆ parseTParamCommandArgs()

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

◆ parseVerbatimBlock()

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

◆ parseVerbatimLine()

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

Friends And Related Function Documentation

◆ TextTokenRetokenizer

friend class TextTokenRetokenizer
friend

Definition at line 34 of file CommentParser.h.


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