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

#include <Representation.h>

Inheritance diagram for clang::doc::FunctionInfo:
Inheritance graph
Collaboration diagram for clang::doc::FunctionInfo:
Collaboration graph

Public Member Functions

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

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< LocationDefLoc
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< CommentInfoDescription
llvm::SmallString< 128 > Path

Detailed Description

Definition at line 304 of file Representation.h.

Constructor & Destructor Documentation

◆ FunctionInfo()

clang::doc::FunctionInfo::FunctionInfo ( SymbolID  USR = SymbolID())

Definition at line 305 of file Representation.h.

References clang::doc::IT_function.

Member Function Documentation

◆ merge()

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

Member Data Documentation

◆ Access

AccessSpecifier clang::doc::FunctionInfo::Access = AccessSpecifier::AS_public

◆ IsMethod

bool clang::doc::FunctionInfo::IsMethod = false

◆ Params

llvm::SmallVector<FieldTypeInfo, 4> clang::doc::FunctionInfo::Params

◆ Parent

Reference clang::doc::FunctionInfo::Parent

◆ ReturnType

TypeInfo clang::doc::FunctionInfo::ReturnType

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