class DeclarationFragmentsBuilder

Declaration

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

Description

A factory class to build DeclarationFragments for different kinds of Decl.

Declared at: clang/include/clang/ExtractAPI/DeclarationFragments.h:185

Method Overview

  • private DeclarationFragmentsBuilder()
  • public static clang::extractapi::DeclarationFragments getFragmentsForEnum(const clang::EnumDecl *)
  • public static clang::extractapi::DeclarationFragments getFragmentsForEnumConstant(const clang::EnumConstantDecl *)
  • public static clang::extractapi::DeclarationFragments getFragmentsForField(const clang::FieldDecl *)
  • public static clang::extractapi::DeclarationFragments getFragmentsForFunction(const clang::FunctionDecl *)
  • public static clang::extractapi::DeclarationFragments getFragmentsForMacro(llvm::StringRef Name, const clang::MacroDirective * MD)
  • private static clang::extractapi::DeclarationFragments getFragmentsForNNS(const clang::NestedNameSpecifier *, clang::ASTContext &, clang::extractapi::DeclarationFragments &)
  • public static clang::extractapi::DeclarationFragments getFragmentsForObjCCategory(const clang::ObjCCategoryDecl *)
  • public static clang::extractapi::DeclarationFragments getFragmentsForObjCInterface(const clang::ObjCInterfaceDecl *)
  • public static clang::extractapi::DeclarationFragments getFragmentsForObjCMethod(const clang::ObjCMethodDecl *)
  • public static clang::extractapi::DeclarationFragments getFragmentsForObjCProperty(const clang::ObjCPropertyDecl *)
  • public static clang::extractapi::DeclarationFragments getFragmentsForObjCProtocol(const clang::ObjCProtocolDecl *)
  • private static clang::extractapi::DeclarationFragments getFragmentsForParam(const clang::ParmVarDecl *)
  • private static clang::extractapi::DeclarationFragments getFragmentsForQualifiers(const clang::Qualifiers quals)
  • public static clang::extractapi::DeclarationFragments getFragmentsForStruct(const clang::RecordDecl *)
  • private static clang::extractapi::DeclarationFragments getFragmentsForType(const clang::QualType, clang::ASTContext &, clang::extractapi::DeclarationFragments &)
  • private static clang::extractapi::DeclarationFragments getFragmentsForType(const clang::Type *, clang::ASTContext &, clang::extractapi::DeclarationFragments &)
  • public static clang::extractapi::DeclarationFragments getFragmentsForTypedef(const clang::TypedefNameDecl * Decl)
  • public static clang::extractapi::DeclarationFragments getFragmentsForVar(const clang::VarDecl *)
  • public template <typename FunctionT>static clang::extractapi::FunctionSignature getFunctionSignature(const FunctionT *)
  • public static clang::extractapi::DeclarationFragments getSubHeading(const clang::ObjCMethodDecl *)
  • public static clang::extractapi::DeclarationFragments getSubHeading(const clang::NamedDecl *)
  • public static clang::extractapi::DeclarationFragments getSubHeadingForMacro(llvm::StringRef Name)

Methods

DeclarationFragmentsBuilder()

Declared at: clang/include/clang/ExtractAPI/DeclarationFragments.h:261

static clang::extractapi::DeclarationFragments
getFragmentsForEnum(const clang::EnumDecl*)

Description

Build DeclarationFragments for an enum declaration EnumDecl.

Declared at: clang/include/clang/ExtractAPI/DeclarationFragments.h:199

Parameters

const clang::EnumDecl* 

static clang::extractapi::DeclarationFragments
getFragmentsForEnumConstant(
    const clang::EnumConstantDecl*)

Description

Build DeclarationFragments for an enum constant declaration EnumConstantDecl.

Declared at: clang/include/clang/ExtractAPI/DeclarationFragments.h:196

Parameters

const clang::EnumConstantDecl* 

static clang::extractapi::DeclarationFragments
getFragmentsForField(const clang::FieldDecl*)

Description

Build DeclarationFragments for a field declaration FieldDecl.

Declared at: clang/include/clang/ExtractAPI/DeclarationFragments.h:202

Parameters

const clang::FieldDecl* 

static clang::extractapi::DeclarationFragments
getFragmentsForFunction(
    const clang::FunctionDecl*)

Description

Build DeclarationFragments for a function declaration FunctionDecl.

Declared at: clang/include/clang/ExtractAPI/DeclarationFragments.h:191

Parameters

const clang::FunctionDecl* 

static clang::extractapi::DeclarationFragments
getFragmentsForMacro(
    llvm::StringRef Name,
    const clang::MacroDirective* MD)

Description

Build DeclarationFragments for a macro.

Declared at: clang/include/clang/ExtractAPI/DeclarationFragments.h:235

Parameters

llvm::StringRef Name
name of the macro.
const clang::MacroDirective* MD
the associated MacroDirective.

static clang::extractapi::DeclarationFragments
getFragmentsForNNS(
    const clang::NestedNameSpecifier*,
    clang::ASTContext&,
    clang::extractapi::DeclarationFragments&)

Description

Build DeclarationFragments for a NestedNameSpecifier.

Declared at: clang/include/clang/ExtractAPI/DeclarationFragments.h:272

Parameters

const clang::NestedNameSpecifier*
clang::ASTContext&
clang::extractapi::DeclarationFragments& 

static clang::extractapi::DeclarationFragments
getFragmentsForObjCCategory(
    const clang::ObjCCategoryDecl*)

Description

