clang-tools: clang::doc::Info Struct Reference

clang-tools 23.0.0git

A base struct for Infos. More...

#include <Representation.h>

Inheritance 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, llvm::BumpPtrAllocator &Arena)
	Info (const Info &Other)=delete
	Info (Info &&Other)=default
Info &	operator= (Info &&Other)=default
void	mergeBase (Info &&I)
bool	mergeable (const Info &Other)
StringRef	extractName () const
StringRef	getRelativeFilePath (const StringRef &CurrentPath) const
	Returns the file path for this Info relative to CurrentPath.
StringRef	getFileBaseName () const
	Returns the basename that should be used for this Info.

Public Attributes
StringRef	Path = {}
StringRef	Name = {}
StringRef	DocumentationFileName = {}
llvm::ArrayRef< Reference >	Namespace
SymbolID	USR = SymbolID()
SymbolID	ParentUSR = SymbolID()
InfoType	IT = InfoType::IT_default
DocList< CommentInfo >	Description = {}

Detailed Description

A base struct for Infos.

Definition at line 530 of file Representation.h.

Constructor & Destructor Documentation

◆ Info() [1/4]

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

inline

Definition at line 531 of file Representation.h.

References clang::doc::internString(), IT, clang::doc::IT_default, Name, Path, and USR.

Referenced by Info(), Info(), Info(), mergeable(), mergeBase(), clang::doc::NamespaceInfo::NamespaceInfo(), operator=(), clang::doc::SymbolInfo::SymbolInfo(), and clang::doc::SymbolInfo::SymbolInfo().

◆ Info() [2/4]

clang::doc::Info::Info	(	const Info &	Other,
		llvm::BumpPtrAllocator &	Arena )

Definition at line 441 of file Representation.cpp.

References clang::doc::allocateArray(), clang::doc::allocateListNode(), clang::doc::allocatePtr(), Description, DocumentationFileName, Info(), IT, Name, Namespace, ParentUSR, Path, and USR.

◆ Info() [3/4]

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

delete

References Info().

◆ Info() [4/4]

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

default

References Info().

Member Function Documentation

◆ extractName()

StringRef clang::doc::Info::extractName ( ) const

Definition at line 657 of file Representation.cpp.

References clang::doc::internString(), IT, clang::doc::IT_concept, clang::doc::IT_default, clang::doc::IT_enum, clang::doc::IT_friend, clang::doc::IT_function, clang::doc::IT_namespace, clang::doc::IT_record, clang::doc::IT_typedef, clang::doc::IT_variable, Name, Namespace, and USR.

Referenced by clang::doc::Generator::addInfoToIndex(), getFileBaseName(), getRelativeFilePath(), and clang::doc::SymbolInfo::operator<().

◆ getFileBaseName()

StringRef clang::doc::Info::getFileBaseName ( ) const

Returns the basename that should be used for this Info.

Definition at line 394 of file Representation.cpp.

References extractName(), IT, and clang::doc::IT_namespace.

Referenced by clang::doc::MDGenerator::generateDocumentation().

◆ getRelativeFilePath()

StringRef clang::doc::Info::getRelativeFilePath ( const StringRef & CurrentPath ) const

Returns the file path for this Info relative to CurrentPath.

Definition at line 389 of file Representation.cpp.

References clang::doc::calculateRelativeFilePath(), extractName(), clang::doc::internString(), IT, and Path.

Referenced by clang::doc::JSONGenerator::generateDocumentation(), clang::doc::MDGenerator::generateDocumentation(), and clang::doc::genMarkdown().

◆ mergeable()

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

Definition at line 473 of file Representation.cpp.

References Info(), IT, and USR.

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

◆ mergeBase()

void clang::doc::Info::mergeBase ( Info && I )

Definition at line 454 of file Representation.cpp.

References clang::doc::allocateArray(), Description, DocumentationFileName, clang::doc::EmptySID, Info(), IT, clang::doc::IT_default, mergeable(), clang::doc::mergeUnkeyed(), Name, Namespace, ParentUSR, Path, clang::doc::PersistentArena, and USR.

Referenced by clang::doc::NamespaceInfo::merge(), and clang::doc::SymbolInfo::merge().

◆ operator=()

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

default

References Info().

Member Data Documentation

◆ Description

DocList<CommentInfo> clang::doc::Info::Description = {}

Definition at line 576 of file Representation.h.

Referenced by clang::doc::ClangDocBitcodeWriter::emitBlock(), clang::doc::ClangDocBitcodeWriter::emitBlock(), clang::doc::ClangDocBitcodeWriter::emitBlock(), clang::doc::ClangDocBitcodeWriter::emitBlock(), clang::doc::ClangDocBitcodeWriter::emitBlock(), clang::doc::ClangDocBitcodeWriter::emitBlock(), clang::doc::ClangDocBitcodeWriter::emitBlock(), clang::doc::genMarkdown(), clang::doc::genMarkdown(), clang::doc::genMarkdown(), clang::doc::genMarkdown(), Info(), llvm::yaml::infoMapping(), and mergeBase().

