#include <Representation.h>
Public Member Functions | |
| SymbolInfo (InfoType IT, SymbolID USR=SymbolID(), StringRef Name=StringRef(), StringRef Path=StringRef()) | |
| 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)=delete | |
| Info (Info &&Other)=default | |
| virtual | ~Info ()=default |
| Info & | operator= (Info &&Other)=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. | |
| llvm::SmallString< 16 > | getFileBaseName () const |
| Returns the basename that should be used for this Info. | |
Public Attributes | |
| std::optional< Location > | DefLoc |
| llvm::SmallVector< Location, 2 > | Loc |
| Public Attributes inherited from clang::doc::Info | |
| SymbolID | USR |
| InfoType | IT = InfoType::IT_default |
| SmallString< 16 > | Name |
| llvm::SmallVector< Reference, 4 > | Namespace |
| std::vector< CommentInfo > | Description |
| llvm::SmallString< 128 > | Path |
Detailed Description
Definition at line 316 of file Representation.h.
Constructor & Destructor Documentation
◆ SymbolInfo()
|
inline |
Definition at line 317 of file Representation.h.
Member Function Documentation
◆ merge()
| void clang::doc::SymbolInfo::merge | ( | SymbolInfo && | I | ) |
Definition at line 211 of file Representation.cpp.
References DefLoc, Loc, clang::doc::Info::mergeable(), and clang::doc::Info::mergeBase().
◆ operator<()
|
inline |
Definition at line 326 of file Representation.h.
References DefLoc, clang::doc::Info::extractName(), and Loc.
Member Data Documentation
◆ DefLoc
| std::optional<Location> clang::doc::SymbolInfo::DefLoc |
Definition at line 323 of file Representation.h.
Referenced by clang::doc::ClangDocBitcodeWriter::emitBlock(), clang::doc::genHTML(), clang::doc::genMarkdown(), merge(), operator<(), clang::doc::parseRecord(), clang::doc::serialize::populateSymbolInfo(), and llvm::yaml::SymbolInfoMapping().
◆ Loc
| llvm::SmallVector<Location, 2> clang::doc::SymbolInfo::Loc |
Definition at line 324 of file Representation.h.
Referenced by clang::doc::ClangDocBitcodeWriter::emitBlock(), merge(), operator<(), clang::doc::parseRecord(), clang::doc::serialize::populateSymbolInfo(), and llvm::yaml::SymbolInfoMapping().
The documentation for this struct was generated from the following files:
