clang-tools 19.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
[legend]

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.
 
llvm::SmallString< 16 > getFileBaseName () const
 Returns the basename that should be used for this Info.
 

Public Attributes

bool IsMethod = false
 
Reference Parent
 
TypeInfo ReturnType
 
llvm::SmallVector< FieldTypeInfo, 4 > Params
 
AccessSpecifier Access = AccessSpecifier::AS_public
 
SmallString< 16 > FullName
 
std::optional< TemplateInfoTemplate
 
- Public Attributes inherited from clang::doc::SymbolInfo
std::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 319 of file Representation.h.

Constructor & Destructor Documentation

◆ FunctionInfo()

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

Definition at line 320 of file Representation.h.

Member Function Documentation

◆ merge()

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

Member Data Documentation

◆ Access

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

◆ FullName

SmallString<16> clang::doc::FunctionInfo::FullName

Definition at line 337 of file Representation.h.

◆ 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

◆ Template

std::optional<TemplateInfo> clang::doc::FunctionInfo::Template

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