clang-tools 23.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)
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::SmallVector< Reference, 4 > Namespace
SymbolID USR = SymbolID()
SymbolID ParentUSR = SymbolID()
InfoType IT = InfoType::IT_default
OwningVec< CommentInfo > Description
SmallVector< Context, 4 > Contexts

Detailed Description

A base struct for Infos.

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

References clang::doc::internString(), 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()

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

Definition at line 436 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 261 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 256 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 310 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 292 of file Representation.cpp.

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

◆ Contexts

SmallVector<Context, 4> clang::doc::Info::Contexts

Definition at line 488 of file Representation.h.

Referenced by clang::doc::serializeContexts().

◆ Description

OwningVec<CommentInfo> clang::doc::Info::Description

Definition at line 486 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(), clang::doc::getCommentInfo(), clang::doc::getCommentInfo(), clang::doc::getCommentInfo(), clang::doc::getCommentInfo(), clang::doc::getCommentInfo(), clang::doc::getCommentInfo(), clang::doc::getCommentInfo(), clang::doc::getCommentInfo(), llvm::yaml::infoMapping(), and mergeBase().

◆ DocumentationFileName

StringRef clang::doc::Info::DocumentationFileName

Definition at line 471 of file Representation.h.

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

◆ IT

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

Definition at line 483 of file Representation.h.

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

◆ Name

StringRef clang::doc::Info::Name

Definition at line 466 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(), 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::SmallVector<Reference, 4> clang::doc::Info::Namespace

Definition at line 474 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(), clang::doc::serialize::Serializer::emitInfo(), extractName(), llvm::yaml::infoMapping(), and mergeBase().

◆ ParentUSR

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

Definition at line 480 of file Representation.h.

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

◆ Path

StringRef clang::doc::Info::Path

Definition at line 463 of file Representation.h.

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

◆ USR

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

Definition at line 477 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(), llvm::yaml::infoMapping(), 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::RecordInfo::RecordInfo(), clang::doc::serializeContexts(), 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