|
clang
5.0.0
|
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. More...
#include "clang/AST/Comment.h"
Classes | |
| struct | Argument |
Static Public Member Functions | |
| static bool | classof (const Comment *C) |
Static Public Member Functions inherited from clang::comments::BlockContentComment | |
| static bool | classof (const Comment *C) |
Protected Member Functions | |
| BlockCommandComment (CommentKind K, SourceLocation LocBegin, SourceLocation LocEnd, unsigned CommandID, CommandMarkerKind CommandMarker) | |
Protected Member Functions inherited from clang::comments::BlockContentComment | |
| BlockContentComment (CommentKind K, SourceLocation LocBegin, SourceLocation LocEnd) | |
Protected Member Functions inherited from clang::comments::Comment | |
| void | setSourceRange (SourceRange SR) |
| void | setLocation (SourceLocation L) |
Protected Attributes | |
| ArrayRef< Argument > | Args |
| Word-like arguments. More... | |
| ParagraphComment * | Paragraph |
| Paragraph argument. More... | |
Protected Attributes inherited from clang::comments::Comment | |
| SourceLocation | Loc |
| Preferred location to show caret. More... | |
| SourceRange | Range |
| Source range of this AST node. More... | |
| union { | |
| CommentBitfields CommentBits | |
| InlineContentCommentBitfields InlineContentCommentBits | |
| TextCommentBitfields TextCommentBits | |
| InlineCommandCommentBitfields InlineCommandCommentBits | |
| HTMLTagCommentBitfields HTMLTagCommentBits | |
| HTMLStartTagCommentBitfields HTMLStartTagCommentBits | |
| ParagraphCommentBitfields ParagraphCommentBits | |
| BlockCommandCommentBitfields BlockCommandCommentBits | |
| ParamCommandCommentBitfields ParamCommandCommentBits | |
| }; | |
Additional Inherited Members | |
Public Types inherited from clang::comments::Comment | |
| enum | CommentKind { NoCommentKind = 0 } |
| typedef Comment *const * | child_iterator |
Protected Types inherited from clang::comments::Comment | |
| enum | { NumCommentBits = 8 } |
| enum | { NumInlineContentCommentBits = NumCommentBits + 1 } |
| enum | { NumTextCommentBits = NumInlineContentCommentBits + 2 } |
| enum | { NumInlineCommandCommentBits } |
| enum | { NumHTMLTagCommentBits = NumInlineContentCommentBits + 1 } |
| enum | { NumHTMLStartTagCommentBits = NumHTMLTagCommentBits + 1 } |
| enum | { NumParagraphCommentBits = NumCommentBits + 2 } |
| enum | { NumBlockCommandCommentBits } |
| enum | { NumParamCommandCommentBits = NumBlockCommandCommentBits + 3 } |
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).
|
inlineprotected |
Definition at line 619 of file Comment.h.
References clang::comments::Comment::BlockCommandCommentBits, getCommandNameBeginLoc(), and clang::comments::Comment::setLocation().
|
inline |
Definition at line 632 of file Comment.h.
References clang::comments::Comment::BlockCommandCommentBits, getCommandNameBeginLoc(), and clang::comments::Comment::setLocation().
|
inline |
|
inline |
Definition at line 643 of file Comment.h.
References clang::comments::Comment::getCommentKind().
|
inline |
Definition at line 682 of file Comment.h.
References Args.
Referenced by clang::comments::Sema::checkBlockCommandEmptyParagraph().
|
inline |
|
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().
|
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().
|
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().
|
inline |
Definition at line 664 of file Comment.h.
References clang::comments::Comment::getLocStart(), and clang::SourceLocation::getLocWithOffset().
Referenced by BlockCommandComment(), and getCommandNameRange().
|
inline |
Definition at line 668 of file Comment.h.
References getCommandName(), getCommandNameBeginLoc(), clang::comments::Comment::getLocStart(), and Name.
Referenced by clang::comments::Sema::actOnParamCommandStart(), clang::comments::Sema::actOnTParamCommandStart(), and clang::comments::Sema::checkBlockCommandEmptyParagraph().
|
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().
|
inline |
Definition at line 695 of file Comment.h.
References Paragraph.
Referenced by clang::comments::Sema::checkBlockCommandEmptyParagraph().
|
inline |
Definition at line 699 of file Comment.h.
References clang::comments::ParagraphComment::isWhitespace(), and Paragraph.
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().
|
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().
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().
|
protected |
Paragraph argument.
Definition at line 617 of file Comment.h.
Referenced by child_begin(), child_end(), getParagraph(), hasNonWhitespaceParagraph(), and setParagraph().
1.8.6