#include <Comment.h>
Detailed Description
A command that has zero or more word-like arguments (number of word-like arguments depends on command name) and a paragraph as an argument (e. g., \brief).
Constructor & Destructor Documentation
| clang::comments::BlockCommandComment::BlockCommandComment | ( | CommentKind | K, |
| SourceLocation | LocBegin, | ||
| SourceLocation | LocEnd, | ||
| unsigned | CommandID, | ||
| CommandMarkerKind | CommandMarker | ||
| ) | [inline, protected] |
Definition at line 619 of file Comment.h.
References clang::comments::Comment::BlockCommandCommentBits, getCommandNameBeginLoc(), and clang::comments::Comment::setLocation().
| clang::comments::BlockCommandComment::BlockCommandComment | ( | SourceLocation | LocBegin, |
| SourceLocation | LocEnd, | ||
| unsigned | CommandID, | ||
| CommandMarkerKind | CommandMarker | ||
| ) | [inline] |
Definition at line 632 of file Comment.h.
References clang::comments::Comment::BlockCommandCommentBits, getCommandNameBeginLoc(), and clang::comments::Comment::setLocation().
Member Function Documentation
| child_iterator clang::comments::BlockCommandComment::child_begin | ( | ) | const [inline] |
Reimplemented from clang::comments::Comment.
Reimplemented in clang::comments::VerbatimLineComment, and clang::comments::VerbatimBlockComment.
Definition at line 648 of file Comment.h.
References Paragraph.
| child_iterator clang::comments::BlockCommandComment::child_end | ( | ) | const [inline] |
Reimplemented from clang::comments::Comment.
Reimplemented in clang::comments::VerbatimLineComment, and clang::comments::VerbatimBlockComment.
Definition at line 652 of file Comment.h.
References Paragraph.
| static bool clang::comments::BlockCommandComment::classof | ( | const Comment * | C | ) | [inline, static] |
Reimplemented from clang::comments::BlockContentComment.
Reimplemented in clang::comments::VerbatimLineComment, clang::comments::VerbatimBlockComment, clang::comments::TParamCommandComment, and clang::comments::ParamCommandComment.
Definition at line 643 of file Comment.h.
References clang::comments::Comment::getCommentKind().
| SourceRange clang::comments::BlockCommandComment::getArgRange | ( | unsigned | Idx | ) | const [inline] |
Definition at line 682 of file Comment.h.
References Args.
Referenced by clang::comments::Sema::checkBlockCommandEmptyParagraph().
| StringRef clang::comments::BlockCommandComment::getArgText | ( | unsigned | Idx | ) | const [inline] |
| unsigned clang::comments::BlockCommandComment::getCommandID | ( | ) | const [inline] |
Definition at line 656 of file Comment.h.
References clang::comments::Comment::BlockCommandCommentBits.
Referenced by clang::comments::Sema::checkBlockCommandDuplicate(), clang::comments::Sema::checkBlockCommandEmptyParagraph(), clang::comments::Sema::checkContainerDecl(), clang::comments::Sema::checkContainerDeclVerbatimLine(), clang::comments::Sema::checkDeprecatedCommand(), clang::comments::Sema::checkFunctionDeclVerbatimLine(), clang::comments::Sema::checkReturnsCommand(), and getCommandName().
| CommandMarkerKind clang::comments::BlockCommandComment::getCommandMarker | ( | ) | const [inline] |
Definition at line 710 of file Comment.h.
References clang::comments::Comment::BlockCommandCommentBits.
Referenced by clang::comments::Sema::checkBlockCommandDuplicate(), clang::comments::Sema::checkBlockCommandEmptyParagraph(), clang::comments::Sema::checkContainerDecl(), clang::comments::Sema::checkContainerDeclVerbatimLine(), clang::comments::Sema::checkFunctionDeclVerbatimLine(), and clang::comments::Sema::checkReturnsCommand().
| StringRef clang::comments::BlockCommandComment::getCommandName | ( | const CommandTraits & | Traits | ) | const [inline] |
Definition at line 660 of file Comment.h.
References getCommandID(), clang::comments::CommandTraits::getCommandInfo(), and clang::comments::CommandInfo::Name.
Referenced by clang::comments::Sema::checkBlockCommandDuplicate(), clang::comments::Sema::checkBlockCommandEmptyParagraph(), clang::comments::Sema::checkReturnsCommand(), and getCommandNameRange().
| SourceLocation clang::comments::BlockCommandComment::getCommandNameBeginLoc | ( | ) | const [inline] |
Definition at line 664 of file Comment.h.
References clang::comments::Comment::getLocStart(), and clang::SourceLocation::getLocWithOffset().
Referenced by BlockCommandComment(), and getCommandNameRange().
| SourceRange clang::comments::BlockCommandComment::getCommandNameRange | ( | const CommandTraits & | Traits | ) | const [inline] |
Definition at line 668 of file Comment.h.
References getCommandName(), getCommandNameBeginLoc(), and clang::comments::Comment::getLocStart().
Referenced by clang::comments::Sema::actOnParamCommandStart(), clang::comments::Sema::actOnTParamCommandStart(), and clang::comments::Sema::checkBlockCommandEmptyParagraph().
| unsigned clang::comments::BlockCommandComment::getNumArgs | ( | ) | const [inline] |
Definition at line 674 of file Comment.h.
References Args.
Referenced by clang::comments::Sema::actOnParamCommandParamNameArg(), clang::comments::Sema::actOnTParamCommandParamNameArg(), clang::comments::Sema::checkBlockCommandEmptyParagraph(), clang::comments::ParamCommandComment::hasParamName(), and clang::comments::TParamCommandComment::hasParamName().
| ParagraphComment* clang::comments::BlockCommandComment::getParagraph | ( | ) | const [inline] |
Definition at line 695 of file Comment.h.
References Paragraph.
Referenced by clang::comments::Sema::checkBlockCommandEmptyParagraph().
| bool clang::comments::BlockCommandComment::hasNonWhitespaceParagraph | ( | ) | const [inline] |
Definition at line 699 of file Comment.h.
References clang::comments::ParagraphComment::isWhitespace(), and Paragraph.
| void clang::comments::BlockCommandComment::setArgs | ( | ArrayRef< Argument > | A | ) | [inline] |
Definition at line 686 of file Comment.h.
References Args, clang::comments::Comment::getLocStart(), clang::SourceLocation::isValid(), and clang::comments::Comment::setSourceRange().
Referenced by clang::comments::Sema::actOnBlockCommandArgs(), clang::comments::Sema::actOnParamCommandParamNameArg(), and clang::comments::Sema::actOnTParamCommandParamNameArg().
| void clang::comments::BlockCommandComment::setParagraph | ( | ParagraphComment * | PC | ) | [inline] |
Definition at line 703 of file Comment.h.
References clang::comments::Comment::getLocEnd(), clang::comments::Comment::getLocStart(), clang::SourceLocation::isValid(), Paragraph, and clang::comments::Comment::setSourceRange().
Referenced by clang::comments::Sema::actOnBlockCommandFinish(), clang::comments::Sema::actOnParamCommandFinish(), and clang::comments::Sema::actOnTParamCommandFinish().
Member Data Documentation
ArrayRef<Argument> clang::comments::BlockCommandComment::Args [protected] |
Word-like arguments.
Definition at line 614 of file Comment.h.
Referenced by getArgRange(), getArgText(), getNumArgs(), clang::comments::ParamCommandComment::getParamNameAsWritten(), clang::comments::TParamCommandComment::getParamNameAsWritten(), clang::comments::ParamCommandComment::getParamNameRange(), clang::comments::TParamCommandComment::getParamNameRange(), and setArgs().
Paragraph argument.
Definition at line 617 of file Comment.h.
Referenced by child_begin(), child_end(), getParagraph(), hasNonWhitespaceParagraph(), and setParagraph().
The documentation for this class was generated from the following file: