clang-tools  10.0.0svn
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 ()=default
 
 Info (InfoType IT)
 
 Info (InfoType IT, SymbolID USR)
 
 Info (InfoType IT, SymbolID USR, StringRef Name)
 
 Info (InfoType IT, SymbolID USR, StringRef Name, StringRef Path)
 
 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::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 237 of file Representation.h.

Constructor & Destructor Documentation

◆ Info() [1/7]

clang::doc::Info::Info ( )
default

◆ Info() [2/7]

clang::doc::Info::Info ( InfoType  IT)
inline

Definition at line 239 of file Representation.h.

◆ Info() [3/7]

clang::doc::Info::Info ( InfoType  IT,
SymbolID  USR 
)
inline

Definition at line 240 of file Representation.h.

◆ Info() [4/7]

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

Definition at line 241 of file Representation.h.

◆ Info() [5/7]

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

Definition at line 243 of file Representation.h.

◆ Info() [6/7]

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

◆ Info() [7/7]

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 ( )

◆ mergeable()

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

Definition at line 149 of file Representation.cpp.

References IT, clang::doc::Reference::USR, and USR.

◆ 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: