#include <Representation.h>
Public Member Functions | |
| FunctionInfo () | |
| FunctionInfo (SymbolID USR) | |
| void | merge (FunctionInfo &&I) |
 Public Member Functions inherited from clang::doc::SymbolInfo | |
| SymbolInfo (InfoType IT) | |
| SymbolInfo (InfoType IT, SymbolID USR) | |
| SymbolInfo (InfoType IT, SymbolID USR, StringRef Name) | |
| SymbolInfo (InfoType IT, SymbolID USR, StringRef Name, StringRef Path) | |
| void | merge (SymbolInfo &&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< Reference > | getEnclosingScope () |
Public Attributes | |
| bool | IsMethod = false |
| Reference | Parent |
| TypeInfo | ReturnType |
| llvm::SmallVector< FieldTypeInfo, 4 > | Params |
| AccessSpecifier | Access = AccessSpecifier::AS_public |
| Public Attributes inherited from clang::doc::SymbolInfo | |
| llvm::Optional< Location > | DefLoc |
| llvm::SmallVector< Location, 2 > | Loc |
| 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< CommentInfo > | Description |
| llvm::SmallString< 128 > | Path |
Detailed Description
Definition at line 319 of file Representation.h.
Constructor & Destructor Documentation
◆ FunctionInfo() [1/2]
|
inline |
Definition at line 320 of file Representation.h.
References clang::doc::IT_function.
◆ FunctionInfo() [2/2]
|
inline |
Definition at line 321 of file Representation.h.
References clang::doc::IT_function.
Member Function Documentation
◆ merge()
| void clang::doc::FunctionInfo::merge | ( | FunctionInfo && | I | ) |
Definition at line 249 of file Representation.cpp.
References Access, clang::doc::EmptySID, IsMethod, clang::doc::SymbolInfo::merge(), clang::doc::Info::mergeable(), clang::doc::Reference::Name, Params, Parent, ReturnType, clang::doc::TypeInfo::Type, and clang::doc::Reference::USR.
Member Data Documentation
◆ Access
| AccessSpecifier clang::doc::FunctionInfo::Access = AccessSpecifier::AS_public |
Definition at line 333 of file Representation.h.
Referenced by clang::doc::ClangDocBitcodeWriter::emitBlock(), clang::doc::serialize::emitInfo(), clang::doc::genHTML(), clang::doc::genMarkdown(), llvm::yaml::MappingTraits< FunctionInfo >::mapping(), merge(), clang::doc::serialize::parseBases(), and clang::doc::parseRecord().
◆ IsMethod
| bool clang::doc::FunctionInfo::IsMethod = false |
Definition at line 325 of file Representation.h.
Referenced by clang::doc::ClangDocBitcodeWriter::emitBlock(), clang::doc::serialize::emitInfo(), llvm::yaml::MappingTraits< FunctionInfo >::mapping(), merge(), clang::doc::serialize::parseBases(), and clang::doc::parseRecord().
◆ Params
| llvm::SmallVector<FieldTypeInfo, 4> clang::doc::FunctionInfo::Params |
Definition at line 328 of file Representation.h.
Referenced by clang::doc::addTypeInfo(), clang::doc::genHTML(), clang::doc::genMarkdown(), llvm::yaml::MappingTraits< FunctionInfo >::mapping(), merge(), and clang::doc::serialize::parseParameters().
◆ Parent
| Reference clang::doc::FunctionInfo::Parent |
Definition at line 326 of file Representation.h.
Referenced by clang::doc::serialize::emitInfo(), llvm::yaml::MappingTraits< FunctionInfo >::mapping(), and merge().
◆ ReturnType
| TypeInfo clang::doc::FunctionInfo::ReturnType |
Definition at line 327 of file Representation.h.
Referenced by clang::doc::addTypeInfo(), clang::doc::genHTML(), clang::doc::genMarkdown(), llvm::yaml::MappingTraits< FunctionInfo >::mapping(), merge(), and clang::doc::serialize::populateFunctionInfo().
The documentation for this struct was generated from the following files:
