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

A base struct for Infos. More...

#include <Representation.h>

Inheritance diagram for clang::doc::Info:
[legend]

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
Info & operator= (Info &&Other)=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

SymbolID USR
InfoType IT = InfoType::IT_default
SmallString< 16 > Name
llvm::SmallVector< Reference, 4 > Namespace
std::vector< CommentInfo > Description
llvm::SmallString< 128 > Path
SmallString< 16 > DocumentationFileName

Detailed Description

A base struct for Infos.

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

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

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

◆ Info() [2/3]

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

References Info().

◆ Info() [3/3]

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

References Info().

◆ ~Info()

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

Member Function Documentation

◆ extractName()

llvm::SmallString< 16 > clang::doc::Info::extractName ( ) const

Definition at line 408 of file Representation.cpp.

References 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()

llvm::SmallString< 16 > clang::doc::Info::getFileBaseName ( ) const

Returns the basename that should be used for this Info.

Definition at line 233 of file Representation.cpp.

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

Referenced by clang::doc::determineFileName(), clang::doc::HTMLGenerator::generateDocs(), and clang::doc::MDGenerator::generateDocs().

◆ 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 229 of file Representation.cpp.

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

Referenced by clang::doc::HTMLGenerator::generateDocForInfo(), clang::doc::HTMLGenerator::generateDocs(), clang::doc::MDGenerator::generateDocs(), clang::doc::genHTML(), and clang::doc::genMarkdown().

◆ mergeable()

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

Definition at line 281 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 263 of file Representation.cpp.

References Description, clang::doc::EmptySID, Info(), mergeable(), Name, Namespace, Path, 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

std::vector<CommentInfo> clang::doc::Info::Description

Definition at line 335 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::serialize::extractCommentFromDecl(), clang::doc::genHTML(), clang::doc::genHTML(), clang::doc::genHTML(), clang::doc::genHTML(), clang::doc::genMarkdown(), clang::doc::genMarkdown(), clang::doc::genMarkdown(), clang::doc::genMarkdown(), clang::doc::getCommentInfo(), clang::doc::getCommentInfo(), clang::doc::getCommentInfo(), clang::doc::getCommentInfo(), clang::doc::getCommentInfo(), clang::doc::getCommentInfo(), llvm::yaml::infoMapping(), mergeBase(), clang::doc::serialize::populateInfo(), and clang::doc::serializeCommonAttributes().

◆ DocumentationFileName

SmallString<16> clang::doc::Info::DocumentationFileName

Definition at line 342 of file Representation.h.

Referenced by clang::doc::JSONGenerator::generateDocs(), and clang::doc::serializeCommonAttributes().

◆ IT

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

Definition at line 331 of file Representation.h.

Referenced by clang::doc::Generator::addInfoToIndex(), clang::doc::determineFileName(), clang::doc::ClangDocBitcodeWriter::dispatchInfoForWrite(), extractName(), clang::doc::FriendInfo::FriendInfo(), clang::doc::HTMLGenerator::generateDocForInfo(), clang::doc::JSONGenerator::generateDocForInfo(), clang::doc::MDGenerator::generateDocForInfo(), clang::doc::MustacheHTMLGenerator::generateDocForInfo(), clang::doc::YAMLGenerator::generateDocForInfo(), clang::doc::YAMLGenerator::generateDocs(), getFileBaseName(), getRelativeFilePath(), Info(), mergeable(), clang::doc::serializeCommonAttributes(), and clang::doc::SymbolInfo::SymbolInfo().

◆ Name

SmallString<16> clang::doc::Info::Name

Definition at line 332 of file Representation.h.

Referenced by clang::doc::BaseRecordInfo::BaseRecordInfo(), clang::doc::determineFileName(), 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::emitInfo(), extractName(), clang::doc::FriendInfo::FriendInfo(), clang::doc::YAMLGenerator::generateDocs(), clang::doc::genHTML(), clang::doc::genHTML(), clang::doc::genHTML(), clang::doc::genHTML(), clang::doc::genMarkdown(), clang::doc::genMarkdown(), clang::doc::genMarkdown(), clang::doc::genMarkdown(), Info(), llvm::yaml::infoMapping(), clang::doc::serialize::InsertChild(), clang::doc::serialize::InsertChild(), 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::serialize::populateInfo(), clang::doc::RecordInfo::RecordInfo(), clang::doc::serializeCommonAttributes(), and clang::doc::SymbolInfo::SymbolInfo().

◆ Namespace

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

Definition at line 334 of file Representation.h.

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

◆ Path

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

Definition at line 336 of file Representation.h.

Referenced by clang::doc::Generator::addInfoToIndex(), clang::doc::BaseRecordInfo::BaseRecordInfo(), clang::doc::ClangDocBitcodeWriter::emitBlock(), clang::doc::ClangDocBitcodeWriter::emitBlock(), clang::doc::ClangDocBitcodeWriter::emitBlock(), clang::doc::genHTML(), getRelativeFilePath(), Info(), llvm::yaml::infoMapping(), mergeBase(), clang::doc::NamespaceInfo::NamespaceInfo(), clang::doc::parseRecord(), clang::doc::parseRecord(), clang::doc::parseRecord(), clang::doc::RecordInfo::RecordInfo(), clang::doc::serializeCommonAttributes(), and clang::doc::SymbolInfo::SymbolInfo().

◆ USR

SymbolID clang::doc::Info::USR
Initial value:
=
SymbolID()
clang::doc::SymbolID
std::array< uint8_t, 20 > SymbolID
Definition Representation.h:31

Definition at line 329 of file Representation.h.

Referenced by clang::doc::Generator::addInfoToIndex(), clang::doc::BaseRecordInfo::BaseRecordInfo(), 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(), clang::doc::genHTML(), clang::doc::genHTML(), Info(), llvm::yaml::infoMapping(), clang::doc::serialize::InsertChild(), clang::doc::serialize::InsertChild(), mergeable(), 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::serialize::populateInfo(), clang::doc::serialize::populateSymbolInfo(), clang::doc::RecordInfo::RecordInfo(), clang::doc::serializeCommonAttributes(), clang::doc::SymbolInfo::SymbolInfo(), clang::doc::TypedefInfo::TypedefInfo(), and clang::doc::VarInfo::VarInfo().

The documentation for this struct was generated from the following files:
Generated on for clang-tools by doxygen 1.14.0