Doxygen \param command. More...
#include <Comment.h>
Public Types | |
| enum | PassDirection { In, Out, InOut } |
Public Member Functions | |
| ParamCommandComment (SourceLocation LocBegin, SourceLocation LocEnd, unsigned CommandID, CommandMarkerKind CommandMarker) | |
| PassDirection | getDirection () const LLVM_READONLY |
| bool | isDirectionExplicit () const LLVM_READONLY |
| void | setDirection (PassDirection Direction, bool Explicit) |
| bool | hasParamName () const |
| StringRef | getParamName (const FullComment *FC) const |
| StringRef | getParamNameAsWritten () const |
| SourceRange | getParamNameRange () const |
| bool | isParamIndexValid () const LLVM_READONLY |
| bool | isVarArgParam () const LLVM_READONLY |
| void | setIsVarArgParam () |
| unsigned | getParamIndex () const LLVM_READONLY |
| void | setParamIndex (unsigned Index) |
Static Public Member Functions | |
| static bool | classof (const Comment *C) |
| static const char * | getDirectionAsString (PassDirection D) |
Detailed Description
Member Enumeration Documentation
Constructor & Destructor Documentation
| clang::comments::ParamCommandComment::ParamCommandComment | ( | SourceLocation | LocBegin, |
| SourceLocation | LocEnd, | ||
| unsigned | CommandID, | ||
| CommandMarkerKind | CommandMarker | ||
| ) | [inline] |
Definition at line 728 of file Comment.h.
References In, and clang::comments::Comment::ParamCommandCommentBits.
Member Function Documentation
| static bool clang::comments::ParamCommandComment::classof | ( | const Comment * | C | ) | [inline, static] |
Reimplemented from clang::comments::BlockCommandComment.
Definition at line 739 of file Comment.h.
References clang::comments::Comment::getCommentKind().
| PassDirection clang::comments::ParamCommandComment::getDirection | ( | ) | const [inline] |
Definition at line 751 of file Comment.h.
References clang::comments::Comment::ParamCommandCommentBits.
| const char * clang::comments::ParamCommandComment::getDirectionAsString | ( | PassDirection | D | ) | [static] |
Definition at line 117 of file Comment.cpp.
References In, InOut, and Out.
Referenced by clang::comments::Sema::actOnParamCommandDirectionArg().
| unsigned clang::comments::ParamCommandComment::getParamIndex | ( | ) | const [inline] |
Definition at line 791 of file Comment.h.
References isParamIndexValid(), and isVarArgParam().
Referenced by getParamName().
| StringRef clang::comments::ParamCommandComment::getParamName | ( | const FullComment * | FC | ) | const |
Definition at line 324 of file Comment.cpp.
References clang::comments::FullComment::getDeclInfo(), getParamIndex(), isParamIndexValid(), isVarArgParam(), and clang::comments::DeclInfo::ParamVars.
| StringRef clang::comments::ParamCommandComment::getParamNameAsWritten | ( | ) | const [inline] |
Definition at line 770 of file Comment.h.
References clang::comments::BlockCommandComment::Args.
Referenced by clang::comments::Sema::resolveParamCommandIndexes().
| SourceRange clang::comments::ParamCommandComment::getParamNameRange | ( | ) | const [inline] |
Definition at line 774 of file Comment.h.
References clang::comments::BlockCommandComment::Args.
Referenced by clang::comments::Sema::resolveParamCommandIndexes().
| bool clang::comments::ParamCommandComment::hasParamName | ( | ) | const [inline] |
Definition at line 764 of file Comment.h.
References clang::comments::BlockCommandComment::getNumArgs().
Referenced by clang::comments::Sema::resolveParamCommandIndexes().
| bool clang::comments::ParamCommandComment::isDirectionExplicit | ( | ) | const [inline] |
Definition at line 755 of file Comment.h.
References clang::comments::Comment::ParamCommandCommentBits.
Referenced by clang::comments::Sema::actOnParamCommandParamNameArg().
| bool clang::comments::ParamCommandComment::isParamIndexValid | ( | ) | const [inline] |
Definition at line 778 of file Comment.h.
References InvalidParamIndex.
Referenced by getParamIndex(), getParamName(), setIsVarArgParam(), and setParamIndex().
| bool clang::comments::ParamCommandComment::isVarArgParam | ( | ) | const [inline] |
Definition at line 782 of file Comment.h.
References VarArgParamIndex.
Referenced by getParamIndex(), getParamName(), and setParamIndex().
| void clang::comments::ParamCommandComment::setDirection | ( | PassDirection | Direction, |
| bool | Explicit | ||
| ) | [inline] |
Definition at line 759 of file Comment.h.
References clang::comments::Comment::ParamCommandCommentBits.
Referenced by clang::comments::Sema::actOnParamCommandDirectionArg(), and clang::comments::Sema::actOnParamCommandParamNameArg().
| void clang::comments::ParamCommandComment::setIsVarArgParam | ( | ) | [inline] |
Definition at line 786 of file Comment.h.
References isParamIndexValid(), and VarArgParamIndex.
Referenced by clang::comments::Sema::resolveParamCommandIndexes().
| void clang::comments::ParamCommandComment::setParamIndex | ( | unsigned | Index | ) | [inline] |
Definition at line 797 of file Comment.h.
References isParamIndexValid(), and isVarArgParam().
Referenced by clang::comments::Sema::resolveParamCommandIndexes().
The documentation for this class was generated from the following files: