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

#include <Representation.h>

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

Public Member Functions

 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...
 

Public Attributes

std::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 306 of file Representation.h.

Constructor & Destructor Documentation

◆ SymbolInfo()

clang::doc::SymbolInfo::SymbolInfo ( InfoType  IT,
SymbolID  USR = SymbolID(),
StringRef  Name = StringRef(),
StringRef  Path = StringRef() 
)
inline

Definition at line 307 of file Representation.h.

Member Function Documentation

◆ merge()

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

Member Data Documentation

◆ DefLoc

std::optional<Location> clang::doc::SymbolInfo::DefLoc

◆ Loc

llvm::SmallVector<Location, 2> clang::doc::SymbolInfo::Loc

Definition at line 314 of file Representation.h.

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


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