Information about a single command. More...
#include <CommentCommandTraits.h>
Public Types | |
| enum | { NumCommandIDBits = 20 } |
| DRY definition of the number of bits used for a command ID. More... | |
Public Member Functions | |
| unsigned | getID () const |
Public Attributes | |
| const char * | Name |
| const char * | EndCommandName |
| Name of the command that ends the verbatim block. | |
| unsigned | ID: NumCommandIDBits |
| The ID of the command. | |
| unsigned | NumArgs: 4 |
| unsigned | IsInlineCommand: 1 |
| True if this command is a inline command (of any kind). | |
| unsigned | IsBlockCommand: 1 |
| True if this command is a block command (of any kind). | |
| unsigned | IsBriefCommand: 1 |
| unsigned | IsReturnsCommand: 1 |
| True if this command is \returns or an alias. | |
| unsigned | IsParamCommand: 1 |
| unsigned | IsTParamCommand: 1 |
| unsigned | IsThrowsCommand: 1 |
| True if this command is \throws or an alias. | |
| unsigned | IsDeprecatedCommand: 1 |
| True if this command is \deprecated or an alias. | |
| unsigned | IsHeaderfileCommand: 1 |
| True if this is a \headerfile-like command. | |
| unsigned | IsEmptyParagraphAllowed: 1 |
| unsigned | IsVerbatimBlockCommand: 1 |
| True if this command is a verbatim-like block command. | |
| unsigned | IsVerbatimBlockEndCommand: 1 |
| True if this command is an end command for a verbatim-like block. | |
| unsigned | IsVerbatimLineCommand: 1 |
| True if this command is a verbatim line command. | |
| unsigned | IsDeclarationCommand: 1 |
| True if this command contains a declaration for the entity being documented. | |
| unsigned | IsFunctionDeclarationCommand: 1 |
| True if verbatim-like line command is a function declaration. | |
| unsigned | IsRecordLikeDetailCommand: 1 |
| True if block command is further describing a container API; such as @coclass, @classdesign, etc. | |
| unsigned | IsRecordLikeDeclarationCommand: 1 |
| True if block command is a container API; such as @interface. | |
| unsigned | IsUnknownCommand: 1 |
True if this command is unknown. This CommandInfo object was created during parsing. | |
Detailed Description
Information about a single command.
When reordering, adding or removing members please update the corresponding TableGen backend.
Definition at line 33 of file CommentCommandTraits.h.
Member Enumeration Documentation
| anonymous enum |
DRY definition of the number of bits used for a command ID.
Definition at line 44 of file CommentCommandTraits.h.
Member Function Documentation
| unsigned clang::comments::CommandInfo::getID | ( | ) | const [inline] |
Definition at line 34 of file CommentCommandTraits.h.
References ID.
Referenced by clang::comments::Sema::actOnUnknownCommand(), and clang::comments::Parser::parseParagraphOrBlockCommand().
Member Data Documentation
| const char* clang::comments::CommandInfo::EndCommandName |
Name of the command that ends the verbatim block.
Definition at line 41 of file CommentCommandTraits.h.
True if this command is a block command (of any kind).
Definition at line 57 of file CommentCommandTraits.h.
Referenced by clang::comments::BriefParser::Parse(), clang::comments::Parser::parseParagraphOrBlockCommand(), and clang::comments::CommandTraits::registerBlockCommand().
True if this command is introducing a brief documentation paragraph (\brief or an alias).
Definition at line 61 of file CommentCommandTraits.h.
Referenced by clang::comments::Sema::checkBlockCommandDuplicate(), and clang::comments::BriefParser::Parse().
True if this command contains a declaration for the entity being documented.
For example:
\fn void f(int a);
Definition at line 109 of file CommentCommandTraits.h.
True if this command is \deprecated or an alias.
Definition at line 78 of file CommentCommandTraits.h.
True if we don't want to warn about this command being passed an empty paragraph. Meaningful only for block commands.
Definition at line 85 of file CommentCommandTraits.h.
True if verbatim-like line command is a function declaration.
Definition at line 112 of file CommentCommandTraits.h.
Referenced by clang::comments::Sema::checkFunctionDeclVerbatimLine().
True if this is a \headerfile-like command.
Definition at line 81 of file CommentCommandTraits.h.
Referenced by clang::comments::Sema::checkBlockCommandDuplicate().
True if this command is a inline command (of any kind).
Definition at line 54 of file CommentCommandTraits.h.
Referenced by clang::comments::Sema::getInlineCommandRenderKind(), and clang::comments::Parser::parseParagraphOrBlockCommand().
True if this command is introducing documentation for a function parameter (\param or an alias).
Definition at line 68 of file CommentCommandTraits.h.
Referenced by clang::comments::Parser::parseBlockCommand().
True if block command is a container API; such as @interface.
Definition at line 119 of file CommentCommandTraits.h.
Referenced by clang::comments::Sema::checkContainerDeclVerbatimLine().
True if block command is further describing a container API; such as @coclass, @classdesign, etc.
Definition at line 116 of file CommentCommandTraits.h.
Referenced by clang::comments::Sema::checkContainerDecl().
True if this command is \returns or an alias.
Definition at line 64 of file CommentCommandTraits.h.
Referenced by clang::comments::BriefParser::Parse().
True if this command is \throws or an alias.
Definition at line 75 of file CommentCommandTraits.h.
True if this command is introducing documentation for a template parameter (\tparam or an alias).
Definition at line 72 of file CommentCommandTraits.h.
Referenced by clang::comments::Parser::parseBlockCommand().
True if this command is unknown. This CommandInfo object was created during parsing.
Definition at line 123 of file CommentCommandTraits.h.
Referenced by clang::comments::Parser::parseParagraphOrBlockCommand(), and clang::comments::CommandTraits::registerUnknownCommand().
True if this command is a verbatim-like block command.
A verbatim-like block command eats every character (except line starting decorations) until matching end command is seen or comment end is hit.
Definition at line 91 of file CommentCommandTraits.h.
True if this command is an end command for a verbatim-like block.
Definition at line 94 of file CommentCommandTraits.h.
Referenced by clang::comments::Parser::parseParagraphOrBlockCommand().
True if this command is a verbatim line command.
A verbatim-like line command eats everything until a newline is seen or comment end is hit.
Definition at line 100 of file CommentCommandTraits.h.
| const char* clang::comments::CommandInfo::Name |
Definition at line 38 of file CommentCommandTraits.h.
Referenced by clang::comments::Sema::actOnInlineCommand(), clang::comments::Sema::actOnVerbatimBlockStart(), clang::comments::InlineCommandComment::getCommandName(), clang::comments::BlockCommandComment::getCommandName(), clang::comments::Parser::parseParagraphOrBlockCommand(), and clang::comments::Parser::parseVerbatimBlock().
Number of word-like arguments for a given block command, except for \param and \tparam commands -- these have special argument parsers.
Definition at line 51 of file CommentCommandTraits.h.
Referenced by clang::comments::Parser::parseBlockCommand().
The documentation for this struct was generated from the following file: