struct CommandInfo

Declaration

struct CommandInfo { /* full declaration omitted */ };

Description

Information about a single command. When reordering, adding or removing members please update the corresponding TableGen backend.

Declared at: clang/include/clang/AST/CommentCommandTraits.h:32

Member Variables

public const char* Name

public const char* EndCommandName

Name of the command that ends the verbatim block.

public unsigned int ID

The ID of the command.

public unsigned int NumArgs

Number of word-like arguments for a given block command, except for \ param and \ tparam commands -- these have special argument parsers.

public unsigned int IsInlineCommand

True if this command is a inline command (of any kind).

public unsigned int IsBlockCommand

True if this command is a block command (of any kind).

public unsigned int IsBriefCommand

True if this command is introducing a brief documentation paragraph (\oran alias).

public unsigned int IsReturnsCommand

True if this command is \ returns or an alias.

public unsigned int IsParamCommand

True if this command is introducing documentation for a function parameter ( \ param or an alias).

public unsigned int IsTParamCommand

True if this command is introducing documentation for a template parameter ( \ tparam or an alias).

public unsigned int IsThrowsCommand

True if this command is \ throws or an alias.

public unsigned int IsDeprecatedCommand

True if this command is \ deprecated or an alias.

public unsigned int IsHeaderfileCommand

True if this is a \ headerfile-like command.

public unsigned int IsEmptyParagraphAllowed

True if we don't want to warn about this command being passed an empty paragraph. Meaningful only for block commands.

public unsigned int IsVerbatimBlockCommand

A verbatim-like block command eats every character (except line starting decorations) until matching end command is seen or comment end is hit.

public unsigned int IsVerbatimBlockEndCommand

True if this command is an end command for a verbatim-like block.

public unsigned int IsVerbatimLineCommand

A verbatim-like line command eats everything until a newline is seen or comment end is hit.

public unsigned int IsDeclarationCommand

For example:

public unsigned int IsFunctionDeclarationCommand

True if verbatim-like line command is a function declaration.

public unsigned int IsRecordLikeDetailCommand

True if block command is further describing a container API; such as @ coclass, @ classdesign, etc.

public unsigned int IsRecordLikeDeclarationCommand

True if block command is a container API; such as @ interface.

public unsigned int IsUnknownCommand

True if this command is unknown. This \c CommandInfo object was created during parsing.

Method Overview

• public unsigned int getID() const

Methods

¶unsigned int getID() const

Declared at: clang/include/clang/AST/CommentCommandTraits.h:33