clang::doc::Info Struct Reference

A base struct for Infos. More...

#include <Representation.h>

Inheritance diagram for clang::doc::Info:

Collaboration diagram for clang::doc::Info:

Public Member Functions
	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< 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/3]

clang::doc::Info::Info ( InfoType  IT = InfoType::IT_default, SymbolID  USR = SymbolID(), StringRef  Name = StringRef(), StringRef  Path = StringRef()  )

inline

Definition at line 244 of file Representation.h.

Info() [2/3]

clang::doc::Info::Info ( const Info &  Other )

delete

Info() [3/3]

clang::doc::Info::Info ( Info &&  Other )

default

~Info()

virtual clang::doc::Info::~Info ( )

virtualdefault

Member Function Documentation

extractName()

llvm::SmallString< 16 > clang::doc::Info::extractName

(

)

const

Definition at line 288 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, clang::doc::IT_typedef, 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 170 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 166 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 207 of file Representation.cpp.

References IT, and USR.

Referenced by clang::doc::NamespaceInfo::merge(), clang::doc::SymbolInfo::merge(), clang::doc::FunctionInfo::merge(), clang::doc::RecordInfo::merge(), clang::doc::TypedefInfo::merge(), clang::doc::EnumInfo::merge(), and mergeBase().

mergeBase()

void clang::doc::Info::mergeBase

(

Info &&

I

)

Definition at line 189 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 259 of file Representation.h.

Referenced by clang::doc::ClangDocBitcodeWriter::emitBlock(), clang::doc::genHTML(), clang::doc::genMarkdown(), clang::doc::getCommentInfo(), llvm::yaml::InfoMapping(), and mergeBase().

IT

const InfoType clang::doc::Info::IT = InfoType::IT_default

Definition at line 255 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 256 of file Representation.h.

Referenced by clang::doc::ClangDocBitcodeWriter::emitBlock(), clang::doc::serialize::emitInfo(), extractName(), clang::doc::genHTML(), clang::doc::genMarkdown(), llvm::yaml::InfoMapping(), clang::doc::serialize::InsertChild(), mergeBase(), and clang::doc::parseRecord().

Namespace

llvm::SmallVector<Reference, 4> clang::doc::Info::Namespace

Definition at line 258 of file Representation.h.

Referenced by clang::doc::Generator::addInfoToIndex(), clang::doc::ClangDocBitcodeWriter::emitBlock(), extractName(), llvm::yaml::InfoMapping(), clang::doc::serialize::InsertChild(), and mergeBase().

Path

llvm::SmallString<128> clang::doc::Info::Path

Definition at line 260 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

Initial value:

=
      SymbolID()

Definition at line 253 of file Representation.h.

Referenced by clang::doc::Generator::addInfoToIndex(), clang::doc::ClangDocBitcodeWriter::emitBlock(), extractName(), clang::doc::genHTML(), llvm::yaml::InfoMapping(), clang::doc::serialize::InsertChild(), mergeable(), mergeBase(), and clang::doc::parseRecord().

---

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

• Representation.h
• Representation.cpp