This holds information associated with global functions. More...

#include "clang/ExtractAPI/API.h"

Inheritance diagram for clang::extractapi::GlobalFunctionRecord:

[legend]

Public Member Functions
	GlobalFunctionRecord (StringRef USR, StringRef Name, SymbolReference Parent, PresumedLoc Loc, AvailabilityInfo Availability, LinkageInfo Linkage, const DocComment &Comment, DeclarationFragments Declaration, DeclarationFragments SubHeading, FunctionSignature Signature, bool IsFromSystemHeader)

	GlobalFunctionRecord (RecordKind Kind, StringRef USR, StringRef Name, SymbolReference Parent, PresumedLoc Loc, AvailabilityInfo Availability, LinkageInfo Linkage, const DocComment &Comment, DeclarationFragments Declaration, DeclarationFragments SubHeading, FunctionSignature Signature, bool IsFromSystemHeader)

Public Member Functions inherited from clang::extractapi::APIRecord
APIRecord *	getNextInContext () const

RecordKind	getKind () const

	APIRecord ()=delete

	APIRecord (RecordKind Kind, StringRef USR, StringRef Name, SymbolReference Parent, PresumedLoc Location, AvailabilityInfo Availability, LinkageInfo Linkage, const DocComment &Comment, DeclarationFragments Declaration, DeclarationFragments SubHeading, bool IsFromSystemHeader, AccessControl Access=AccessControl())

	APIRecord (RecordKind Kind, StringRef USR, StringRef Name)

virtual	~APIRecord ()=0

Static Public Member Functions
static bool	classof (const APIRecord *Record)

static bool	classofKind (RecordKind K)

Static Public Member Functions inherited from clang::extractapi::APIRecord
static APIRecord *	castFromRecordContext (const RecordContext *Ctx)

static RecordContext *	castToRecordContext (const APIRecord *Record)

static bool	classof (const APIRecord *Record)

static bool	classofKind (RecordKind K)

static bool	classof (const RecordContext *Ctx)

Public Attributes
FunctionSignature	Signature

Public Attributes inherited from clang::extractapi::APIRecord
StringRef	USR

StringRef	Name

SymbolReference	Parent

PresumedLoc	Location

AvailabilityInfo	Availability

LinkageInfo	Linkage

DocComment	Comment
	Documentation comment lines attached to this symbol declaration.

DeclarationFragments	Declaration
	Declaration fragments of this symbol declaration.

DeclarationFragments	SubHeading
	SubHeading provides a more detailed representation than the plain declaration name.

bool	IsFromSystemHeader
	Whether the symbol was defined in a system header.

AccessControl	Access

Additional Inherited Members
Public Types inherited from clang::extractapi::APIRecord
enum	RecordKind { RK_Unknown , RK_FirstRecordContext , RK_Namespace , RK_Enum , RK_Struct , RK_Union , RK_ObjCInterface , RK_ObjCCategory , RK_ObjCProtocol , RK_CXXClass , RK_ClassTemplate , RK_ClassTemplateSpecialization , RK_ClassTemplatePartialSpecialization , RK_StructField , RK_UnionField , RK_CXXField , RK_StaticField , RK_CXXFieldTemplate , RK_GlobalVariable , RK_GlobalVariableTemplate , RK_GlobalVariableTemplateSpecialization , RK_GlobalVariableTemplatePartialSpecialization , RK_LastRecordContext , RK_GlobalFunction , RK_GlobalFunctionTemplate , RK_GlobalFunctionTemplateSpecialization , RK_EnumConstant , RK_Concept , RK_CXXStaticMethod , RK_CXXInstanceMethod , RK_CXXConstructorMethod , RK_CXXDestructorMethod , RK_CXXMethodTemplate , RK_CXXMethodTemplateSpecialization , RK_ObjCInstanceProperty , RK_ObjCClassProperty , RK_ObjCIvar , RK_ObjCClassMethod , RK_ObjCInstanceMethod , RK_MacroDefinition , RK_Typedef }
	Discriminator for LLVM-style RTTI (dyn_cast<> et al.) More...

Detailed Description

This holds information associated with global functions.

Definition at line 402 of file API.h.

Constructor & Destructor Documentation

◆ GlobalFunctionRecord() [1/2]

clang::extractapi::GlobalFunctionRecord::GlobalFunctionRecord	(	StringRef	USR,
		StringRef	Name,
		SymbolReference	Parent,
		PresumedLoc	Loc,
		AvailabilityInfo	Availability,
		LinkageInfo	Linkage,
		const DocComment &	Comment,
		DeclarationFragments	Declaration,
		DeclarationFragments	SubHeading,
		FunctionSignature	Signature,
		bool	IsFromSystemHeader
	)

inline

Definition at line 405 of file API.h.

◆ GlobalFunctionRecord() [2/2]

clang::extractapi::GlobalFunctionRecord::GlobalFunctionRecord	(	RecordKind	Kind,
		StringRef	USR,
		StringRef	Name,
		SymbolReference	Parent,
		PresumedLoc	Loc,
		AvailabilityInfo	Availability,
		LinkageInfo	Linkage,
		const DocComment &	Comment,
		DeclarationFragments	Declaration,
		DeclarationFragments	SubHeading,
		FunctionSignature	Signature,
		bool	IsFromSystemHeader
	)

inline

Definition at line 416 of file API.h.

Member Function Documentation

◆ classof()

static bool clang::extractapi::GlobalFunctionRecord::classof ( const APIRecord * Record )

inlinestatic

Definition at line 428 of file API.h.

References classofKind().

◆ classofKind()

static bool clang::extractapi::GlobalFunctionRecord::classofKind ( RecordKind K )

inlinestatic

Definition at line 431 of file API.h.

References clang::extractapi::APIRecord::RK_GlobalFunction.

Referenced by classof().

Member Data Documentation

◆ Signature

FunctionSignature clang::extractapi::GlobalFunctionRecord::Signature

Definition at line 403 of file API.h.

The documentation for this struct was generated from the following files:

include/clang/ExtractAPI/API.h
lib/ExtractAPI/API.cpp

Public Member Functions

Static Public Member Functions

Public Attributes

Additional Inherited Members