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

#include <Representation.h>

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

Public Member Functions

 NamespaceInfo ()
 
 NamespaceInfo (SymbolID USR)
 
 NamespaceInfo (SymbolID USR, StringRef Name)
 
 NamespaceInfo (SymbolID USR, StringRef Name, StringRef Path)
 
void merge (NamespaceInfo &&I)
 
- Public Member Functions inherited from clang::doc::Info
 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::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

std::vector< ReferenceChildNamespaces
 
std::vector< ReferenceChildRecords
 
std::vector< FunctionInfoChildFunctions
 
std::vector< EnumInfoChildEnums
 
- 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 283 of file Representation.h.

Constructor & Destructor Documentation

◆ NamespaceInfo() [1/4]

clang::doc::NamespaceInfo::NamespaceInfo ( )
inline

Definition at line 284 of file Representation.h.

◆ NamespaceInfo() [2/4]

clang::doc::NamespaceInfo::NamespaceInfo ( SymbolID  USR)
inline

Definition at line 285 of file Representation.h.

◆ NamespaceInfo() [3/4]

clang::doc::NamespaceInfo::NamespaceInfo ( SymbolID  USR,
StringRef  Name 
)
inline

Definition at line 286 of file Representation.h.

◆ NamespaceInfo() [4/4]

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

Definition at line 288 of file Representation.h.

Member Function Documentation

◆ merge()

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

Definition at line 211 of file Representation.cpp.

References clang::doc::Reference::mergeable().

Member Data Documentation

◆ ChildEnums

std::vector<EnumInfo> clang::doc::NamespaceInfo::ChildEnums

◆ ChildFunctions

std::vector<FunctionInfo> clang::doc::NamespaceInfo::ChildFunctions

◆ ChildNamespaces

std::vector<Reference> clang::doc::NamespaceInfo::ChildNamespaces

◆ ChildRecords

std::vector<Reference> clang::doc::NamespaceInfo::ChildRecords

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