clang 17.0.0git
Public Member Functions | Public Attributes | List of all members
clang::extractapi::APIRecord::HierarchyInformation Struct Reference

Stores information about the context of the declaration of this API. More...

#include "clang/ExtractAPI/API.h"

Collaboration diagram for clang::extractapi::APIRecord::HierarchyInformation:
Collaboration graph
[legend]

Public Member Functions

 HierarchyInformation ()=default
 
 HierarchyInformation (StringRef ParentUSR, StringRef ParentName, RecordKind Kind, APIRecord *ParentRecord=nullptr)
 
bool empty () const
 

Public Attributes

StringRef ParentUSR
 The USR of the parent API.
 
StringRef ParentName
 The name of the parent API.
 
RecordKind ParentKind = RK_Unknown
 The record kind of the parent API.
 
APIRecordParentRecord = nullptr
 A pointer to the parent APIRecord if known.
 

Detailed Description

Stores information about the context of the declaration of this API.

This is roughly analogous to the DeclContext hierarchy for an AST Node.

Definition at line 81 of file API.h.

Constructor & Destructor Documentation

◆ HierarchyInformation() [1/2]

clang::extractapi::APIRecord::HierarchyInformation::HierarchyInformation ( )
default

◆ HierarchyInformation() [2/2]

clang::extractapi::APIRecord::HierarchyInformation::HierarchyInformation ( StringRef  ParentUSR,
StringRef  ParentName,
RecordKind  Kind,
APIRecord ParentRecord = nullptr 
)
inline

Definition at line 92 of file API.h.

Member Function Documentation

◆ empty()

bool clang::extractapi::APIRecord::HierarchyInformation::empty ( ) const
inline

Member Data Documentation

◆ ParentKind

RecordKind clang::extractapi::APIRecord::HierarchyInformation::ParentKind = RK_Unknown

The record kind of the parent API.

Definition at line 87 of file API.h.

Referenced by empty().

◆ ParentName

StringRef clang::extractapi::APIRecord::HierarchyInformation::ParentName

The name of the parent API.

Definition at line 85 of file API.h.

Referenced by empty().

◆ ParentRecord

APIRecord* clang::extractapi::APIRecord::HierarchyInformation::ParentRecord = nullptr

A pointer to the parent APIRecord if known.

Definition at line 89 of file API.h.

Referenced by empty().

◆ ParentUSR

StringRef clang::extractapi::APIRecord::HierarchyInformation::ParentUSR

The USR of the parent API.

Definition at line 83 of file API.h.

Referenced by empty().


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