◆ DocumentationFileName

StringRef clang::doc::Info::DocumentationFileName = {}

Definition at line 561 of file Representation.h.

Referenced by clang::doc::JSONGenerator::generateDocumentation(), Info(), and mergeBase().

◆ IT

◆ Name

StringRef clang::doc::Info::Name = {}

Definition at line 556 of file Representation.h.

Referenced by clang::doc::BaseRecordInfo::BaseRecordInfo(), clang::doc::BM_BitcodeReader_Scale(), clang::doc::BM_Index_Insertion(), clang::doc::ClangDocBitcodeWriter::emitBlock(), clang::doc::ClangDocBitcodeWriter::emitBlock(), clang::doc::ClangDocBitcodeWriter::emitBlock(), clang::doc::ClangDocBitcodeWriter::emitBlock(), clang::doc::ClangDocBitcodeWriter::emitBlock(), clang::doc::ClangDocBitcodeWriter::emitBlock(), clang::doc::ClangDocBitcodeWriter::emitBlock(), clang::doc::serialize::Serializer::emitInfo(), clang::doc::serialize::Serializer::emitInfo(), extractName(), clang::doc::FriendInfo::FriendInfo(), clang::doc::YAMLGenerator::generateDocumentation(), clang::doc::genMarkdown(), clang::doc::genMarkdown(), clang::doc::genMarkdown(), clang::doc::genMarkdown(), Info(), Info(), llvm::yaml::infoMapping(), mergeBase(), clang::doc::NamespaceInfo::NamespaceInfo(), clang::doc::parseRecord(), clang::doc::parseRecord(), clang::doc::parseRecord(), clang::doc::parseRecord(), clang::doc::parseRecord(), clang::doc::parseRecord(), clang::doc::parseRecord(), clang::doc::parseRecord(), clang::doc::RecordInfo::RecordInfo(), and clang::doc::SymbolInfo::SymbolInfo().

◆ Namespace

llvm::ArrayRef<Reference> clang::doc::Info::Namespace

Definition at line 564 of file Representation.h.

Referenced by clang::doc::Generator::addInfoToIndex(), clang::doc::ClangDocBitcodeWriter::emitBlock(), clang::doc::ClangDocBitcodeWriter::emitBlock(), clang::doc::ClangDocBitcodeWriter::emitBlock(), clang::doc::ClangDocBitcodeWriter::emitBlock(), clang::doc::ClangDocBitcodeWriter::emitBlock(), clang::doc::serialize::Serializer::emitInfo(), extractName(), Info(), llvm::yaml::infoMapping(), mergeBase(), clang::doc::ClangDocBitcodeReader::readBlock(), clang::doc::ClangDocBitcodeReader::readBlock(), and clang::doc::ClangDocBitcodeReader::readBlock().

◆ ParentUSR

SymbolID clang::doc::Info::ParentUSR = SymbolID()

Definition at line 570 of file Representation.h.

Referenced by clang::doc::ClangDocBitcodeWriter::emitBlock(), clang::doc::ClangDocBitcodeWriter::emitBlock(), Info(), mergeBase(), clang::doc::parseRecord(), and clang::doc::parseRecord().

◆ Path

◆ USR

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

Definition at line 567 of file Representation.h.

Referenced by clang::doc::Generator::addInfoToIndex(), clang::doc::BaseRecordInfo::BaseRecordInfo(), clang::doc::BM_BitcodeReader_Scale(), clang::doc::BM_Index_Insertion(), clang::doc::ConceptInfo::ConceptInfo(), clang::doc::ClangDocBitcodeWriter::emitBlock(), clang::doc::ClangDocBitcodeWriter::emitBlock(), clang::doc::ClangDocBitcodeWriter::emitBlock(), clang::doc::ClangDocBitcodeWriter::emitBlock(), clang::doc::ClangDocBitcodeWriter::emitBlock(), clang::doc::ClangDocBitcodeWriter::emitBlock(), clang::doc::ClangDocBitcodeWriter::emitBlock(), clang::doc::EnumInfo::EnumInfo(), extractName(), clang::doc::FriendInfo::FriendInfo(), clang::doc::FriendInfo::FriendInfo(), clang::doc::FunctionInfo::FunctionInfo(), Info(), Info(), llvm::yaml::infoMapping(), mergeable(), mergeBase(), clang::doc::mergeSingleInfo(), clang::doc::NamespaceInfo::NamespaceInfo(), clang::doc::parseRecord(), clang::doc::parseRecord(), clang::doc::parseRecord(), clang::doc::parseRecord(), clang::doc::parseRecord(), clang::doc::parseRecord(), clang::doc::parseRecord(), clang::doc::parseRecord(), clang::doc::RecordInfo::RecordInfo(), clang::doc::SymbolInfo::SymbolInfo(), clang::doc::TypedefInfo::TypedefInfo(), and clang::doc::VarInfo::VarInfo().

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