A base struct for Infos. More...
#include <Representation.h>
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::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< Reference > | getEnclosingScope () |
Public Attributes | |
| SymbolID | USR |
| const InfoType | IT = InfoType::IT_default |
| SmallString< 16 > | Name |
| llvm::SmallVector< Reference, 4 > | Namespace |
| std::vector< CommentInfo > | Description |
| llvm::SmallString< 128 > | Path |
Detailed Description
A base struct for Infos.
Definition at line 243 of file Representation.h.
Constructor & Destructor Documentation
◆ Info() [1/7]
|
default |
◆ Info() [2/7]
|
inline |
Definition at line 245 of file Representation.h.
◆ Info() [3/7]
Definition at line 246 of file Representation.h.
◆ Info() [4/7]
Definition at line 247 of file Representation.h.
◆ Info() [5/7]
Definition at line 249 of file Representation.h.
◆ Info() [6/7]
|
delete |
◆ Info() [7/7]
|
default |
◆ ~Info()
|
virtualdefault |
Member Function Documentation
◆ extractName()
| llvm::SmallString< 16 > clang::doc::Info::extractName | ( | ) | const |
Definition at line 264 of file Representation.cpp.
References IT, clang::doc::IT_default, clang::doc::IT_enum, clang::doc::IT_function, clang::doc::IT_namespace, clang::doc::IT_record, Name, Namespace, and USR.
Referenced by clang::doc::Generator::addInfoToIndex(), getFileBaseName(), and getRelativeFilePath().
◆ 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 156 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 152 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 | ) |
Definition at line 195 of file Representation.cpp.
Referenced by clang::doc::NamespaceInfo::merge(), clang::doc::SymbolInfo::merge(), clang::doc::FunctionInfo::merge(), clang::doc::RecordInfo::merge(), clang::doc::EnumInfo::merge(), and mergeBase().
◆ mergeBase()
| void clang::doc::Info::mergeBase | ( | Info && | I | ) |
Definition at line 177 of file Representation.cpp.
References Description, clang::doc::EmptySID, mergeable(), Name, Namespace, Path, and USR.
Referenced by clang::doc::NamespaceInfo::merge(), and clang::doc::SymbolInfo::merge().
Member Data Documentation
◆ Description
| std::vector<CommentInfo> clang::doc::Info::Description |
Definition at line 262 of file Representation.h.
Referenced by clang::doc::ClangDocBitcodeWriter::emitBlock(), clang::doc::genHTML(), clang::doc::genMarkdown(), clang::doc::getCommentInfo(), llvm::yaml::InfoMapping(), mergeBase(), and clang::doc::serialize::populateInfo().
◆ IT
| const InfoType clang::doc::Info::IT = InfoType::IT_default |
Definition at line 258 of file Representation.h.
Referenced by clang::doc::Generator::addInfoToIndex(), clang::doc::ClangDocBitcodeWriter::dispatchInfoForWrite(), extractName(), clang::doc::YAMLGenerator::generateDocForInfo(), clang::doc::MDGenerator::generateDocForInfo(), clang::doc::HTMLGenerator::generateDocForInfo(), getFileBaseName(), getRelativeFilePath(), and mergeable().
◆ Name
| SmallString<16> clang::doc::Info::Name |
Definition at line 259 of file Representation.h.
Referenced by clang::doc::ClangDocBitcodeWriter::emitBlock(), extractName(), clang::doc::genHTML(), clang::doc::genMarkdown(), llvm::yaml::InfoMapping(), mergeBase(), clang::doc::parseRecord(), and clang::doc::serialize::populateInfo().
◆ Namespace
| llvm::SmallVector<Reference, 4> clang::doc::Info::Namespace |
Definition at line 261 of file Representation.h.
Referenced by clang::doc::Generator::addInfoToIndex(), clang::doc::ClangDocBitcodeWriter::emitBlock(), clang::doc::serialize::emitInfo(), extractName(), llvm::yaml::InfoMapping(), mergeBase(), and clang::doc::serialize::populateInfo().
◆ Path
| llvm::SmallString<128> clang::doc::Info::Path |
Definition at line 263 of file Representation.h.
Referenced by clang::doc::Generator::addInfoToIndex(), clang::doc::ClangDocBitcodeWriter::emitBlock(), clang::doc::genHTML(), getRelativeFilePath(), llvm::yaml::InfoMapping(), mergeBase(), and clang::doc::parseRecord().
◆ USR
| SymbolID clang::doc::Info::USR |
Definition at line 256 of file Representation.h.
Referenced by clang::doc::Generator::addInfoToIndex(), clang::doc::ClangDocBitcodeWriter::emitBlock(), extractName(), clang::doc::genHTML(), llvm::yaml::InfoMapping(), mergeable(), mergeBase(), clang::doc::parseRecord(), and clang::doc::serialize::populateInfo().
The documentation for this struct was generated from the following files:
