clang-tools  16.0.0git
Public Member Functions | Public Attributes | List of all members
clang::doc::RecordInfo Struct Reference

#include <Representation.h>

Inheritance diagram for clang::doc::RecordInfo:
Inheritance graph
[legend]
Collaboration diagram for clang::doc::RecordInfo:
Collaboration graph
[legend]

Public Member Functions

 RecordInfo (SymbolID USR=SymbolID(), StringRef Name=StringRef(), StringRef Path=StringRef())
 
void merge (RecordInfo &&I)
 
- Public Member Functions inherited from clang::doc::SymbolInfo
 SymbolInfo (InfoType IT, SymbolID USR=SymbolID(), StringRef Name=StringRef(), StringRef Path=StringRef())
 
void merge (SymbolInfo &&I)
 
- Public Member Functions inherited from clang::doc::Info
 Info (InfoType IT=InfoType::IT_default, SymbolID USR=SymbolID(), StringRef Name=StringRef(), StringRef Path=StringRef())
 
 Info (const Info &Other)=delete
 
 Info (Info &&Other)=default
 
virtual ~Info ()=default
 
void mergeBase (Info &&I)
 
bool mergeable (const Info &Other)
 
llvm::SmallString< 16 > extractName () const
 
llvm::SmallString< 64 > getRelativeFilePath (const StringRef &CurrentPath) const
 Returns the file path for this Info relative to CurrentPath. More...
 
llvm::SmallString< 16 > getFileBaseName () const
 Returns the basename that should be used for this Info. More...
 
llvm::Expected< ReferencegetEnclosingScope ()
 

Public Attributes

TagTypeKind TagType = TagTypeKind::TTK_Struct
 
bool IsTypeDef = false
 
llvm::SmallVector< MemberTypeInfo, 4 > Members
 
llvm::SmallVector< Reference, 4 > Parents
 
llvm::SmallVector< Reference, 4 > VirtualParents
 
std::vector< BaseRecordInfoBases
 
ScopeChildren Children
 
- Public Attributes inherited from clang::doc::SymbolInfo
llvm::Optional< LocationDefLoc
 
llvm::SmallVector< Location, 2 > Loc
 
- Public Attributes inherited from clang::doc::Info
SymbolID USR
 
const InfoType IT = InfoType::IT_default
 
SmallString< 16 > Name
 
llvm::SmallVector< Reference, 4 > Namespace
 
std::vector< CommentInfoDescription
 
llvm::SmallString< 128 > Path
 

Detailed Description

Definition at line 324 of file Representation.h.

Constructor & Destructor Documentation

◆ RecordInfo()

clang::doc::RecordInfo::RecordInfo ( SymbolID  USR = SymbolID(),
StringRef  Name = StringRef(),
StringRef  Path = StringRef() 
)
inline

Definition at line 325 of file Representation.h.

References clang::doc::IT_record.

Member Function Documentation

◆ merge()

void clang::doc::RecordInfo::merge ( RecordInfo &&  I)

Member Data Documentation

◆ Bases

std::vector<BaseRecordInfo> clang::doc::RecordInfo::Bases

◆ Children

ScopeChildren clang::doc::RecordInfo::Children

◆ IsTypeDef

bool clang::doc::RecordInfo::IsTypeDef = false

Definition at line 338 of file Representation.h.

Referenced by merge(), clang::doc::parseRecord(), and llvm::yaml::RecordInfoMapping().

◆ Members

llvm::SmallVector<MemberTypeInfo, 4> clang::doc::RecordInfo::Members

◆ Parents

llvm::SmallVector<Reference, 4> clang::doc::RecordInfo::Parents

◆ TagType

TagTypeKind clang::doc::RecordInfo::TagType = TagTypeKind::TTK_Struct

◆ VirtualParents

llvm::SmallVector<Reference, 4> clang::doc::RecordInfo::VirtualParents

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