The base representation of an API record. Holds common symbol information. More...
#include "clang/ExtractAPI/API.h"
Inheritance diagram for clang::extractapi::APIRecord:
Collaboration diagram for clang::extractapi::APIRecord:
Classes | |
| struct | HierarchyInformation |
| Stores information about the context of the declaration of this API. More... | |
Public Types | |
| enum | RecordKind { RK_Unknown , RK_GlobalFunction , RK_GlobalVariable , RK_EnumConstant , RK_Enum , RK_StructField , RK_Struct , RK_ObjCInstanceProperty , RK_ObjCClassProperty , RK_ObjCIvar , RK_ObjCClassMethod , RK_ObjCInstanceMethod , RK_ObjCInterface , RK_ObjCCategory , RK_ObjCProtocol , RK_MacroDefinition , RK_Typedef } |
| Discriminator for LLVM-style RTTI (dyn_cast<> et al.) More... | |
Public Member Functions | |
| RecordKind | getKind () const |
| APIRecord ()=delete | |
| APIRecord (RecordKind Kind, StringRef USR, StringRef Name, PresumedLoc Location, AvailabilitySet Availabilities, LinkageInfo Linkage, const DocComment &Comment, DeclarationFragments Declaration, DeclarationFragments SubHeading, bool IsFromSystemHeader) | |
| virtual | ~APIRecord ()=0 |
Public Attributes | |
| StringRef | USR |
| StringRef | Name |
| PresumedLoc | Location |
| AvailabilitySet | Availabilities |
| 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. | |
| HierarchyInformation | ParentInformation |
| Information about the parent record of this record. | |
| bool | IsFromSystemHeader |
| Whether the symbol was defined in a system header. | |
Detailed Description
The base representation of an API record. Holds common symbol information.
Member Enumeration Documentation
◆ RecordKind
Discriminator for LLVM-style RTTI (dyn_cast<> et al.)
Constructor & Destructor Documentation
◆ APIRecord() [1/2]
|
delete |
◆ APIRecord() [2/2]
|
inline |
◆ ~APIRecord()
Member Function Documentation
◆ getKind()
|
inline |
Member Data Documentation
◆ Availabilities
| AvailabilitySet clang::extractapi::APIRecord::Availabilities |
◆ Comment
| DocComment clang::extractapi::APIRecord::Comment |
◆ Declaration
| DeclarationFragments clang::extractapi::APIRecord::Declaration |
◆ IsFromSystemHeader
| bool clang::extractapi::APIRecord::IsFromSystemHeader |
Whether the symbol was defined in a system header.
Definition at line 127 of file API.h.
Referenced by clang::extractapi::SymbolGraphSerializer::serializeSingleSymbolSGF().
◆ Linkage
| LinkageInfo clang::extractapi::APIRecord::Linkage |
◆ Location
| PresumedLoc clang::extractapi::APIRecord::Location |
Definition at line 105 of file API.h.
Referenced by clang::extractapi::SymbolGraphSerializer::serializeSingleSymbolSGF().
◆ Name
◆ ParentInformation
| HierarchyInformation clang::extractapi::APIRecord::ParentInformation |
◆ SubHeading
| DeclarationFragments clang::extractapi::APIRecord::SubHeading |
◆ USR
| StringRef clang::extractapi::APIRecord::USR |
Definition at line 103 of file API.h.
Referenced by clang::extractapi::SymbolGraphSerializer::serializeSingleSymbolSGF().
The documentation for this struct was generated from the following files:
