clang-tools 23.0.0git
clang::doc::TypedefInfo Struct Reference

#include <Representation.h>

Inheritance diagram for clang::doc::TypedefInfo:
[legend]

Public Member Functions

 TypedefInfo (SymbolID USR=SymbolID())
void merge (TypedefInfo &&I)
Public Member Functions inherited from clang::doc::SymbolInfo
 SymbolInfo (InfoType IT, SymbolID USR=SymbolID(), StringRef Name=StringRef(), StringRef Path=StringRef())
 SymbolInfo (const SymbolInfo &Other, llvm::BumpPtrAllocator &Arena)
void merge (SymbolInfo &&I)
bool operator< (const SymbolInfo &Other) const
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, llvm::BumpPtrAllocator &Arena)
 Info (const Info &Other)=delete
 Info (Info &&Other)=default
Infooperator= (Info &&Other)=default
void mergeBase (Info &&I)
bool mergeable (const Info &Other)
StringRef extractName () const
StringRef getRelativeFilePath (const StringRef &CurrentPath) const
 Returns the file path for this Info relative to CurrentPath.
StringRef getFileBaseName () const
 Returns the basename that should be used for this Info.

Static Public Member Functions

static bool classof (const Info *I)
Static Public Member Functions inherited from clang::doc::SymbolInfo
static bool classof (const Info *I)

Public Attributes

TypeInfo Underlying = {}
std::optional< TemplateInfoTemplate
StringRef TypeDeclaration = {}
bool IsUsing = false
Public Attributes inherited from clang::doc::SymbolInfo
std::optional< LocationDefLoc
DocList< LocationLoc = {}
StringRef MangledName = {}
bool IsStatic = false
Public Attributes inherited from clang::doc::Info
StringRef Path = {}
StringRef Name = {}
StringRef DocumentationFileName = {}
llvm::ArrayRef< ReferenceNamespace
SymbolID USR = SymbolID()
SymbolID ParentUSR = SymbolID()
InfoType IT = InfoType::IT_default
DocList< CommentInfoDescription = {}

Detailed Description

Definition at line 744 of file Representation.h.

Constructor & Destructor Documentation

◆ TypedefInfo()

clang::doc::TypedefInfo::TypedefInfo ( SymbolID USR = SymbolID())
inline

Member Function Documentation

◆ classof()

bool clang::doc::TypedefInfo::classof ( const Info * I)
inlinestatic

Definition at line 748 of file Representation.h.

References clang::doc::Info::IT, and clang::doc::IT_typedef.

◆ merge()

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

Member Data Documentation

◆ IsUsing

bool clang::doc::TypedefInfo::IsUsing = false

◆ Template

std::optional<TemplateInfo> clang::doc::TypedefInfo::Template

Definition at line 755 of file Representation.h.

Referenced by clang::doc::addTemplate(), and merge().

◆ TypeDeclaration

StringRef clang::doc::TypedefInfo::TypeDeclaration = {}

Definition at line 758 of file Representation.h.

◆ Underlying

TypeInfo clang::doc::TypedefInfo::Underlying = {}

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