class CommandTraits

Declaration

class CommandTraits { /* full declaration omitted */ };

Description

This class provides information about commands that can be used in comments.

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

Member Variables

private unsigned int NextID
private llvm::BumpPtrAllocator& Allocator
Allocator for CommandInfo objects.
private SmallVector<clang::comments::CommandInfo*, 4> RegisteredCommands

Method Overview

Methods

CommandTraits(
    llvm::BumpPtrAllocator& Allocator,
    const clang::CommentOptions& CommentOptions)

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

Parameters

llvm::BumpPtrAllocator& Allocator
const clang::CommentOptions& CommentOptions

CommandTraits(
    const clang::comments::CommandTraits&)

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

Parameters

const clang::comments::CommandTraits& 

clang::comments::CommandInfo*
createCommandInfoWithName(
    llvm::StringRef CommandName)

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

Parameters

llvm::StringRef CommandName

static const clang::comments::CommandInfo*
getBuiltinCommandInfo(llvm::StringRef Name)

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

Parameters

llvm::StringRef Name

Returns

a CommandInfo object for a given command name or NULL if \c Name is not a builtin command.

static const clang::comments::CommandInfo*
getBuiltinCommandInfo(unsigned int CommandID)

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

Parameters

unsigned int CommandID

Returns

a CommandInfo object for a given command ID or NULL if \c CommandID is not a builtin command.

const clang::comments::CommandInfo*
getCommandInfo(llvm::StringRef Name) const

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

Parameters

llvm::StringRef Name

const clang::comments::CommandInfo*
getCommandInfo(unsigned int CommandID) const

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

Parameters

unsigned int CommandID

const clang::comments::CommandInfo*
getCommandInfoOrNULL(llvm::StringRef Name) const

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

Parameters

llvm::StringRef Name

Returns

a CommandInfo object for a given command name or NULL if no CommandInfo object exists for this command.

const clang::comments::CommandInfo*
getRegisteredCommandInfo(
    llvm::StringRef Name) const

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

Parameters

llvm::StringRef Name

const clang::comments::CommandInfo*
getRegisteredCommandInfo(
    unsigned int CommandID) const

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

Parameters

unsigned int CommandID

const clang::comments::CommandInfo*
getTypoCorrectCommandInfo(
    llvm::StringRef Typo) const

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

Parameters

llvm::StringRef Typo

const clang::comments::CommandInfo*
registerBlockCommand(llvm::StringRef CommandName)

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

Parameters

llvm::StringRef CommandName

void registerCommentOptions(
    const clang::CommentOptions& CommentOptions)

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

Parameters

const clang::CommentOptions& CommentOptions

const clang::comments::CommandInfo*
registerUnknownCommand(
    llvm::StringRef CommandName)

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

Parameters

llvm::StringRef CommandName