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

A base struct for Infos. More...

#include <Representation.h>

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

Public Member Functions

 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

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

A base struct for Infos.

Definition at line 243 of file Representation.h.

Constructor & Destructor Documentation

◆ Info() [1/3]

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

Definition at line 244 of file Representation.h.

◆ Info() [2/3]

clang::doc::Info::Info ( const Info Other)
delete

◆ Info() [3/3]

clang::doc::Info::Info ( Info &&  Other)
default

◆ ~Info()

virtual clang::doc::Info::~Info ( )
virtualdefault

Member Function Documentation

◆ extractName()

llvm::SmallString< 16 > clang::doc::Info::extractName ( ) const

◆ getEnclosingScope()

llvm::Expected<Reference> clang::doc::Info::getEnclosingScope ( )

◆ getFileBaseName()

llvm::SmallString< 16 > clang::doc::Info::getFileBaseName ( ) const

Returns the basename that should be used for this Info.

Definition at line 170 of file Representation.cpp.

References extractName(), IT, and clang::doc::IT_namespace.

◆ getRelativeFilePath()

llvm::SmallString< 64 > clang::doc::Info::getRelativeFilePath ( const StringRef &  CurrentPath) const

Returns the file path for this Info relative to CurrentPath.

Definition at line 166 of file Representation.cpp.

References clang::doc::calculateRelativeFilePath(), extractName(), IT, and Path.

Referenced by clang::doc::genHTML(), and clang::doc::genMarkdown().

◆ mergeable()

bool clang::doc::Info::mergeable ( const Info Other)

◆ mergeBase()

void clang::doc::Info::mergeBase ( Info &&  I)

Member Data Documentation

◆ Description

std::vector<CommentInfo> clang::doc::Info::Description

◆ IT

const InfoType clang::doc::Info::IT = InfoType::IT_default

◆ Name

SmallString<16> clang::doc::Info::Name

◆ Namespace

llvm::SmallVector<Reference, 4> clang::doc::Info::Namespace

◆ Path

llvm::SmallString<128> clang::doc::Info::Path

◆ USR

SymbolID clang::doc::Info::USR

The documentation for this struct was generated from the following files:
clang::doc::SymbolID
std::array< uint8_t, 20 > SymbolID
Definition: Representation.h:31