Build DeclarationFragments for an Objective-C category declaration ObjCCategoryDecl.

Declared at: clang/include/clang/ExtractAPI/DeclarationFragments.h:210

Parameters

const clang::ObjCCategoryDecl* 

static clang::extractapi::DeclarationFragments
getFragmentsForObjCInterface(
    const clang::ObjCInterfaceDecl*)

Description

Build DeclarationFragments for an Objective-C interface declaration ObjCInterfaceDecl.

Declared at: clang/include/clang/ExtractAPI/DeclarationFragments.h:215

Parameters

const clang::ObjCInterfaceDecl* 

static clang::extractapi::DeclarationFragments
getFragmentsForObjCMethod(
    const clang::ObjCMethodDecl*)

Description

Build DeclarationFragments for an Objective-C method declaration ObjCMethodDecl.

Declared at: clang/include/clang/ExtractAPI/DeclarationFragments.h:219

Parameters

const clang::ObjCMethodDecl* 

static clang::extractapi::DeclarationFragments
getFragmentsForObjCProperty(
    const clang::ObjCPropertyDecl*)

Description

Build DeclarationFragments for an Objective-C property declaration ObjCPropertyDecl.

Declared at: clang/include/clang/ExtractAPI/DeclarationFragments.h:224

Parameters

const clang::ObjCPropertyDecl* 

static clang::extractapi::DeclarationFragments
getFragmentsForObjCProtocol(
    const clang::ObjCProtocolDecl*)

Description

Build DeclarationFragments for an Objective-C protocol declaration ObjCProtocolDecl.

Declared at: clang/include/clang/ExtractAPI/DeclarationFragments.h:229

Parameters

const clang::ObjCProtocolDecl* 

static clang::extractapi::DeclarationFragments
getFragmentsForParam(const clang::ParmVarDecl*)

Description

Build DeclarationFragments for a parameter variable declaration ParmVarDecl.

Declared at: clang/include/clang/ExtractAPI/DeclarationFragments.h:281

Parameters

const clang::ParmVarDecl* 

static clang::extractapi::DeclarationFragments
getFragmentsForQualifiers(
    const clang::Qualifiers quals)

Description

Build DeclarationFragments for Qualifiers.

Declared at: clang/include/clang/ExtractAPI/DeclarationFragments.h:277

Parameters

const clang::Qualifiers quals

static clang::extractapi::DeclarationFragments
getFragmentsForStruct(const clang::RecordDecl*)

Description

Build DeclarationFragments for a struct record declaration RecordDecl.

Declared at: clang/include/clang/ExtractAPI/DeclarationFragments.h:205

Parameters

const clang::RecordDecl* 

static clang::extractapi::DeclarationFragments
getFragmentsForType(
    const clang::QualType,
    clang::ASTContext&,
    clang::extractapi::DeclarationFragments&)

Description

Build DeclarationFragments for a QualType.

Declared at: clang/include/clang/ExtractAPI/DeclarationFragments.h:264

Parameters

const clang::QualType
clang::ASTContext&
clang::extractapi::DeclarationFragments& 

static clang::extractapi::DeclarationFragments
getFragmentsForType(
    const clang::Type*,
    clang::ASTContext&,
    clang::extractapi::DeclarationFragments&)

Description

Build DeclarationFragments for a Type.

Declared at: clang/include/clang/ExtractAPI/DeclarationFragments.h:268

Parameters

const clang::Type*
clang::ASTContext&
clang::extractapi::DeclarationFragments& 

static clang::extractapi::DeclarationFragments
getFragmentsForTypedef(
    const clang::TypedefNameDecl* Decl)

Description

Build DeclarationFragments for a typedef \p TypedefNameDecl.

Declared at: clang/include/clang/ExtractAPI/DeclarationFragments.h:240

Parameters

const clang::TypedefNameDecl* Decl

static clang::extractapi::DeclarationFragments
getFragmentsForVar(const clang::VarDecl*)

Description

Build DeclarationFragments for a variable declaration VarDecl.

Declared at: clang/include/clang/ExtractAPI/DeclarationFragments.h:188

Parameters

const clang::VarDecl* 

template <typename FunctionT>
static clang::extractapi::FunctionSignature
getFunctionSignature(const FunctionT*)

Description

Build FunctionSignature for a function-like declaration \c FunctionT like FunctionDecl or ObjCMethodDecl. The logic and implementation of building a signature for a FunctionDecl and an ObjCMethodDecl are exactly the same, but they do not share a common base. This template helps reuse the code.

Declared at: clang/include/clang/ExtractAPI/DeclarationFragments.h:258

Templates

FunctionT

Parameters

const FunctionT* 

static clang::extractapi::DeclarationFragments
getSubHeading(const clang::ObjCMethodDecl*)

Description

Build sub-heading fragments for an Objective-C method.

Declared at: clang/include/clang/ExtractAPI/DeclarationFragments.h:246

Parameters

const clang::ObjCMethodDecl* 

static clang::extractapi::DeclarationFragments
getSubHeading(const clang::NamedDecl*)

Description

Build sub-heading fragments for a NamedDecl.

Declared at: clang/include/clang/ExtractAPI/DeclarationFragments.h:243

Parameters

const clang::NamedDecl* 

static clang::extractapi::DeclarationFragments
getSubHeadingForMacro(llvm::StringRef Name)

Description

Build a sub-heading for macro \p Name.

Declared at: clang/include/clang/ExtractAPI/DeclarationFragments.h:249

Parameters

llvm::StringRef Name