struct APIRecord

Declaration

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

Description

The base representation of an API record. Holds common symbol information.

Declared at: clang/include/clang/ExtractAPI/API.h:57

Member Variables

public llvm::StringRef USR

public llvm::StringRef Name

public clang::PresumedLoc Location

public clang::extractapi::AvailabilityInfo Availability

public clang::LinkageInfo Linkage

public clang::extractapi::DocComment Comment

Documentation comment lines attached to this symbol declaration.

public clang::extractapi::DeclarationFragments Declaration

Declaration fragments of this symbol declaration.

public clang::extractapi::DeclarationFragments SubHeading

SubHeading is an array of declaration fragments of tagged declaration name, with potentially more tokens (for example the \c +/- symbol for Objective-C class/instance methods).

private const clang::extractapi::APIRecord::RecordKind Kind

Method Overview

• public APIRecord()
• public APIRecord(clang::extractapi::APIRecord::RecordKind Kind, llvm::StringRef USR, llvm::StringRef Name, clang::PresumedLoc Location, const clang::extractapi::AvailabilityInfo & Availability, clang::LinkageInfo Linkage, const clang::extractapi::DocComment & Comment, clang::extractapi::DeclarationFragments Declaration, clang::extractapi::DeclarationFragments SubHeading)
• public clang::extractapi::APIRecord::RecordKind getKind() const
• public virtual ~APIRecord()

Methods

¶APIRecord()

Declared at: clang/include/clang/ExtractAPI/API.h:102

¶APIRecord(
    clang::extractapi::APIRecord::RecordKind Kind,
    llvm::StringRef USR,
    llvm::StringRef Name,
    clang::PresumedLoc Location,
    const clang::extractapi::AvailabilityInfo&
        Availability,
    clang::LinkageInfo Linkage,
    const clang::extractapi::DocComment& Comment,
    clang::extractapi::DeclarationFragments
        Declaration,
    clang::extractapi::DeclarationFragments
        SubHeading)

Declared at: clang/include/clang/ExtractAPI/API.h:104

Parameters

clang::extractapi::APIRecord::RecordKind Kind

llvm::StringRef USR

llvm::StringRef Name

clang::PresumedLoc Location

const clang::extractapi::AvailabilityInfo& Availability

clang::LinkageInfo Linkage

const clang::extractapi::DocComment& Comment

clang::extractapi::DeclarationFragments Declaration

clang::extractapi::DeclarationFragments SubHeading

¶clang::extractapi::APIRecord::RecordKind getKind()
    const

Declared at: clang/include/clang/ExtractAPI/API.h:100

¶virtual ~APIRecord()

Declared at: clang/include/clang/ExtractAPI/API.h:113