Doxygen comment parser. More...
#include "clang/AST/CommentParser.h"
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 389 of file CommentParser.cpp.
Member Function Documentation
◆ parseBlockCommand()
| BlockCommandComment * clang::comments::Parser::parseBlockCommand | ( | ) |
Definition at line 475 of file CommentParser.cpp.
References clang::comments::tok::at_command, clang::comments::tok::backslash_command, clang::Block, clang::cast(), clang::comments::CMK_At, clang::comments::CMK_Backslash, 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(), clang::comments::TextTokenRetokenizer::putBackLeftoverTokens(), and TextTokenRetokenizer.
Referenced by parseParagraphOrBlockCommand().
◆ parseBlockContent()
| BlockContentComment * clang::comments::Parser::parseBlockContent | ( | ) |
Definition at line 894 of file CommentParser.cpp.
References clang::comments::tok::at_command, clang::comments::tok::backslash_command, clang::comments::tok::eof, 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_at_command, clang::comments::tok::unknown_backslash_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 426 of file CommentParser.cpp.
References clang::comments::Token::getEndLocation(), clang::comments::Token::getLocation(), clang::comments::Token::getText(), clang::comments::TextTokenRetokenizer::lexWord(), and TextTokenRetokenizer.
Referenced by parseBlockCommand(), and parseInlineCommand().
◆ parseFullComment()
| FullComment * clang::comments::Parser::parseFullComment | ( | ) |
Definition at line 926 of file CommentParser.cpp.
References clang::comments::tok::eof, clang::comments::tok::newline, and parseBlockContent().
Referenced by clang::RawComment::parse().
◆ parseHTMLEndTag()
| HTMLEndTagComment * clang::comments::Parser::parseHTMLEndTag | ( | ) |
Definition at line 704 of file CommentParser.cpp.
References clang::comments::Token::getHTMLTagEndName(), clang::comments::Token::getLocation(), clang::comments::tok::html_end_tag, and clang::comments::tok::html_greater.
Referenced by parseParagraphOrBlockCommand().
◆ parseHTMLStartTag()
| HTMLStartTagComment * clang::comments::Parser::parseHTMLStartTag | ( | ) |
Definition at line 603 of file CommentParser.cpp.
References clang::comments::Token::getHTMLIdent(), clang::comments::Comment::getLocation(), clang::comments::Token::getLocation(), 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, and clang::comments::tok::html_start_tag.
Referenced by parseParagraphOrBlockCommand().
◆ parseInlineCommand()
| InlineCommandComment * clang::comments::Parser::parseInlineCommand | ( | ) |
Definition at line 573 of file CommentParser.cpp.
References clang::comments::tok::at_command, clang::comments::tok::backslash_command, clang::comments::CMK_At, clang::comments::CMK_Backslash, clang::comments::Token::getCommandID(), clang::comments::Token::getEndLocation(), clang::comments::Token::getLocation(), clang::SourceLocation::getLocWithOffset(), clang::comments::Token::is(), clang::comments::CommandInfo::Name, clang::comments::CommandInfo::NumArgs, parseCommandArgs(), clang::comments::TextTokenRetokenizer::putBackLeftoverTokens(), and TextTokenRetokenizer.
Referenced by parseParagraphOrBlockCommand().
◆ parseParagraphOrBlockCommand()
| BlockContentComment * clang::comments::Parser::parseParagraphOrBlockCommand | ( | ) |
Definition at line 719 of file CommentParser.cpp.
References clang::comments::tok::at_command, clang::comments::tok::backslash_command, clang::comments::CMK_At, clang::comments::CMK_Backslash, clang::comments::tok::eof, clang::comments::CommandInfo::getID(), 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::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_at_command, clang::comments::tok::unknown_backslash_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 397 of file CommentParser.cpp.
References clang::comments::Token::getEndLocation(), clang::comments::Token::getLocation(), clang::comments::Token::getText(), clang::comments::TextTokenRetokenizer::lexDelimitedSeq(), clang::comments::TextTokenRetokenizer::lexWord(), and TextTokenRetokenizer.
Referenced by parseBlockCommand().
◆ parseParCommandArgs()
| ArrayRef< Comment::Argument > clang::comments::Parser::parseParCommandArgs | ( | TextTokenRetokenizer & | Retokenizer, |
| unsigned | NumArgs ) |
Definition at line 458 of file CommentParser.cpp.
References clang::comments::Token::getEndLocation(), clang::comments::Token::getLocation(), clang::comments::Token::getText(), clang::comments::TextTokenRetokenizer::lexParHeading(), and TextTokenRetokenizer.
Referenced by parseBlockCommand().
◆ parseThrowCommandArgs()
| ArrayRef< Comment::Argument > clang::comments::Parser::parseThrowCommandArgs | ( | TextTokenRetokenizer & | Retokenizer, |
| unsigned | NumArgs ) |
Parse arguments for.
- Exceptions
-
command supported args are in form of class or template.
Definition at line 441 of file CommentParser.cpp.
References clang::comments::Token::getEndLocation(), clang::comments::Token::getLocation(), clang::comments::Token::getText(), clang::comments::TextTokenRetokenizer::lexType(), and TextTokenRetokenizer.
Referenced by parseBlockCommand().
◆ parseTParamCommandArgs()
| void clang::comments::Parser::parseTParamCommandArgs | ( | TParamCommandComment * | TPC, |
| TextTokenRetokenizer & | Retokenizer ) |
Parse arguments for \tparam command.
Definition at line 415 of file CommentParser.cpp.
References clang::comments::Token::getEndLocation(), clang::comments::Token::getLocation(), clang::comments::Token::getText(), clang::comments::TextTokenRetokenizer::lexWord(), and TextTokenRetokenizer.
Referenced by parseBlockCommand().
◆ parseVerbatimBlock()
| VerbatimBlockComment * clang::comments::Parser::parseVerbatimBlock | ( | ) |
Definition at line 822 of file CommentParser.cpp.
References clang::comments::Comment::getLocation(), 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 868 of file CommentParser.cpp.
References clang::comments::Token::getEndLocation(), clang::comments::Token::getLocation(), clang::comments::Token::getVerbatimLineID(), clang::Text, clang::comments::tok::verbatim_line_name, and clang::comments::tok::verbatim_line_text.
Referenced by parseBlockContent().
Friends And Related Symbol Documentation
◆ TextTokenRetokenizer
|
friend |
Definition at line 33 of file CommentParser.h.
References TextTokenRetokenizer.
Referenced by parseBlockCommand(), parseCommandArgs(), parseInlineCommand(), parseParamCommandArgs(), parseParCommandArgs(), parseThrowCommandArgs(), parseTParamCommandArgs(), and TextTokenRetokenizer.
The documentation for this class was generated from the following files:
- include/clang/AST/CommentParser.h
- lib/AST/CommentParser.cpp
Generated on for clang by
1.14.0