Namespaces
namespace	serialize

Classes
struct	BaseRecordInfo
struct	BitCodeConstants
struct	BlockIdToIndexFunctor
class	ClangDocBitcodeReader
class	ClangDocBitcodeWriter
struct	ClangDocContext
struct	CommentInfo
struct	ConceptInfo
struct	ConstraintInfo
struct	EnumInfo
struct	EnumValueInfo
struct	FieldTypeInfo
struct	FriendInfo
struct	FunctionInfo
class	Generator
class	HTMLGenerator
	Generator for HTML documentation. More...
struct	Index
struct	Info
	A base struct for Infos. More...
class	JSONGenerator
struct	Location
class	MapASTVisitor
class	MapperActionFactory
class	MDGenerator
	Generator for Markdown documentation. More...
struct	MemberTypeInfo
class	MustacheHTMLGenerator
class	MustacheTemplateFile
struct	NamespaceInfo
struct	RecordIdDsc
struct	RecordIdToIndexFunctor
struct	RecordInfo
struct	Reference
struct	ScopeChildren
struct	SymbolInfo
struct	TemplateInfo
struct	TemplateParamInfo
struct	TemplateSpecializationInfo
struct	TypedefInfo
struct	TypeInfo
struct	VarInfo
class	YAMLGenerator
	Generator for YAML documentation. More...

Typedefs
using	Record = llvm::SmallVector<uint64_t, 1024>
using	AbbrevDsc = void (*)(std::shared_ptr<llvm::BitCodeAbbrev> &Abbrev)
typedef llvm::Registry< Generator >	GeneratorRegistry
using	SymbolID = std::array<uint8_t, 20>

Enumerations
enum	BlockId { BI_VERSION_BLOCK_ID = llvm::bitc::FIRST_APPLICATION_BLOCKID , BI_NAMESPACE_BLOCK_ID , BI_ENUM_BLOCK_ID , BI_ENUM_VALUE_BLOCK_ID , BI_TYPE_BLOCK_ID , BI_FIELD_TYPE_BLOCK_ID , BI_MEMBER_TYPE_BLOCK_ID , BI_RECORD_BLOCK_ID , BI_BASE_RECORD_BLOCK_ID , BI_FUNCTION_BLOCK_ID , BI_COMMENT_BLOCK_ID , BI_REFERENCE_BLOCK_ID , BI_TEMPLATE_BLOCK_ID , BI_TEMPLATE_SPECIALIZATION_BLOCK_ID , BI_TEMPLATE_PARAM_BLOCK_ID , BI_CONSTRAINT_BLOCK_ID , BI_TYPEDEF_BLOCK_ID , BI_CONCEPT_BLOCK_ID , BI_VAR_BLOCK_ID , BI_FRIEND_BLOCK_ID , BI_LAST , BI_FIRST = BI_VERSION_BLOCK_ID }
enum	RecordId { VERSION = 1 , FUNCTION_USR , FUNCTION_NAME , FUNCTION_DEFLOCATION , FUNCTION_LOCATION , FUNCTION_ACCESS , FUNCTION_IS_METHOD , FUNCTION_IS_STATIC , COMMENT_KIND , COMMENT_TEXT , COMMENT_NAME , COMMENT_DIRECTION , COMMENT_PARAMNAME , COMMENT_CLOSENAME , COMMENT_SELFCLOSING , COMMENT_EXPLICIT , COMMENT_ATTRKEY , COMMENT_ATTRVAL , COMMENT_ARG , TYPE_IS_BUILTIN , TYPE_IS_TEMPLATE , FIELD_TYPE_NAME , FIELD_DEFAULT_VALUE , FIELD_TYPE_IS_BUILTIN , FIELD_TYPE_IS_TEMPLATE , MEMBER_TYPE_NAME , MEMBER_TYPE_ACCESS , MEMBER_TYPE_IS_STATIC , MEMBER_TYPE_IS_BUILTIN , MEMBER_TYPE_IS_TEMPLATE , NAMESPACE_USR , NAMESPACE_NAME , NAMESPACE_PATH , ENUM_USR , ENUM_NAME , ENUM_DEFLOCATION , ENUM_LOCATION , ENUM_SCOPED , ENUM_VALUE_NAME , ENUM_VALUE_VALUE , ENUM_VALUE_EXPR , RECORD_USR , RECORD_NAME , RECORD_PATH , RECORD_DEFLOCATION , RECORD_LOCATION , RECORD_TAG_TYPE , RECORD_IS_TYPE_DEF , RECORD_MANGLED_NAME , BASE_RECORD_USR , BASE_RECORD_NAME , BASE_RECORD_PATH , BASE_RECORD_TAG_TYPE , BASE_RECORD_IS_VIRTUAL , BASE_RECORD_ACCESS , BASE_RECORD_IS_PARENT , REFERENCE_USR , REFERENCE_NAME , REFERENCE_QUAL_NAME , REFERENCE_TYPE , REFERENCE_PATH , REFERENCE_FIELD , REFERENCE_FILE , TEMPLATE_PARAM_CONTENTS , TEMPLATE_SPECIALIZATION_OF , TYPEDEF_USR , TYPEDEF_NAME , TYPEDEF_DEFLOCATION , TYPEDEF_IS_USING , CONCEPT_USR , CONCEPT_NAME , CONCEPT_IS_TYPE , CONCEPT_CONSTRAINT_EXPRESSION , CONSTRAINT_EXPRESSION , VAR_USR , VAR_NAME , VAR_DEFLOCATION , VAR_IS_STATIC , FRIEND_IS_CLASS , RI_LAST , RI_FIRST = VERSION }
enum class	FieldId { F_default , F_namespace , F_parent , F_vparent , F_type , F_child_namespace , F_child_record , F_concept , F_friend }
enum class	InfoType { IT_default , IT_namespace , IT_record , IT_function , IT_enum , IT_typedef , IT_concept , IT_variable , IT_friend }
enum class	CommentKind { CK_FullComment , CK_ParagraphComment , CK_TextComment , CK_InlineCommandComment , CK_HTMLStartTagComment , CK_HTMLEndTagComment , CK_BlockCommandComment , CK_ParamCommandComment , CK_TParamCommandComment , CK_VerbatimBlockComment , CK_VerbatimBlockLineComment , CK_VerbatimLineComment , CK_Unknown }

Functions
static llvm::Error	decodeRecord (const Record &R, llvm::SmallVectorImpl< char > &Field, llvm::StringRef Blob)
static llvm::Error	decodeRecord (const Record &R, SymbolID &Field, llvm::StringRef Blob)
static llvm::Error	decodeRecord (const Record &R, bool &Field, llvm::StringRef Blob)
static llvm::Error	decodeRecord (const Record &R, AccessSpecifier &Field, llvm::StringRef Blob)
static llvm::Error	decodeRecord (const Record &R, TagTypeKind &Field, llvm::StringRef Blob)
static llvm::Error	decodeRecord (const Record &R, std::optional< Location > &Field, llvm::StringRef Blob)
static llvm::Error	decodeRecord (const Record &R, InfoType &Field, llvm::StringRef Blob)
static llvm::Error	decodeRecord (const Record &R, FieldId &Field, llvm::StringRef Blob)
static llvm::Error	decodeRecord (const Record &R, llvm::SmallVectorImpl< llvm::SmallString< 16 > > &Field, llvm::StringRef Blob)
static llvm::Error	decodeRecord (const Record &R, llvm::SmallVectorImpl< Location > &Field, llvm::StringRef Blob)
static llvm::Error	parseRecord (const Record &R, unsigned ID, llvm::StringRef Blob, const unsigned VersionNo)
static llvm::Error	parseRecord (const Record &R, unsigned ID, llvm::StringRef Blob, NamespaceInfo *I)
static llvm::Error	parseRecord (const Record &R, unsigned ID, llvm::StringRef Blob, RecordInfo *I)
static llvm::Error	parseRecord (const Record &R, unsigned ID, llvm::StringRef Blob, BaseRecordInfo *I)
static llvm::Error	parseRecord (const Record &R, unsigned ID, llvm::StringRef Blob, EnumInfo *I)
static llvm::Error	parseRecord (const Record &R, unsigned ID, llvm::StringRef Blob, TypedefInfo *I)
static llvm::Error	parseRecord (const Record &R, unsigned ID, llvm::StringRef Blob, EnumValueInfo *I)
static llvm::Error	parseRecord (const Record &R, unsigned ID, llvm::StringRef Blob, FunctionInfo *I)
static llvm::Error	parseRecord (const Record &R, unsigned ID, llvm::StringRef Blob, TypeInfo *I)
static llvm::Error	parseRecord (const Record &R, unsigned ID, llvm::StringRef Blob, FieldTypeInfo *I)
static llvm::Error	parseRecord (const Record &R, unsigned ID, llvm::StringRef Blob, MemberTypeInfo *I)
static llvm::Error	parseRecord (const Record &R, unsigned ID, llvm::StringRef Blob, CommentInfo *I)
static llvm::Error	parseRecord (const Record &R, unsigned ID, llvm::StringRef Blob, Reference *I, FieldId &F)
static llvm::Error	parseRecord (const Record &R, unsigned ID, llvm::StringRef Blob, TemplateInfo *I)
static llvm::Error	parseRecord (const Record &R, unsigned ID, llvm::StringRef Blob, TemplateSpecializationInfo *I)
static llvm::Error	parseRecord (const Record &R, unsigned ID, llvm::StringRef Blob, TemplateParamInfo *I)
static llvm::Error	parseRecord (const Record &R, unsigned ID, llvm::StringRef Blob, ConceptInfo *I)
static llvm::Error	parseRecord (const Record &R, unsigned ID, llvm::StringRef Blob, ConstraintInfo *I)
static llvm::Error	parseRecord (const Record &R, unsigned ID, llvm::StringRef Blob, VarInfo *I)
static llvm::Error	parseRecord (const Record &R, unsigned ID, StringRef Blob, FriendInfo *F)
template<typename T>
static llvm::Expected< CommentInfo * >	getCommentInfo (T I)
template<>
llvm::Expected< CommentInfo * >	getCommentInfo (FunctionInfo *I)
template<>
llvm::Expected< CommentInfo * >	getCommentInfo (NamespaceInfo *I)
template<>
llvm::Expected< CommentInfo * >	getCommentInfo (RecordInfo *I)
template<>
llvm::Expected< CommentInfo * >	getCommentInfo (MemberTypeInfo *I)
template<>
llvm::Expected< CommentInfo * >	getCommentInfo (EnumInfo *I)
template<>
llvm::Expected< CommentInfo * >	getCommentInfo (TypedefInfo *I)
template<>
llvm::Expected< CommentInfo * >	getCommentInfo (EnumValueInfo *I)
template<>
llvm::Expected< CommentInfo * >	getCommentInfo (CommentInfo *I)
template<>
llvm::Expected< CommentInfo * >	getCommentInfo (ConceptInfo *I)
template<>
Expected< CommentInfo * >	getCommentInfo (VarInfo *I)
template<typename T, typename TTypeInfo>
static llvm::Error	addTypeInfo (T I, TTypeInfo &&TI)
template<>
llvm::Error	addTypeInfo (RecordInfo *I, MemberTypeInfo &&T)
template<>
llvm::Error	addTypeInfo (BaseRecordInfo *I, MemberTypeInfo &&T)
template<>
llvm::Error	addTypeInfo (FunctionInfo *I, TypeInfo &&T)
template<>
llvm::Error	addTypeInfo (FunctionInfo *I, FieldTypeInfo &&T)
template<>
llvm::Error	addTypeInfo (FriendInfo *I, FieldTypeInfo &&T)
template<>
llvm::Error	addTypeInfo (FriendInfo *I, TypeInfo &&T)
template<>
llvm::Error	addTypeInfo (EnumInfo *I, TypeInfo &&T)
template<>
llvm::Error	addTypeInfo (TypedefInfo *I, TypeInfo &&T)
template<>
llvm::Error	addTypeInfo (VarInfo *I, TypeInfo &&T)
template<typename T>
static llvm::Error	addReference (T I, Reference &&R, FieldId F)
template<>
llvm::Error	addReference (VarInfo *I, Reference &&R, FieldId F)
template<>
llvm::Error	addReference (TypeInfo *I, Reference &&R, FieldId F)
template<>
llvm::Error	addReference (FieldTypeInfo *I, Reference &&R, FieldId F)
template<>
llvm::Error	addReference (MemberTypeInfo *I, Reference &&R, FieldId F)
template<>
llvm::Error	addReference (EnumInfo *I, Reference &&R, FieldId F)
template<>
llvm::Error	addReference (TypedefInfo *I, Reference &&R, FieldId F)
template<>
llvm::Error	addReference (NamespaceInfo *I, Reference &&R, FieldId F)
template<>
llvm::Error	addReference (FunctionInfo *I, Reference &&R, FieldId F)
template<>
llvm::Error	addReference (RecordInfo *I, Reference &&R, FieldId F)
template<>
llvm::Error	addReference (ConstraintInfo *I, Reference &&R, FieldId F)
template<>
llvm::Error	addReference (FriendInfo *Friend, Reference &&R, FieldId F)
template<typename T, typename ChildInfoType>
static void	addChild (T I, ChildInfoType &&R)
template<>
void	addChild (NamespaceInfo *I, FunctionInfo &&R)
template<>
void	addChild (NamespaceInfo *I, EnumInfo &&R)
template<>
void	addChild (NamespaceInfo *I, TypedefInfo &&R)
template<>
void	addChild (NamespaceInfo *I, ConceptInfo &&R)
template<>
void	addChild (NamespaceInfo *I, VarInfo &&R)
template<>
void	addChild (RecordInfo *I, FunctionInfo &&R)
template<>
void	addChild (RecordInfo *I, EnumInfo &&R)
template<>
void	addChild (RecordInfo *I, TypedefInfo &&R)
template<>
void	addChild (RecordInfo *I, FriendInfo &&R)
template<>
void	addChild (EnumInfo *I, EnumValueInfo &&R)
template<>
void	addChild (RecordInfo *I, BaseRecordInfo &&R)
template<>
void	addChild (BaseRecordInfo *I, FunctionInfo &&R)
template<typename T>
static void	addTemplateParam (T I, TemplateParamInfo &&P)
template<>
void	addTemplateParam (TemplateInfo *I, TemplateParamInfo &&P)
template<>
void	addTemplateParam (TemplateSpecializationInfo *I, TemplateParamInfo &&P)
template<typename T>
static void	addTemplate (T I, TemplateInfo &&P)
template<>
void	addTemplate (RecordInfo *I, TemplateInfo &&P)
template<>
void	addTemplate (FunctionInfo *I, TemplateInfo &&P)
template<>
void	addTemplate (ConceptInfo *I, TemplateInfo &&P)
template<>
void	addTemplate (FriendInfo *I, TemplateInfo &&P)
template<typename T>
static void	addTemplateSpecialization (T I, TemplateSpecializationInfo &&TSI)
template<>
void	addTemplateSpecialization (TemplateInfo *I, TemplateSpecializationInfo &&TSI)
template<typename T>
static void	addConstraint (T I, ConstraintInfo &&C)
template<>
void	addConstraint (TemplateInfo *I, ConstraintInfo &&C)
static void	generateAbbrev (std::shared_ptr< llvm::BitCodeAbbrev > &Abbrev, const std::initializer_list< llvm::BitCodeAbbrevOp > Ops)
static void	genBoolAbbrev (std::shared_ptr< llvm::BitCodeAbbrev > &Abbrev)
static void	genIntAbbrev (std::shared_ptr< llvm::BitCodeAbbrev > &Abbrev)
static void	genSymbolIdAbbrev (std::shared_ptr< llvm::BitCodeAbbrev > &Abbrev)
static void	genStringAbbrev (std::shared_ptr< llvm::BitCodeAbbrev > &Abbrev)
static void	genLocationAbbrev (std::shared_ptr< llvm::BitCodeAbbrev > &Abbrev)
std::unique_ptr< tooling::FrontendActionFactory >	newMapperActionFactory (ClangDocContext CDCtx)
llvm::Expected< std::unique_ptr< Generator > >	findGeneratorByName (llvm::StringRef Format)
std::string	getTagType (TagTypeKind AS)
template<typename Derived, typename Base, typename = std::enable_if<std::is_base_of<Derived, Base>::value>>
static void	appendVector (std::vector< Derived > &&New, std::vector< Base > &Original)
static std::vector< std::unique_ptr< TagNode > >	genStylesheetsHTML (StringRef InfoPath, const ClangDocContext &CDCtx)
static std::vector< std::unique_ptr< TagNode > >	genJsScriptsHTML (StringRef InfoPath, const ClangDocContext &CDCtx)
static std::unique_ptr< TagNode >	genLink (const Twine &Text, const Twine &Link)
static std::unique_ptr< HTMLNode >	genReference (const Reference &Type, StringRef CurrentDirectory, std::optional< StringRef > JumpToSection=std::nullopt)
static std::vector< std::unique_ptr< HTMLNode > >	genReferenceList (const llvm::SmallVectorImpl< Reference > &Refs, const StringRef &CurrentDirectory)
static std::vector< std::unique_ptr< TagNode > >	genHTML (const EnumInfo &I, const ClangDocContext &CDCtx)
static std::vector< std::unique_ptr< TagNode > >	genHTML (const FunctionInfo &I, const ClangDocContext &CDCtx, StringRef ParentInfoDir)
static std::unique_ptr< TagNode >	genHTML (const std::vector< CommentInfo > &C)
static std::vector< std::unique_ptr< TagNode > >	genEnumsBlock (const std::vector< EnumInfo > &Enums, const ClangDocContext &CDCtx)
static std::unique_ptr< TagNode >	genEnumMembersBlock (const llvm::SmallVector< EnumValueInfo, 4 > &Members)
static std::vector< std::unique_ptr< TagNode > >	genFunctionsBlock (const std::vector< FunctionInfo > &Functions, const ClangDocContext &CDCtx, StringRef ParentInfoDir)
static std::vector< std::unique_ptr< TagNode > >	genRecordMembersBlock (const llvm::SmallVector< MemberTypeInfo, 4 > &Members, StringRef ParentInfoDir)
static std::vector< std::unique_ptr< TagNode > >	genReferencesBlock (const std::vector< Reference > &References, llvm::StringRef Title, StringRef ParentPath)
static std::unique_ptr< TagNode >	writeSourceFileRef (const ClangDocContext &CDCtx, const Location &L)
static void	maybeWriteSourceFileRef (std::vector< std::unique_ptr< TagNode > > &Out, const ClangDocContext &CDCtx, const std::optional< Location > &DefLoc)
static std::vector< std::unique_ptr< TagNode > >	genHTML (const Index &Index, StringRef InfoPath, bool IsOutermostList)
static std::vector< std::unique_ptr< TagNode > >	genFileHeadNodes (StringRef Title, StringRef InfoPath, const ClangDocContext &CDCtx)
static std::unique_ptr< TagNode >	genFileHeaderNode (StringRef ProjectName)
static std::unique_ptr< TagNode >	genInfoFileMainNode (StringRef InfoPath, std::vector< std::unique_ptr< TagNode > > &MainContentInnerNodes, const Index &InfoIndex)
static std::unique_ptr< TagNode >	genFileFooterNode ()
static HTMLFile	genInfoFile (StringRef Title, StringRef InfoPath, std::vector< std::unique_ptr< TagNode > > &MainContentNodes, const Index &InfoIndex, const ClangDocContext &CDCtx)
template<typename T, typename = std::enable_if<std::is_base_of<T, Info>::value>>
static Index	genInfoIndexItem (const std::vector< T > &Infos, StringRef Title)
static std::unique_ptr< HTMLNode >	genHTML (const CommentInfo &I)
static std::vector< std::unique_ptr< TagNode > >	genHTML (const NamespaceInfo &I, Index &InfoIndex, const ClangDocContext &CDCtx, std::string &InfoTitle)
static std::vector< std::unique_ptr< TagNode > >	genHTML (const RecordInfo &I, Index &InfoIndex, const ClangDocContext &CDCtx, std::string &InfoTitle)
static std::vector< std::unique_ptr< TagNode > >	genHTML (const TypedefInfo &I, const ClangDocContext &CDCtx, std::string &InfoTitle)
static std::string	getRefType (InfoType IT)
static llvm::Error	serializeIndex (ClangDocContext &CDCtx)
static std::unique_ptr< TagNode >	genIndexFileMainNode ()
static llvm::Error	genIndex (const ClangDocContext &CDCtx)
static GeneratorRegistry::Add< HTMLGenerator >	HTML (HTMLGenerator::Format, "Generator for HTML output.")
static Error	generateDocForJSON (json::Value &JSON, StringRef Filename, StringRef Path, raw_fd_ostream &OS, const ClangDocContext &CDCtx)
static Error	createFileOpenError (StringRef FileName, std::error_code EC)
static Error	setupTemplate (std::unique_ptr< MustacheTemplateFile > &Template, StringRef TemplatePath, std::vector< std::pair< StringRef, StringRef > > Partials)
static Error	setupTemplateFiles (const clang::doc::ClangDocContext &CDCtx)
static Error	setupTemplateValue (const ClangDocContext &CDCtx, json::Value &V)
static GeneratorRegistry::Add< MustacheHTMLGenerator >	MHTML (MustacheHTMLGenerator::Format, "Generator for mustache HTML output.")
static void	serializeInfo (const ConstraintInfo &I, Object &Obj)
static void	serializeInfo (const RecordInfo &I, Object &Obj, const std::optional< StringRef > &RepositoryUrl)
static void	serializeReference (const Reference &Ref, Object &ReferenceObj)
template<typename Container, typename SerializationFunc>
static void	serializeArray (const Container &Records, Object &Obj, const std::string &Key, SerializationFunc SerializeInfo)
static std::string	infoTypeToString (InfoType IT)
static json::Object	serializeLocation (const Location &Loc, const std::optional< StringRef > RepositoryUrl)
static void	insertComment (Object &Description, json::Value &Comment, StringRef Key)
static json::Value	extractTextComments (Object *ParagraphComment)
static json::Value	extractVerbatimComments (json::Array VerbatimLines)
static Object	serializeComment (const CommentInfo &I, Object &Description)
static void	serializeCommonAttributes (const Info &I, json::Object &Obj, const std::optional< StringRef > RepositoryUrl)
static void	serializeCommonChildren (const ScopeChildren &Children, json::Object &Obj, const std::optional< StringRef > RepositoryUrl)
static void	serializeInfo (const ArrayRef< TemplateParamInfo > &Params, Object &Obj)
static void	serializeInfo (const TemplateInfo &Template, Object &Obj)
static void	serializeInfo (const ConceptInfo &I, Object &Obj, const std::optional< StringRef > &RepositoryUrl)
static void	serializeInfo (const TypeInfo &I, Object &Obj)
static void	serializeInfo (const FieldTypeInfo &I, Object &Obj)
static void	serializeInfo (const FunctionInfo &F, json::Object &Obj, const std::optional< StringRef > RepositoryURL)
static void	serializeInfo (const EnumValueInfo &I, Object &Obj)
static void	serializeInfo (const EnumInfo &I, json::Object &Obj, const std::optional< StringRef > &RepositoryUrl)
static void	serializeInfo (const TypedefInfo &I, json::Object &Obj, const std::optional< StringRef > &RepositoryUrl)
static void	serializeInfo (const BaseRecordInfo &I, Object &Obj, const std::optional< StringRef > &RepositoryUrl)
static void	serializeInfo (const FriendInfo &I, Object &Obj)
static void	insertArray (Object &Obj, json::Value &Array, StringRef Key)
static void	serializeInfo (const RecordInfo &I, json::Object &Obj, const std::optional< StringRef > &RepositoryUrl)
static void	serializeInfo (const VarInfo &I, json::Object &Obj, const std::optional< StringRef > RepositoryUrl)
static void	serializeInfo (const NamespaceInfo &I, json::Object &Obj, const std::optional< StringRef > RepositoryUrl)
static SmallString< 16 >	determineFileName (Info *I, SmallString< 128 > &Path)
static GeneratorRegistry::Add< JSONGenerator >	JSON (JSONGenerator::Format, "Generator for JSON output.")
template<typename T>
static bool	isTypedefAnonRecord (const T *D)
static std::string	genItalic (const Twine &Text)
static std::string	genEmphasis (const Twine &Text)
static std::string	genReferenceList (const llvm::SmallVectorImpl< Reference > &Refs)
static void	writeLine (const Twine &Text, raw_ostream &OS)
static void	writeNewLine (raw_ostream &OS)
static void	writeHeader (const Twine &Text, unsigned int Num, raw_ostream &OS)
static void	writeSourceFileRef (const ClangDocContext &CDCtx, const Location &L, raw_ostream &OS)
static void	maybeWriteSourceFileRef (llvm::raw_ostream &OS, const ClangDocContext &CDCtx, const std::optional< Location > &DefLoc)
static void	writeDescription (const CommentInfo &I, raw_ostream &OS)
static void	writeNameLink (const StringRef &CurrentPath, const Reference &R, llvm::raw_ostream &OS)
static void	genMarkdown (const ClangDocContext &CDCtx, const EnumInfo &I, llvm::raw_ostream &OS)
static void	genMarkdown (const ClangDocContext &CDCtx, const FunctionInfo &I, llvm::raw_ostream &OS)
static void	genMarkdown (const ClangDocContext &CDCtx, const NamespaceInfo &I, llvm::raw_ostream &OS)
static void	genMarkdown (const ClangDocContext &CDCtx, const RecordInfo &I, llvm::raw_ostream &OS)
static void	genMarkdown (const ClangDocContext &CDCtx, const TypedefInfo &I, llvm::raw_ostream &OS)
static void	serializeReference (llvm::raw_fd_ostream &OS, Index &I, int Level)
static llvm::Error	serializeIndex (ClangDocContext &CDCtx)
static llvm::Error	genIndex (ClangDocContext &CDCtx)
static GeneratorRegistry::Add< MDGenerator >	MD (MDGenerator::Format, "Generator for MD output.")
CommentKind	stringToCommentKind (llvm::StringRef KindStr)
llvm::StringRef	commentKindToString (CommentKind Kind)
llvm::Expected< std::unique_ptr< Info > >	mergeInfos (std::vector< std::unique_ptr< Info > > &Values)
static llvm::SmallString< 64 >	calculateRelativeFilePath (const InfoType &Type, const StringRef &Path, const StringRef &Name, const StringRef &CurrentPath)
llvm::Error	copyFile (llvm::StringRef FilePath, llvm::StringRef OutDirectory)
llvm::SmallString< 128 >	computeRelativePath (llvm::StringRef Destination, llvm::StringRef Origin)
static GeneratorRegistry::Add< YAMLGenerator >	YAML (YAMLGenerator::Format, "Generator for YAML output.")

Variables
static const SymbolID	EmptySID = SymbolID()
static const llvm::IndexedMap< llvm::StringRef, BlockIdToIndexFunctor >	BlockIdNameMap
static const llvm::IndexedMap< RecordIdDsc, RecordIdToIndexFunctor >	RecordIdNameMap
static const std::vector< std::pair< BlockId, std::vector< RecordId > > >	RecordsByBlock
static const unsigned	VersionNumber = 3
static constexpr unsigned	BlockIdCount = BI_LAST - BI_FIRST
static constexpr unsigned	RecordIdCount = RI_LAST - RI_FIRST
static int LLVM_ATTRIBUTE_UNUSED	YAMLGeneratorAnchorDest
static int LLVM_ATTRIBUTE_UNUSED	MDGeneratorAnchorDest
static int LLVM_ATTRIBUTE_UNUSED	HTMLGeneratorAnchorDest
static int LLVM_ATTRIBUTE_UNUSED	MHTMLGeneratorAnchorDest
static int LLVM_ATTRIBUTE_UNUSED	JSONGeneratorAnchorDest
volatile int	YAMLGeneratorAnchorSource = 0
volatile int	MDGeneratorAnchorSource = 0
volatile int	HTMLGeneratorAnchorSource = 0
volatile int	MHTMLGeneratorAnchorSource = 0
volatile int	JSONGeneratorAnchorSource = 0
static std::unique_ptr< MustacheTemplateFile >	NamespaceTemplate = nullptr
static std::unique_ptr< MustacheTemplateFile >	RecordTemplate = nullptr
static auto	SerializeInfoLambda
static auto	SerializeReferenceLambda
static llvm::StringSet	USRVisited
static llvm::sys::SmartMutex< true >	USRVisitedGuard

Typedef Documentation

◆ AbbrevDsc

using clang::doc::AbbrevDsc = void (*)(std::shared_ptr<llvm::BitCodeAbbrev> &Abbrev)

Definition at line 31 of file BitcodeWriter.cpp.

◆ GeneratorRegistry

typedef llvm::Registry<Generator> clang::doc::GeneratorRegistry

Definition at line 48 of file Generators.h.

◆ Record

using clang::doc::Record = llvm::SmallVector<uint64_t, 1024>

Definition at line 19 of file BitcodeReader.cpp.

◆ SymbolID

using clang::doc::SymbolID = std::array<uint8_t, 20>

Definition at line 31 of file Representation.h.

Enumeration Type Documentation

◆ BlockId

enum clang::doc::BlockId

Enumerator
BI_VERSION_BLOCK_ID
BI_NAMESPACE_BLOCK_ID
BI_ENUM_BLOCK_ID
BI_ENUM_VALUE_BLOCK_ID
BI_TYPE_BLOCK_ID
BI_FIELD_TYPE_BLOCK_ID
BI_MEMBER_TYPE_BLOCK_ID
BI_RECORD_BLOCK_ID
BI_BASE_RECORD_BLOCK_ID
BI_FUNCTION_BLOCK_ID
BI_COMMENT_BLOCK_ID
BI_REFERENCE_BLOCK_ID
BI_TEMPLATE_BLOCK_ID
BI_TEMPLATE_SPECIALIZATION_BLOCK_ID
BI_TEMPLATE_PARAM_BLOCK_ID
BI_CONSTRAINT_BLOCK_ID
BI_TYPEDEF_BLOCK_ID
BI_CONCEPT_BLOCK_ID
BI_VAR_BLOCK_ID
BI_FRIEND_BLOCK_ID
BI_LAST
BI_FIRST

Definition at line 53 of file BitcodeWriter.h.

◆ CommentKind

enum class clang::doc::CommentKind

strong

Enumerator
CK_FullComment
CK_ParagraphComment
CK_TextComment
CK_InlineCommandComment
CK_HTMLStartTagComment
CK_HTMLEndTagComment
CK_BlockCommandComment
CK_ParamCommandComment
CK_TParamCommandComment
CK_VerbatimBlockComment
CK_VerbatimBlockLineComment
CK_VerbatimLineComment
CK_Unknown

Definition at line 53 of file Representation.h.

◆ FieldId

enum class clang::doc::FieldId

strong

Enumerator
F_default
F_namespace
F_parent
F_vparent
F_type
F_child_namespace
F_child_record
F_concept
F_friend

Definition at line 168 of file BitcodeWriter.h.

◆ InfoType

enum class clang::doc::InfoType

strong

Enumerator
IT_default
IT_namespace
IT_record
IT_function
IT_enum
IT_typedef
IT_concept
IT_variable
IT_friend

Definition at line 41 of file Representation.h.

◆ RecordId

enum clang::doc::RecordId

Enumerator
VERSION
FUNCTION_USR
FUNCTION_NAME
FUNCTION_DEFLOCATION
FUNCTION_LOCATION
FUNCTION_ACCESS
FUNCTION_IS_METHOD
FUNCTION_IS_STATIC
COMMENT_KIND
COMMENT_TEXT
COMMENT_NAME
COMMENT_DIRECTION
COMMENT_PARAMNAME
COMMENT_CLOSENAME
COMMENT_SELFCLOSING
COMMENT_EXPLICIT
COMMENT_ATTRKEY
COMMENT_ATTRVAL
COMMENT_ARG
TYPE_IS_BUILTIN
TYPE_IS_TEMPLATE
FIELD_TYPE_NAME
FIELD_DEFAULT_VALUE
FIELD_TYPE_IS_BUILTIN
FIELD_TYPE_IS_TEMPLATE
MEMBER_TYPE_NAME
MEMBER_TYPE_ACCESS
MEMBER_TYPE_IS_STATIC
MEMBER_TYPE_IS_BUILTIN
MEMBER_TYPE_IS_TEMPLATE
NAMESPACE_USR
NAMESPACE_NAME
NAMESPACE_PATH
ENUM_USR
ENUM_NAME
ENUM_DEFLOCATION
ENUM_LOCATION
ENUM_SCOPED
ENUM_VALUE_NAME
ENUM_VALUE_VALUE
ENUM_VALUE_EXPR
RECORD_USR
RECORD_NAME
RECORD_PATH
RECORD_DEFLOCATION
RECORD_LOCATION
RECORD_TAG_TYPE
RECORD_IS_TYPE_DEF
RECORD_MANGLED_NAME
BASE_RECORD_USR
BASE_RECORD_NAME
BASE_RECORD_PATH
BASE_RECORD_TAG_TYPE
BASE_RECORD_IS_VIRTUAL
BASE_RECORD_ACCESS
BASE_RECORD_IS_PARENT
REFERENCE_USR
REFERENCE_NAME
REFERENCE_QUAL_NAME
REFERENCE_TYPE
REFERENCE_PATH
REFERENCE_FIELD
REFERENCE_FILE
TEMPLATE_PARAM_CONTENTS
TEMPLATE_SPECIALIZATION_OF
TYPEDEF_USR
TYPEDEF_NAME
TYPEDEF_DEFLOCATION
TYPEDEF_IS_USING
CONCEPT_USR
CONCEPT_NAME
CONCEPT_IS_TYPE
CONCEPT_CONSTRAINT_EXPRESSION
CONSTRAINT_EXPRESSION
VAR_USR
VAR_NAME
VAR_DEFLOCATION
VAR_IS_STATIC
FRIEND_IS_CLASS
RI_LAST
RI_FIRST

Definition at line 80 of file BitcodeWriter.h.

Function Documentation

◆ addChild() [1/13]

template<>

void clang::doc::addChild	(	BaseRecordInfo *	I,
		FunctionInfo &&	R )

Definition at line 762 of file BitcodeReader.cpp.

References clang::doc::RecordInfo::Children, and clang::doc::ScopeChildren::Functions.

◆ addChild() [2/13]

template<>

void clang::doc::addChild	(	EnumInfo *	I,
		EnumValueInfo &&	R )

Definition at line 756 of file BitcodeReader.cpp.

References clang::doc::EnumInfo::Members.

◆ addChild() [3/13]

template<>

void clang::doc::addChild	(	NamespaceInfo *	I,
		ConceptInfo &&	R )

Definition at line 734 of file BitcodeReader.cpp.

References clang::doc::NamespaceInfo::Children, and clang::doc::ScopeChildren::Concepts.

◆ addChild() [4/13]

template<>

void clang::doc::addChild	(	NamespaceInfo *	I,
		EnumInfo &&	R )

Definition at line 728 of file BitcodeReader.cpp.

References clang::doc::NamespaceInfo::Children, and clang::doc::ScopeChildren::Enums.

◆ addChild() [5/13]

template<>

void clang::doc::addChild	(	NamespaceInfo *	I,
		FunctionInfo &&	R )

Definition at line 725 of file BitcodeReader.cpp.

References clang::doc::NamespaceInfo::Children, and clang::doc::ScopeChildren::Functions.

◆ addChild() [6/13]

template<>

void clang::doc::addChild	(	NamespaceInfo *	I,
		TypedefInfo &&	R )

Definition at line 731 of file BitcodeReader.cpp.

References clang::doc::NamespaceInfo::Children, and clang::doc::ScopeChildren::Typedefs.

◆ addChild() [7/13]

template<>

void clang::doc::addChild	(	NamespaceInfo *	I,
		VarInfo &&	R )

Definition at line 737 of file BitcodeReader.cpp.

References clang::doc::NamespaceInfo::Children, and clang::doc::ScopeChildren::Variables.

◆ addChild() [8/13]

template<>

void clang::doc::addChild	(	RecordInfo *	I,
		BaseRecordInfo &&	R )

Definition at line 759 of file BitcodeReader.cpp.

References clang::doc::RecordInfo::Bases.

◆ addChild() [9/13]

template<>

void clang::doc::addChild	(	RecordInfo *	I,
		EnumInfo &&	R )

Definition at line 745 of file BitcodeReader.cpp.

References clang::doc::RecordInfo::Children, and clang::doc::ScopeChildren::Enums.

◆ addChild() [10/13]

template<>

void clang::doc::addChild	(	RecordInfo *	I,
		FriendInfo &&	R )

Definition at line 751 of file BitcodeReader.cpp.

References clang::doc::RecordInfo::Friends.

◆ addChild() [11/13]

template<>

void clang::doc::addChild	(	RecordInfo *	I,
		FunctionInfo &&	R )

Definition at line 742 of file BitcodeReader.cpp.

References clang::doc::RecordInfo::Children, and clang::doc::ScopeChildren::Functions.

◆ addChild() [12/13]

template<>

void clang::doc::addChild	(	RecordInfo *	I,
		TypedefInfo &&	R )

Definition at line 748 of file BitcodeReader.cpp.

References clang::doc::RecordInfo::Children, and clang::doc::ScopeChildren::Typedefs.

◆ addChild() [13/13]

template<typename T, typename ChildInfoType>

void clang::doc::addChild	(	T	I,
		ChildInfoType &&	R )

static

Definition at line 719 of file BitcodeReader.cpp.

◆ addConstraint() [1/2]

template<typename T>

void clang::doc::addConstraint	(	T	I,
		ConstraintInfo &&	C )

static

Definition at line 811 of file BitcodeReader.cpp.

◆ addConstraint() [2/2]

template<>

void clang::doc::addConstraint	(	TemplateInfo *	I,
		ConstraintInfo &&	C )

Definition at line 815 of file BitcodeReader.cpp.

References clang::doc::TemplateInfo::Constraints.

◆ addReference() [1/12]

template<>

llvm::Error clang::doc::addReference	(	ConstraintInfo *	I,
		Reference &&	R,
		FieldId	F )

Definition at line 698 of file BitcodeReader.cpp.

References clang::doc::ConstraintInfo::ConceptRef, and F_concept.

◆ addReference() [2/12]

template<>

llvm::Error clang::doc::addReference	(	EnumInfo *	I,
		Reference &&	R,
		FieldId	F )

Definition at line 622 of file BitcodeReader.cpp.

References F_namespace, and clang::doc::Info::Namespace.

◆ addReference() [3/12]

template<>

llvm::Error clang::doc::addReference	(	FieldTypeInfo *	I,
		Reference &&	R,
		FieldId	F )

Definition at line 599 of file BitcodeReader.cpp.

References F_type, and clang::doc::TypeInfo::Type.

◆ addReference() [4/12]

template<>

llvm::Error clang::doc::addReference	(	FriendInfo *	Friend,
		Reference &&	R,
		FieldId	F )

Definition at line 709 of file BitcodeReader.cpp.

References F_friend, and clang::doc::FriendInfo::Ref.

◆ addReference() [5/12]

template<>

llvm::Error clang::doc::addReference	(	FunctionInfo *	I,
		Reference &&	R,
		FieldId	F )

Definition at line 663 of file BitcodeReader.cpp.

References F_namespace, F_parent, clang::doc::Info::Namespace, and clang::doc::FunctionInfo::Parent.

◆ addReference() [6/12]

template<>

llvm::Error clang::doc::addReference	(	MemberTypeInfo *	I,
		Reference &&	R,
		FieldId	F )

Definition at line 611 of file BitcodeReader.cpp.

References F_type, and clang::doc::TypeInfo::Type.

◆ addReference() [7/12]

template<>

llvm::Error clang::doc::addReference	(	NamespaceInfo *	I,
		Reference &&	R,
		FieldId	F )

Definition at line 645 of file BitcodeReader.cpp.

References clang::doc::NamespaceInfo::Children, F_child_namespace, F_child_record, F_namespace, clang::doc::Info::Namespace, clang::doc::ScopeChildren::Namespaces, and clang::doc::ScopeChildren::Records.

◆ addReference() [8/12]

template<>

llvm::Error clang::doc::addReference	(	RecordInfo *	I,
		Reference &&	R,
		FieldId	F )

Definition at line 677 of file BitcodeReader.cpp.

References clang::doc::RecordInfo::Children, F_child_record, F_namespace, F_parent, F_vparent, clang::doc::Info::Namespace, clang::doc::RecordInfo::Parents, clang::doc::ScopeChildren::Records, and clang::doc::RecordInfo::VirtualParents.

◆ addReference() [9/12]

template<typename T>

llvm::Error clang::doc::addReference	(	T	I,
		Reference &&	R,
		FieldId	F )

static

Definition at line 571 of file BitcodeReader.cpp.

◆ addReference() [10/12]

template<>

llvm::Error clang::doc::addReference	(	TypedefInfo *	I,
		Reference &&	R,
		FieldId	F )

Definition at line 633 of file BitcodeReader.cpp.

References F_namespace, and clang::doc::Info::Namespace.

◆ addReference() [11/12]

template<>

llvm::Error clang::doc::addReference	(	TypeInfo *	I,
		Reference &&	R,
		FieldId	F )

Definition at line 587 of file BitcodeReader.cpp.

References F_type, and clang::doc::TypeInfo::Type.

◆ addReference() [12/12]

template<>

llvm::Error clang::doc::addReference	(	VarInfo *	I,
		Reference &&	R,
		FieldId	F )

Definition at line 576 of file BitcodeReader.cpp.

References F_namespace, and clang::doc::Info::Namespace.

◆ addTemplate() [1/5]

template<>

void clang::doc::addTemplate	(	ConceptInfo *	I,
		TemplateInfo &&	P )

Definition at line 792 of file BitcodeReader.cpp.

References clang::doc::ConceptInfo::Template.

◆ addTemplate() [2/5]

template<>

void clang::doc::addTemplate	(	FriendInfo *	I,
		TemplateInfo &&	P )

Definition at line 795 of file BitcodeReader.cpp.

References clang::doc::FriendInfo::Template.

◆ addTemplate() [3/5]

template<>

void clang::doc::addTemplate	(	FunctionInfo *	I,
		TemplateInfo &&	P )

Definition at line 789 of file BitcodeReader.cpp.

References clang::doc::FunctionInfo::Template.

◆ addTemplate() [4/5]

template<>

void clang::doc::addTemplate	(	RecordInfo *	I,
		TemplateInfo &&	P )

Definition at line 786 of file BitcodeReader.cpp.

References clang::doc::RecordInfo::Template.

◆ addTemplate() [5/5]

template<typename T>

void clang::doc::addTemplate	(	T	I,
		TemplateInfo &&	P )

static

Definition at line 782 of file BitcodeReader.cpp.

◆ addTemplateParam() [1/3]

template<typename T>

void clang::doc::addTemplateParam	(	T	I,
		TemplateParamInfo &&	P )

static

Definition at line 769 of file BitcodeReader.cpp.

◆ addTemplateParam() [2/3]

template<>

void clang::doc::addTemplateParam	(	TemplateInfo *	I,
		TemplateParamInfo &&	P )

Definition at line 773 of file BitcodeReader.cpp.

References clang::doc::TemplateInfo::Params.

◆ addTemplateParam() [3/3]

template<>

void clang::doc::addTemplateParam	(	TemplateSpecializationInfo *	I,
		TemplateParamInfo &&	P )

Definition at line 777 of file BitcodeReader.cpp.

References clang::doc::TemplateSpecializationInfo::Params.

◆ addTemplateSpecialization() [1/2]

template<typename T>

void clang::doc::addTemplateSpecialization	(	T	I,
		TemplateSpecializationInfo &&	TSI )

static

Definition at line 801 of file BitcodeReader.cpp.

◆ addTemplateSpecialization() [2/2]

template<>

void clang::doc::addTemplateSpecialization	(	TemplateInfo *	I,
		TemplateSpecializationInfo &&	TSI )

Definition at line 806 of file BitcodeReader.cpp.

References clang::doc::TemplateInfo::Specialization.

◆ addTypeInfo() [1/10]

template<>

llvm::Error clang::doc::addTypeInfo	(	BaseRecordInfo *	I,
		MemberTypeInfo &&	T )

Definition at line 528 of file BitcodeReader.cpp.

References clang::doc::RecordInfo::Members.

◆ addTypeInfo() [2/10]

template<>

llvm::Error clang::doc::addTypeInfo	(	EnumInfo *	I,
		TypeInfo &&	T )

Definition at line 555 of file BitcodeReader.cpp.

References clang::doc::EnumInfo::BaseType.

◆ addTypeInfo() [3/10]

template<>

llvm::Error clang::doc::addTypeInfo	(	FriendInfo *	I,
		FieldTypeInfo &&	T )

Definition at line 543 of file BitcodeReader.cpp.

References clang::doc::FriendInfo::Params.

◆ addTypeInfo() [4/10]

template<>

llvm::Error clang::doc::addTypeInfo	(	FriendInfo *	I,
		TypeInfo &&	T )

Definition at line 550 of file BitcodeReader.cpp.

References clang::doc::FriendInfo::ReturnType.

◆ addTypeInfo() [5/10]

template<>

llvm::Error clang::doc::addTypeInfo	(	FunctionInfo *	I,
		FieldTypeInfo &&	T )

Definition at line 538 of file BitcodeReader.cpp.

References clang::doc::FunctionInfo::Params.

◆ addTypeInfo() [6/10]

template<>

llvm::Error clang::doc::addTypeInfo	(	FunctionInfo *	I,
		TypeInfo &&	T )

Definition at line 533 of file BitcodeReader.cpp.

References clang::doc::FunctionInfo::ReturnType.

◆ addTypeInfo() [7/10]

template<>

llvm::Error clang::doc::addTypeInfo	(	RecordInfo *	I,
		MemberTypeInfo &&	T )

Definition at line 523 of file BitcodeReader.cpp.

References clang::doc::RecordInfo::Members.

◆ addTypeInfo() [8/10]

template<typename T, typename TTypeInfo>

llvm::Error clang::doc::addTypeInfo	(	T	I,
		TTypeInfo &&	TI )

static

Definition at line 518 of file BitcodeReader.cpp.

◆ addTypeInfo() [9/10]

template<>

llvm::Error clang::doc::addTypeInfo	(	TypedefInfo *	I,
		TypeInfo &&	T )

Definition at line 560 of file BitcodeReader.cpp.

References clang::doc::TypedefInfo::Underlying.

◆ addTypeInfo() [10/10]

template<>

llvm::Error clang::doc::addTypeInfo	(	VarInfo *	I,
		TypeInfo &&	T )

Definition at line 565 of file BitcodeReader.cpp.

References clang::doc::VarInfo::Type.

◆ appendVector()

template<typename Derived, typename Base, typename = std::enable_if<std::is_base_of<Derived, Base>::value>>

void clang::doc::appendVector	(	std::vector< Derived > &&	New,
		std::vector< Base > &	Original )

static

Definition at line 248 of file HTMLGenerator.cpp.

Referenced by genEnumsBlock(), genFileHeadNodes(), genFunctionsBlock(), genHTML(), genHTML(), genHTML(), genIndex(), genInfoFile(), and genInfoFileMainNode().

◆ calculateRelativeFilePath()

llvm::SmallString< 64 > clang::doc::calculateRelativeFilePath	(	const InfoType &	Type,
		const StringRef &	Path,
		const StringRef &	Name,
		const StringRef &	CurrentPath )

static

Definition at line 195 of file Representation.cpp.

References IT_namespace.

Referenced by clang::doc::Info::getRelativeFilePath(), and clang::doc::Reference::getRelativeFilePath().

◆ commentKindToString()

llvm::StringRef clang::doc::commentKindToString ( CommentKind Kind )

Definition at line 53 of file Representation.cpp.

References CK_BlockCommandComment, CK_FullComment, CK_HTMLEndTagComment, CK_HTMLStartTagComment, CK_InlineCommandComment, CK_ParagraphComment, CK_ParamCommandComment, CK_TextComment, CK_TParamCommandComment, CK_Unknown, CK_VerbatimBlockComment, CK_VerbatimBlockLineComment, and CK_VerbatimLineComment.

Referenced by clang::doc::ClangDocBitcodeWriter::emitBlock(), and serializeComment().

◆ computeRelativePath()

llvm::SmallString< 128 > clang::doc::computeRelativePath	(	llvm::StringRef	Destination,
		llvm::StringRef	Origin )

Definition at line 31 of file File.cpp.

Referenced by genJsScriptsHTML(), and genStylesheetsHTML().

◆ copyFile()

llvm::Error clang::doc::copyFile	(	llvm::StringRef	FilePath,
		llvm::StringRef	OutDirectory )

Definition at line 15 of file File.cpp.

References OutDirectory().

Referenced by clang::doc::HTMLGenerator::createResources(), and clang::doc::MustacheHTMLGenerator::createResources().

◆ createFileOpenError()

Error clang::doc::createFileOpenError	(	StringRef	FileName,
		std::error_code	EC )

static

Definition at line 34 of file HTMLMustacheGenerator.cpp.

Referenced by clang::doc::MustacheTemplateFile::createMustacheFile(), clang::doc::MustacheHTMLGenerator::generateDocs(), and clang::doc::MustacheTemplateFile::registerPartialFile().

◆ decodeRecord() [1/10]

llvm::Error clang::doc::decodeRecord	(	const Record &	R,
		AccessSpecifier &	Field,
		llvm::StringRef	Blob )

static

Definition at line 48 of file BitcodeReader.cpp.

◆ decodeRecord() [2/10]

llvm::Error clang::doc::decodeRecord	(	const Record &	R,
		bool &	Field,
		llvm::StringRef	Blob )

static

Definition at line 42 of file BitcodeReader.cpp.

◆ decodeRecord() [3/10]

llvm::Error clang::doc::decodeRecord	(	const Record &	R,
		FieldId &	Field,
		llvm::StringRef	Blob )

static

Definition at line 105 of file BitcodeReader.cpp.

References F_child_namespace, F_child_record, F_concept, F_default, F_friend, F_namespace, F_parent, F_type, and F_vparent.

◆ decodeRecord() [4/10]

llvm::Error clang::doc::decodeRecord	(	const Record &	R,
		InfoType &	Field,
		llvm::StringRef	Blob )

static

Definition at line 86 of file BitcodeReader.cpp.

References IT_concept, IT_default, IT_enum, IT_friend, IT_function, IT_namespace, IT_record, IT_typedef, and IT_variable.

◆ decodeRecord() [5/10]

llvm::Error clang::doc::decodeRecord	(	const Record &	R,
		llvm::SmallVectorImpl< char > &	Field,
		llvm::StringRef	Blob )

static

Definition at line 22 of file BitcodeReader.cpp.

Referenced by parseRecord(), parseRecord(), parseRecord(), parseRecord(), parseRecord(), parseRecord(), parseRecord(), parseRecord(), parseRecord(), parseRecord(), parseRecord(), parseRecord(), parseRecord(), parseRecord(), parseRecord(), parseRecord(), parseRecord(), and parseRecord().

◆ decodeRecord() [6/10]

llvm::Error clang::doc::decodeRecord	(	const Record &	R,
		llvm::SmallVectorImpl< llvm::SmallString< 16 > > &	Field,
		llvm::StringRef	Blob )

static

Definition at line 125 of file BitcodeReader.cpp.

◆ decodeRecord() [7/10]

llvm::Error clang::doc::decodeRecord	(	const Record &	R,
		llvm::SmallVectorImpl< Location > &	Field,
		llvm::StringRef	Blob )

static

Definition at line 132 of file BitcodeReader.cpp.

◆ decodeRecord() [8/10]

llvm::Error clang::doc::decodeRecord	(	const Record &	R,
		std::optional< Location > &	Field,
		llvm::StringRef	Blob )

static

Definition at line 76 of file BitcodeReader.cpp.

◆ decodeRecord() [9/10]

llvm::Error clang::doc::decodeRecord	(	const Record &	R,
		SymbolID &	Field,
		llvm::StringRef	Blob )

static

Definition at line 29 of file BitcodeReader.cpp.

References clang::doc::BitCodeConstants::USRHashSize.

◆ decodeRecord() [10/10]

llvm::Error clang::doc::decodeRecord	(	const Record &	R,
		TagTypeKind &	Field,
		llvm::StringRef	Blob )

static

Definition at line 61 of file BitcodeReader.cpp.

◆ determineFileName()

SmallString< 16 > clang::doc::determineFileName	(	Info *	I,
		SmallString< 128 > &	Path )

static

Definition at line 580 of file JSONGenerator.cpp.

References clang::doc::Info::getFileBaseName(), clang::doc::Info::IT, IT_namespace, IT_record, clang::doc::SymbolInfo::MangledName, and clang::doc::Info::Name.

Referenced by clang::doc::JSONGenerator::generateDocs().

◆ extractTextComments()

json::Value clang::doc::extractTextComments ( Object * ParagraphComment )

static

Definition at line 100 of file JSONGenerator.cpp.

Referenced by serializeComment(), and serializeCommonAttributes().

◆ extractVerbatimComments()

json::Value clang::doc::extractVerbatimComments ( json::Array VerbatimLines )

static

Definition at line 106 of file JSONGenerator.cpp.

Referenced by serializeComment().

◆ findGeneratorByName()

llvm::Expected< std::unique_ptr< Generator > > clang::doc::findGeneratorByName ( llvm::StringRef Format )

Definition at line 17 of file Generators.cpp.

Referenced by clang::doc::MustacheHTMLGenerator::generateDocs().

◆ genBoolAbbrev()

void clang::doc::genBoolAbbrev ( std::shared_ptr< llvm::BitCodeAbbrev > & Abbrev )

static

Definition at line 40 of file BitcodeWriter.cpp.

References clang::doc::BitCodeConstants::BoolSize, and generateAbbrev().

◆ genEmphasis()

std::string clang::doc::genEmphasis ( const Twine & Text )

static

Definition at line 29 of file MDGenerator.cpp.

Referenced by writeDescription().

◆ genEnumMembersBlock()

std::unique_ptr< TagNode > clang::doc::genEnumMembersBlock ( const llvm::SmallVector< EnumValueInfo, 4 > & Members )

static

Definition at line 358 of file HTMLGenerator.cpp.

References genHTML().

Referenced by genHTML().

◆ genEnumsBlock()

std::vector< std::unique_ptr< TagNode > > clang::doc::genEnumsBlock	(	const std::vector< EnumInfo > &	Enums,
		const ClangDocContext &	CDCtx )

static

Definition at line 340 of file HTMLGenerator.cpp.

References appendVector(), and genHTML().

Referenced by genHTML(), and genHTML().

◆ generateAbbrev()

void clang::doc::generateAbbrev	(	std::shared_ptr< llvm::BitCodeAbbrev > &	Abbrev,
		const std::initializer_list< llvm::BitCodeAbbrevOp >	Ops )

static

Definition at line 34 of file BitcodeWriter.cpp.

Referenced by genBoolAbbrev(), genIntAbbrev(), genLocationAbbrev(), genStringAbbrev(), and genSymbolIdAbbrev().

◆ generateDocForJSON()

Error clang::doc::generateDocForJSON	(	json::Value &	JSON,
		StringRef	Filename,
		StringRef	Path,
		raw_fd_ostream &	OS,
		const ClangDocContext &	CDCtx )

static

Definition at line 231 of file HTMLMustacheGenerator.cpp.

References JSON(), NamespaceTemplate, RecordTemplate, and setupTemplateValue().

Referenced by clang::doc::MustacheHTMLGenerator::generateDocs().

◆ genFileFooterNode()

std::unique_ptr< TagNode > clang::doc::genFileFooterNode ( )

static

Definition at line 569 of file HTMLGenerator.cpp.

Referenced by genIndex(), and genInfoFile().

◆ genFileHeaderNode()

std::unique_ptr< TagNode > clang::doc::genFileHeaderNode ( StringRef ProjectName )

static

Definition at line 524 of file HTMLGenerator.cpp.

References ProjectName().

Referenced by genIndex(), and genInfoFile().

◆ genFileHeadNodes()

std::vector< std::unique_ptr< TagNode > > clang::doc::genFileHeadNodes	(	StringRef	Title,
		StringRef	InfoPath,
		const ClangDocContext &	CDCtx )

static

Definition at line 506 of file HTMLGenerator.cpp.

References appendVector(), genJsScriptsHTML(), and genStylesheetsHTML().

Referenced by genIndex(), and genInfoFile().

◆ genFunctionsBlock()

std::vector< std::unique_ptr< TagNode > > clang::doc::genFunctionsBlock	(	const std::vector< FunctionInfo > &	Functions,
		const ClangDocContext &	CDCtx,
		StringRef	ParentInfoDir )

static

Definition at line 387 of file HTMLGenerator.cpp.

References appendVector(), and genHTML().

Referenced by genHTML(), and genHTML().

◆ genHTML() [1/8]

std::unique_ptr< HTMLNode > clang::doc::genHTML ( const CommentInfo & I )

static

◆ genHTML() [2/8]

std::vector< std::unique_ptr< TagNode > > clang::doc::genHTML	(	const EnumInfo &	I,
		const ClangDocContext &	CDCtx )

static

◆ genHTML() [3/8]

std::vector< std::unique_ptr< TagNode > > clang::doc::genHTML	(	const FunctionInfo &	I,
		const ClangDocContext &	CDCtx,
		StringRef	ParentInfoDir )

static

Definition at line 741 of file HTMLGenerator.cpp.

References clang::doc::FunctionInfo::Access, clang::doc::SymbolInfo::DefLoc, clang::doc::Info::Description, genHTML(), genReference(), clang::doc::SymbolInfo::IsStatic, maybeWriteSourceFileRef(), clang::doc::Info::Name, clang::doc::Reference::Name, clang::doc::FunctionInfo::Params, clang::doc::FunctionInfo::ReturnType, clang::doc::TypeInfo::Type, and clang::doc::Info::USR.

◆ genHTML() [4/8]

std::vector< std::unique_ptr< TagNode > > clang::doc::genHTML	(	const Index &	Index,
		StringRef	InfoPath,
		bool	IsOutermostList )

static

Definition at line 611 of file HTMLGenerator.cpp.

References appendVector(), clang::doc::Index::Children, genHTML(), genReference(), clang::doc::Index::JumpToSection, and clang::doc::Reference::Name.

◆ genHTML() [5/8]

std::vector< std::unique_ptr< TagNode > > clang::doc::genHTML	(	const NamespaceInfo &	I,
		Index &	InfoIndex,
		const ClangDocContext &	CDCtx,
		std::string &	InfoTitle )

static

Definition at line 786 of file HTMLGenerator.cpp.

References appendVector(), clang::doc::Index::Children, clang::doc::NamespaceInfo::Children, clang::doc::Info::Description, clang::doc::ScopeChildren::Enums, clang::doc::ScopeChildren::Functions, genEnumsBlock(), genFunctionsBlock(), genHTML(), genInfoIndexItem(), genReferencesBlock(), clang::doc::Info::getRelativeFilePath(), clang::doc::Info::Name, clang::doc::ScopeChildren::Namespaces, and clang::doc::ScopeChildren::Records.

◆ genHTML() [6/8]

std::vector< std::unique_ptr< TagNode > > clang::doc::genHTML	(	const RecordInfo &	I,
		Index &	InfoIndex,
		const ClangDocContext &	CDCtx,
		std::string &	InfoTitle )

static

◆ genHTML() [7/8]

std::unique_ptr< TagNode > clang::doc::genHTML ( const std::vector< CommentInfo > & C )

static

Definition at line 696 of file HTMLGenerator.cpp.

References genHTML().

◆ genHTML() [8/8]

std::vector< std::unique_ptr< TagNode > > clang::doc::genHTML	(	const TypedefInfo &	I,
		const ClangDocContext &	CDCtx,
		std::string &	InfoTitle )

static

Definition at line 889 of file HTMLGenerator.cpp.

◆ genIndex() [1/2]

llvm::Error clang::doc::genIndex ( ClangDocContext & CDCtx )

static

Definition at line 344 of file MDGenerator.cpp.

References clang::doc::Index::Children, clang::doc::ClangDocContext::Idx, IT_concept, IT_default, IT_enum, IT_friend, IT_function, IT_namespace, IT_record, IT_typedef, IT_variable, clang::doc::ClangDocContext::OutDirectory, clang::doc::ClangDocContext::ProjectName, and clang::doc::Index::sort().

◆ genIndex() [2/2]

llvm::Error clang::doc::genIndex ( const ClangDocContext & CDCtx )

static

Definition at line 1095 of file HTMLGenerator.cpp.

References appendVector(), genFileFooterNode(), genFileHeaderNode(), genFileHeadNodes(), genIndexFileMainNode(), clang::doc::ClangDocContext::OutDirectory, and clang::doc::ClangDocContext::ProjectName.

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

◆ genIndexFileMainNode()

std::unique_ptr< TagNode > clang::doc::genIndexFileMainNode ( )

static

Definition at line 1080 of file HTMLGenerator.cpp.

Referenced by genIndex().

◆ genInfoFile()

HTMLFile clang::doc::genInfoFile	(	StringRef	Title,
		StringRef	InfoPath,
		std::vector< std::unique_ptr< TagNode > > &	MainContentNodes,
		const Index &	InfoIndex,
		const ClangDocContext &	CDCtx )

static

Definition at line 580 of file HTMLGenerator.cpp.

References appendVector(), genFileFooterNode(), genFileHeaderNode(), genFileHeadNodes(), genInfoFileMainNode(), and clang::doc::ClangDocContext::ProjectName.

Referenced by clang::doc::HTMLGenerator::generateDocForInfo().

◆ genInfoFileMainNode()

std::unique_ptr< TagNode > clang::doc::genInfoFileMainNode	(	StringRef	InfoPath,
		std::vector< std::unique_ptr< TagNode > > &	MainContentInnerNodes,
		const Index &	InfoIndex )

static

Definition at line 534 of file HTMLGenerator.cpp.

References appendVector(), and genHTML().

Referenced by genInfoFile().

◆ genInfoIndexItem()

template<typename T, typename = std::enable_if<std::is_base_of<T, Info>::value>>

Index clang::doc::genInfoIndexItem	(	const std::vector< T > &	Infos,
		StringRef	Title )

static

Definition at line 602 of file HTMLGenerator.cpp.

References clang::doc::Index::Children.

Referenced by genHTML(), and genHTML().

◆ genIntAbbrev()

void clang::doc::genIntAbbrev ( std::shared_ptr< llvm::BitCodeAbbrev > & Abbrev )

static

Definition at line 47 of file BitcodeWriter.cpp.

References generateAbbrev(), and clang::doc::BitCodeConstants::IntSize.

◆ genItalic()

std::string clang::doc::genItalic ( const Twine & Text )

static

Definition at line 25 of file MDGenerator.cpp.

Referenced by genMarkdown().

◆ genJsScriptsHTML()

std::vector< std::unique_ptr< TagNode > > clang::doc::genJsScriptsHTML	(	StringRef	InfoPath,
		const ClangDocContext &	CDCtx )

static

Definition at line 273 of file HTMLGenerator.cpp.

References computeRelativePath(), and clang::doc::ClangDocContext::JsScripts.

Referenced by genFileHeadNodes().

◆ genLink()

std::unique_ptr< TagNode > clang::doc::genLink	(	const Twine &	Text,
		const Twine &	Link )

static

Definition at line 296 of file HTMLGenerator.cpp.

Referenced by genReference().

◆ genLocationAbbrev()

void clang::doc::genLocationAbbrev ( std::shared_ptr< llvm::BitCodeAbbrev > & Abbrev )

static

Definition at line 75 of file BitcodeWriter.cpp.

References clang::doc::BitCodeConstants::BoolSize, generateAbbrev(), clang::doc::BitCodeConstants::LineNumberSize, and clang::doc::BitCodeConstants::StringLengthSize.

◆ genMarkdown() [1/5]

void clang::doc::genMarkdown	(	const ClangDocContext &	CDCtx,
		const EnumInfo &	I,
		llvm::raw_ostream &	OS )

static

Definition at line 157 of file MDGenerator.cpp.

References clang::doc::SymbolInfo::DefLoc, clang::doc::Info::Description, maybeWriteSourceFileRef(), clang::doc::EnumInfo::Members, clang::doc::Info::Name, clang::doc::EnumInfo::Scoped, writeDescription(), and writeLine().

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

◆ genMarkdown() [2/5]

void clang::doc::genMarkdown	(	const ClangDocContext &	CDCtx,
		const FunctionInfo &	I,
		llvm::raw_ostream &	OS )

static

Definition at line 178 of file MDGenerator.cpp.

References clang::doc::FunctionInfo::Access, clang::doc::SymbolInfo::DefLoc, clang::doc::Info::Description, genItalic(), clang::doc::SymbolInfo::IsStatic, maybeWriteSourceFileRef(), clang::doc::Info::Name, clang::doc::FunctionInfo::Params, clang::doc::Reference::QualName, clang::doc::FunctionInfo::ReturnType, clang::doc::TypeInfo::Type, writeDescription(), writeHeader(), and writeLine().

◆ genMarkdown() [3/5]

void clang::doc::genMarkdown	(	const ClangDocContext &	CDCtx,
		const NamespaceInfo &	I,
		llvm::raw_ostream &	OS )

static

Definition at line 203 of file MDGenerator.cpp.

References clang::doc::NamespaceInfo::Children, clang::doc::Info::Description, clang::doc::ScopeChildren::Enums, clang::doc::ScopeChildren::Functions, genMarkdown(), clang::doc::Info::getRelativeFilePath(), clang::doc::Info::Name, clang::doc::ScopeChildren::Namespaces, clang::doc::ScopeChildren::Records, writeDescription(), writeHeader(), writeNameLink(), and writeNewLine().

◆ genMarkdown() [4/5]

void clang::doc::genMarkdown	(	const ClangDocContext &	CDCtx,
		const RecordInfo &	I,
		llvm::raw_ostream &	OS )

static

◆ genMarkdown() [5/5]

void clang::doc::genMarkdown	(	const ClangDocContext &	CDCtx,
		const TypedefInfo &	I,
		llvm::raw_ostream &	OS )

static

Definition at line 309 of file MDGenerator.cpp.

◆ genRecordMembersBlock()

std::vector< std::unique_ptr< TagNode > > clang::doc::genRecordMembersBlock	(	const llvm::SmallVector< MemberTypeInfo, 4 > &	Members,
		StringRef	ParentInfoDir )

static

Definition at line 406 of file HTMLGenerator.cpp.

References genHTML(), and genReference().

Referenced by genHTML().

◆ genReference()

std::unique_ptr< HTMLNode > clang::doc::genReference	(	const Reference &	Type,
		StringRef	CurrentDirectory,
		std::optional< StringRef >	JumpToSection = std::nullopt )

static

Definition at line 303 of file HTMLGenerator.cpp.

References genLink().

Referenced by genHTML(), genHTML(), genRecordMembersBlock(), genReferenceList(), and genReferencesBlock().

◆ genReferenceList() [1/2]

std::string clang::doc::genReferenceList ( const llvm::SmallVectorImpl< Reference > & Refs )

static

Definition at line 34 of file MDGenerator.cpp.

◆ genReferenceList() [2/2]

std::vector< std::unique_ptr< HTMLNode > > clang::doc::genReferenceList	(	const llvm::SmallVectorImpl< Reference > &	Refs,
		const StringRef &	CurrentDirectory )

static

Definition at line 321 of file HTMLGenerator.cpp.

References genReference().

Referenced by genHTML(), and genMarkdown().

◆ genReferencesBlock()

std::vector< std::unique_ptr< TagNode > > clang::doc::genReferencesBlock	(	const std::vector< Reference > &	References,
		llvm::StringRef	Title,
		StringRef	ParentPath )

static

Definition at line 436 of file HTMLGenerator.cpp.

References genReference().

Referenced by genHTML(), and genHTML().

◆ genStringAbbrev()

void clang::doc::genStringAbbrev ( std::shared_ptr< llvm::BitCodeAbbrev > & Abbrev )

static

Definition at line 65 of file BitcodeWriter.cpp.

References generateAbbrev(), and clang::doc::BitCodeConstants::StringLengthSize.

◆ genStylesheetsHTML()

std::vector< std::unique_ptr< TagNode > > clang::doc::genStylesheetsHTML	(	StringRef	InfoPath,
		const ClangDocContext &	CDCtx )

static

Definition at line 256 of file HTMLGenerator.cpp.

References computeRelativePath(), and clang::doc::ClangDocContext::UserStylesheets.

Referenced by genFileHeadNodes().

◆ genSymbolIdAbbrev()

void clang::doc::genSymbolIdAbbrev ( std::shared_ptr< llvm::BitCodeAbbrev > & Abbrev )

static

Definition at line 54 of file BitcodeWriter.cpp.

References generateAbbrev(), clang::doc::BitCodeConstants::USRBitLengthSize, and clang::doc::BitCodeConstants::USRLengthSize.

◆ getCommentInfo() [1/11]

template<>

llvm::Expected< CommentInfo * > clang::doc::getCommentInfo ( CommentInfo * I )

Definition at line 501 of file BitcodeReader.cpp.

References clang::doc::CommentInfo::Children.

◆ getCommentInfo() [2/11]

template<>

llvm::Expected< CommentInfo * > clang::doc::getCommentInfo ( ConceptInfo * I )

Definition at line 506 of file BitcodeReader.cpp.

References clang::doc::Info::Description.

◆ getCommentInfo() [3/11]

template<>

llvm::Expected< CommentInfo * > clang::doc::getCommentInfo ( EnumInfo * I )

Definition at line 489 of file BitcodeReader.cpp.

References clang::doc::Info::Description.

◆ getCommentInfo() [4/11]

template<>

llvm::Expected< CommentInfo * > clang::doc::getCommentInfo ( EnumValueInfo * I )

Definition at line 497 of file BitcodeReader.cpp.

References clang::doc::EnumValueInfo::Description.

◆ getCommentInfo() [5/11]

template<>

llvm::Expected< CommentInfo * > clang::doc::getCommentInfo ( FunctionInfo * I )

Definition at line 473 of file BitcodeReader.cpp.

References clang::doc::Info::Description.

◆ getCommentInfo() [6/11]

template<>

llvm::Expected< CommentInfo * > clang::doc::getCommentInfo ( MemberTypeInfo * I )

Definition at line 485 of file BitcodeReader.cpp.

References clang::doc::MemberTypeInfo::Description.

◆ getCommentInfo() [7/11]

template<>

llvm::Expected< CommentInfo * > clang::doc::getCommentInfo ( NamespaceInfo * I )

Definition at line 477 of file BitcodeReader.cpp.

References clang::doc::Info::Description.

◆ getCommentInfo() [8/11]

template<>

llvm::Expected< CommentInfo * > clang::doc::getCommentInfo ( RecordInfo * I )

Definition at line 481 of file BitcodeReader.cpp.

References clang::doc::Info::Description.

◆ getCommentInfo() [9/11]

template<typename T>

llvm::Expected< CommentInfo * > clang::doc::getCommentInfo ( T I )

static

Definition at line 468 of file BitcodeReader.cpp.

◆ getCommentInfo() [10/11]

template<>

llvm::Expected< CommentInfo * > clang::doc::getCommentInfo ( TypedefInfo * I )

Definition at line 493 of file BitcodeReader.cpp.

References clang::doc::TypedefInfo::Description.

◆ getCommentInfo() [11/11]

template<>

Expected< CommentInfo * > clang::doc::getCommentInfo ( VarInfo * I )

Definition at line 510 of file BitcodeReader.cpp.

References clang::doc::Info::Description.

◆ getRefType()

std::string clang::doc::getRefType ( InfoType IT )

static

Definition at line 1004 of file HTMLGenerator.cpp.

References IT_concept, IT_default, IT_enum, IT_friend, IT_function, IT_namespace, IT_record, IT_typedef, and IT_variable.

Referenced by serializeIndex().

◆ getTagType()

std::string clang::doc::getTagType ( TagTypeKind AS )

Definition at line 29 of file Generators.cpp.

Referenced by genHTML(), genMarkdown(), and serializeInfo().

◆ HTML()

GeneratorRegistry::Add< HTMLGenerator > clang::doc::HTML	(	HTMLGenerator::Format	,
		"Generator for HTML output."	)

static

References clang::doc::HTMLGenerator::Format.

◆ infoTypeToString()

std::string clang::doc::infoTypeToString ( InfoType IT )

static

Definition at line 46 of file JSONGenerator.cpp.

References IT_concept, IT_default, IT_enum, IT_friend, IT_function, IT_namespace, IT_record, IT_typedef, and IT_variable.

Referenced by serializeCommonAttributes().

◆ insertArray()

void clang::doc::insertArray	(	Object &	Obj,
		json::Value &	Array,
		StringRef	Key )

static

Definition at line 463 of file JSONGenerator.cpp.

Referenced by serializeInfo().

◆ insertComment()

void clang::doc::insertComment	(	Object &	Description,
		json::Value &	Comment,
		StringRef	Key )

static

Definition at line 86 of file JSONGenerator.cpp.

Referenced by serializeComment(), and serializeCommonAttributes().

◆ isTypedefAnonRecord()

template<typename T>

bool clang::doc::isTypedefAnonRecord ( const T * D )

static

Definition at line 24 of file Mapper.cpp.

◆ JSON()

GeneratorRegistry::Add< JSONGenerator > clang::doc::JSON	(	JSONGenerator::Format	,
		"Generator for JSON output."	)

static

References clang::doc::JSONGenerator::Format.

Referenced by generateDocForJSON().

◆ maybeWriteSourceFileRef() [1/2]

void clang::doc::maybeWriteSourceFileRef	(	llvm::raw_ostream &	OS,
		const ClangDocContext &	CDCtx,
		const std::optional< Location > &	DefLoc )

static

Definition at line 70 of file MDGenerator.cpp.

References writeSourceFileRef().

◆ maybeWriteSourceFileRef() [2/2]

void clang::doc::maybeWriteSourceFileRef	(	std::vector< std::unique_ptr< TagNode > > &	Out,
		const ClangDocContext &	CDCtx,
		const std::optional< Location > &	DefLoc )

static

Definition at line 492 of file HTMLGenerator.cpp.

References writeSourceFileRef().

Referenced by genHTML(), genHTML(), genHTML(), genMarkdown(), genMarkdown(), and genMarkdown().

◆ MD()

GeneratorRegistry::Add< MDGenerator > clang::doc::MD	(	MDGenerator::Format	,
		"Generator for MD output."	)

static

References clang::doc::MDGenerator::Format.

Referenced by clang::doc::serialize::parseBases().

◆ mergeInfos()

llvm::Expected< std::unique_ptr< Info > > clang::doc::mergeInfos ( std::vector< std::unique_ptr< Info > > & Values )

Definition at line 130 of file Representation.cpp.

References IT_concept, IT_default, IT_enum, IT_friend, IT_function, IT_namespace, IT_record, IT_typedef, and IT_variable.

◆ MHTML()

GeneratorRegistry::Add< MustacheHTMLGenerator > clang::doc::MHTML	(	MustacheHTMLGenerator::Format	,
		"Generator for mustache HTML output."	)

static

References clang::doc::MustacheHTMLGenerator::Format.

◆ newMapperActionFactory()

std::unique_ptr< tooling::FrontendActionFactory > clang::doc::newMapperActionFactory ( ClangDocContext CDCtx )

Definition at line 56 of file ClangDoc.cpp.

◆ parseRecord() [1/20]

llvm::Error clang::doc::parseRecord	(	const Record &	R,
		unsigned	ID,
		llvm::StringRef	Blob,
		BaseRecordInfo *	I )

static

Definition at line 191 of file BitcodeReader.cpp.

References clang::doc::BaseRecordInfo::Access, BASE_RECORD_ACCESS, BASE_RECORD_IS_PARENT, BASE_RECORD_IS_VIRTUAL, BASE_RECORD_NAME, BASE_RECORD_PATH, BASE_RECORD_TAG_TYPE, BASE_RECORD_USR, decodeRecord(), clang::doc::BaseRecordInfo::IsParent, clang::doc::BaseRecordInfo::IsVirtual, clang::doc::Info::Name, clang::doc::Info::Path, clang::doc::RecordInfo::TagType, and clang::doc::Info::USR.

◆ parseRecord() [2/20]

llvm::Error clang::doc::parseRecord	(	const Record &	R,
		unsigned	ID,
		llvm::StringRef	Blob,
		CommentInfo *	I )

static

◆ parseRecord() [3/20]

llvm::Error clang::doc::parseRecord	(	const Record &	R,
		unsigned	ID,
		llvm::StringRef	Blob,
		ConceptInfo *	I )

static

Definition at line 419 of file BitcodeReader.cpp.

References CONCEPT_CONSTRAINT_EXPRESSION, CONCEPT_IS_TYPE, CONCEPT_NAME, CONCEPT_USR, clang::doc::ConceptInfo::ConstraintExpression, decodeRecord(), clang::doc::ConceptInfo::IsType, clang::doc::Info::Name, and clang::doc::Info::USR.

◆ parseRecord() [4/20]

llvm::Error clang::doc::parseRecord	(	const Record &	R,
		unsigned	ID,
		llvm::StringRef	Blob,
		const unsigned	VersionNo )

static

Definition at line 143 of file BitcodeReader.cpp.

References VERSION.

Referenced by clang::doc::ClangDocBitcodeReader::readRecord().

◆ parseRecord() [5/20]

llvm::Error clang::doc::parseRecord	(	const Record &	R,
		unsigned	ID,
		llvm::StringRef	Blob,
		ConstraintInfo *	I )

static

Definition at line 434 of file BitcodeReader.cpp.

References CONSTRAINT_EXPRESSION, clang::doc::ConstraintInfo::ConstraintExpr, and decodeRecord().

◆ parseRecord() [6/20]

llvm::Error clang::doc::parseRecord	(	const Record &	R,
		unsigned	ID,
		llvm::StringRef	Blob,
		EnumInfo *	I )

static

Definition at line 214 of file BitcodeReader.cpp.

References decodeRecord(), clang::doc::SymbolInfo::DefLoc, ENUM_DEFLOCATION, ENUM_LOCATION, ENUM_NAME, ENUM_SCOPED, ENUM_USR, clang::doc::SymbolInfo::Loc, clang::doc::Info::Name, clang::doc::EnumInfo::Scoped, and clang::doc::Info::USR.

◆ parseRecord() [7/20]

llvm::Error clang::doc::parseRecord	(	const Record &	R,
		unsigned	ID,
		llvm::StringRef	Blob,
		EnumValueInfo *	I )

static

Definition at line 250 of file BitcodeReader.cpp.

References decodeRecord(), ENUM_VALUE_EXPR, ENUM_VALUE_NAME, ENUM_VALUE_VALUE, clang::doc::EnumValueInfo::Name, clang::doc::EnumValueInfo::Value, and clang::doc::EnumValueInfo::ValueExpr.

◆ parseRecord() [8/20]

llvm::Error clang::doc::parseRecord	(	const Record &	R,
		unsigned	ID,
		llvm::StringRef	Blob,
		FieldTypeInfo *	I )

static

Definition at line 301 of file BitcodeReader.cpp.

References decodeRecord(), clang::doc::FieldTypeInfo::DefaultValue, FIELD_DEFAULT_VALUE, FIELD_TYPE_IS_BUILTIN, FIELD_TYPE_IS_TEMPLATE, FIELD_TYPE_NAME, clang::doc::TypeInfo::IsBuiltIn, clang::doc::TypeInfo::IsTemplate, and clang::doc::FieldTypeInfo::Name.

◆ parseRecord() [9/20]

llvm::Error clang::doc::parseRecord	(	const Record &	R,
		unsigned	ID,
		llvm::StringRef	Blob,
		FunctionInfo *	I )

static

Definition at line 265 of file BitcodeReader.cpp.

References clang::doc::FunctionInfo::Access, decodeRecord(), clang::doc::SymbolInfo::DefLoc, FUNCTION_ACCESS, FUNCTION_DEFLOCATION, FUNCTION_IS_METHOD, FUNCTION_IS_STATIC, FUNCTION_LOCATION, FUNCTION_NAME, FUNCTION_USR, clang::doc::FunctionInfo::IsMethod, clang::doc::SymbolInfo::IsStatic, clang::doc::SymbolInfo::Loc, clang::doc::Info::Name, and clang::doc::Info::USR.

◆ parseRecord() [10/20]

llvm::Error clang::doc::parseRecord	(	const Record &	R,
		unsigned	ID,
		llvm::StringRef	Blob,
		MemberTypeInfo *	I )

static

Definition at line 318 of file BitcodeReader.cpp.

References clang::doc::MemberTypeInfo::Access, decodeRecord(), clang::doc::TypeInfo::IsBuiltIn, clang::doc::MemberTypeInfo::IsStatic, clang::doc::TypeInfo::IsTemplate, MEMBER_TYPE_ACCESS, MEMBER_TYPE_IS_BUILTIN, MEMBER_TYPE_IS_STATIC, MEMBER_TYPE_IS_TEMPLATE, MEMBER_TYPE_NAME, and clang::doc::FieldTypeInfo::Name.

◆ parseRecord() [11/20]

llvm::Error clang::doc::parseRecord	(	const Record &	R,
		unsigned	ID,
		llvm::StringRef	Blob,
		NamespaceInfo *	I )

static

Definition at line 151 of file BitcodeReader.cpp.

References decodeRecord(), clang::doc::Info::Name, NAMESPACE_NAME, NAMESPACE_PATH, NAMESPACE_USR, clang::doc::Info::Path, and clang::doc::Info::USR.

◆ parseRecord() [12/20]

llvm::Error clang::doc::parseRecord	(	const Record &	R,
		unsigned	ID,
		llvm::StringRef	Blob,
		RecordInfo *	I )

static

Definition at line 166 of file BitcodeReader.cpp.

References decodeRecord(), clang::doc::SymbolInfo::DefLoc, clang::doc::RecordInfo::IsTypeDef, clang::doc::SymbolInfo::Loc, clang::doc::SymbolInfo::MangledName, clang::doc::Info::Name, clang::doc::Info::Path, RECORD_DEFLOCATION, RECORD_IS_TYPE_DEF, RECORD_LOCATION, RECORD_MANGLED_NAME, RECORD_NAME, RECORD_PATH, RECORD_TAG_TYPE, RECORD_USR, clang::doc::RecordInfo::TagType, and clang::doc::Info::USR.

◆ parseRecord() [13/20]

llvm::Error clang::doc::parseRecord	(	const Record &	R,
		unsigned	ID,
		llvm::StringRef	Blob,
		Reference *	I,
		FieldId &	F )

static

Definition at line 372 of file BitcodeReader.cpp.

References decodeRecord(), clang::doc::Reference::DocumentationFileName, clang::doc::Reference::Name, clang::doc::Reference::Path, clang::doc::Reference::QualName, REFERENCE_FIELD, REFERENCE_FILE, REFERENCE_NAME, REFERENCE_PATH, REFERENCE_QUAL_NAME, REFERENCE_TYPE, REFERENCE_USR, clang::doc::Reference::RefType, and clang::doc::Reference::USR.

◆ parseRecord() [14/20]

llvm::Error clang::doc::parseRecord	(	const Record &	R,
		unsigned	ID,
		llvm::StringRef	Blob,
		TemplateInfo *	I )

static

Definition at line 395 of file BitcodeReader.cpp.

◆ parseRecord() [15/20]

llvm::Error clang::doc::parseRecord	(	const Record &	R,
		unsigned	ID,
		llvm::StringRef	Blob,
		TemplateParamInfo *	I )

static

Definition at line 411 of file BitcodeReader.cpp.

References clang::doc::TemplateParamInfo::Contents, decodeRecord(), and TEMPLATE_PARAM_CONTENTS.

◆ parseRecord() [16/20]

llvm::Error clang::doc::parseRecord	(	const Record &	R,
		unsigned	ID,
		llvm::StringRef	Blob,
		TemplateSpecializationInfo *	I )

static

Definition at line 402 of file BitcodeReader.cpp.

References decodeRecord(), clang::doc::TemplateSpecializationInfo::SpecializationOf, and TEMPLATE_SPECIALIZATION_OF.

◆ parseRecord() [17/20]

llvm::Error clang::doc::parseRecord	(	const Record &	R,
		unsigned	ID,
		llvm::StringRef	Blob,
		TypedefInfo *	I )

static

Definition at line 233 of file BitcodeReader.cpp.

References decodeRecord(), clang::doc::SymbolInfo::DefLoc, clang::doc::TypedefInfo::IsUsing, clang::doc::Info::Name, TYPEDEF_DEFLOCATION, TYPEDEF_IS_USING, TYPEDEF_NAME, TYPEDEF_USR, and clang::doc::Info::USR.

◆ parseRecord() [18/20]

llvm::Error clang::doc::parseRecord	(	const Record &	R,
		unsigned	ID,
		llvm::StringRef	Blob,
		TypeInfo *	I )

static

Definition at line 288 of file BitcodeReader.cpp.

References decodeRecord(), clang::doc::TypeInfo::IsBuiltIn, clang::doc::TypeInfo::IsTemplate, TYPE_IS_BUILTIN, and TYPE_IS_TEMPLATE.

◆ parseRecord() [19/20]

llvm::Error clang::doc::parseRecord	(	const Record &	R,
		unsigned	ID,
		llvm::StringRef	Blob,
		VarInfo *	I )

static

Definition at line 442 of file BitcodeReader.cpp.

References decodeRecord(), clang::doc::SymbolInfo::DefLoc, clang::doc::SymbolInfo::IsStatic, clang::doc::Info::Name, clang::doc::Info::USR, VAR_DEFLOCATION, VAR_IS_STATIC, VAR_NAME, and VAR_USR.

◆ parseRecord() [20/20]

llvm::Error clang::doc::parseRecord	(	const Record &	R,
		unsigned	ID,
		StringRef	Blob,
		FriendInfo *	F )

static

Definition at line 459 of file BitcodeReader.cpp.

References decodeRecord(), FRIEND_IS_CLASS, and clang::doc::FriendInfo::IsClass.

◆ serializeArray()

template<typename Container, typename SerializationFunc>

void clang::doc::serializeArray	(	const Container &	Records,
		Object &	Obj,
		const std::string &	Key,
		SerializationFunc	SerializeInfo )

static

Definition at line 309 of file JSONGenerator.cpp.

Referenced by serializeCommonChildren(), serializeInfo(), serializeInfo(), serializeInfo(), serializeInfo(), serializeInfo(), and serializeInfo().

◆ serializeComment()

Object clang::doc::serializeComment	(	const CommentInfo &	I,
		Object &	Description )

static

Definition at line 118 of file JSONGenerator.cpp.

Referenced by serializeComment(), and serializeCommonAttributes().

◆ serializeCommonAttributes()

void clang::doc::serializeCommonAttributes	(	const Info &	I,
		json::Object &	Obj,
		const std::optional< StringRef >	RepositoryUrl )

static

Definition at line 232 of file JSONGenerator.cpp.

References clang::doc::Info::Description, clang::doc::Info::DocumentationFileName, extractTextComments(), infoTypeToString(), insertComment(), clang::doc::Info::IT, IT_namespace, clang::doc::Info::Name, clang::doc::Info::Namespace, clang::doc::Info::Path, RepositoryUrl(), serializeComment(), serializeLocation(), and clang::doc::Info::USR.

Referenced by serializeInfo(), serializeInfo(), serializeInfo(), serializeInfo(), serializeInfo(), serializeInfo(), and serializeInfo().

◆ serializeCommonChildren()

void clang::doc::serializeCommonChildren	(	const ScopeChildren &	Children,
		json::Object &	Obj,
		const std::optional< StringRef >	RepositoryUrl )

static

Definition at line 287 of file JSONGenerator.cpp.

References RepositoryUrl(), serializeArray(), serializeInfo(), and SerializeReferenceLambda.

Referenced by serializeInfo(), and serializeInfo().

◆ serializeIndex() [1/2]

llvm::Error clang::doc::serializeIndex ( ClangDocContext & CDCtx )

static

Definition at line 1028 of file HTMLGenerator.cpp.

References clang::doc::ClangDocContext::Base, getRefType(), clang::doc::ClangDocContext::Idx, clang::doc::ClangDocContext::OutDirectory, and clang::doc::Index::sort().

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

◆ serializeIndex() [2/2]

llvm::Error clang::doc::serializeIndex ( ClangDocContext & CDCtx )

static

Definition at line 321 of file MDGenerator.cpp.

References clang::doc::Index::Children, clang::doc::ClangDocContext::Idx, clang::doc::ClangDocContext::OutDirectory, clang::doc::ClangDocContext::ProjectName, serializeReference(), and clang::doc::Index::sort().

◆ serializeInfo() [1/16]

void clang::doc::serializeInfo	(	const ArrayRef< TemplateParamInfo > &	Params,
		Object &	Obj )

static

Definition at line 331 of file JSONGenerator.cpp.

◆ serializeInfo() [2/16]

void clang::doc::serializeInfo	(	const BaseRecordInfo &	I,
		Object &	Obj,
		const std::optional< StringRef > &	RepositoryUrl )

static

Definition at line 439 of file JSONGenerator.cpp.

References clang::doc::BaseRecordInfo::Access, clang::doc::BaseRecordInfo::IsParent, clang::doc::BaseRecordInfo::IsVirtual, RepositoryUrl(), and serializeInfo().

◆ serializeInfo() [3/16]

void clang::doc::serializeInfo	(	const ConceptInfo &	I,
		Object &	Obj,
		const std::optional< StringRef > &	RepositoryUrl )

static

Definition at line 365 of file JSONGenerator.cpp.

References clang::doc::ConceptInfo::ConstraintExpression, clang::doc::ConceptInfo::IsType, RepositoryUrl(), serializeCommonAttributes(), serializeInfo(), and clang::doc::ConceptInfo::Template.

◆ serializeInfo() [4/16]

void clang::doc::serializeInfo	(	const ConstraintInfo &	I,
		Object &	Obj )

static

Definition at line 326 of file JSONGenerator.cpp.

References clang::doc::ConstraintInfo::ConceptRef, clang::doc::ConstraintInfo::ConstraintExpr, and serializeReference().

Referenced by clang::doc::JSONGenerator::generateDocForInfo(), serializeCommonChildren(), serializeInfo(), serializeInfo(), serializeInfo(), serializeInfo(), serializeInfo(), serializeInfo(), serializeInfo(), serializeInfo(), and serializeInfo().

◆ serializeInfo() [5/16]

void clang::doc::serializeInfo	(	const EnumInfo &	I,
		json::Object &	Obj,
		const std::optional< StringRef > &	RepositoryUrl )

static

Definition at line 410 of file JSONGenerator.cpp.

References clang::doc::EnumInfo::BaseType, clang::doc::EnumInfo::Members, RepositoryUrl(), clang::doc::EnumInfo::Scoped, serializeArray(), serializeCommonAttributes(), and SerializeInfoLambda.

◆ serializeInfo() [6/16]

void clang::doc::serializeInfo	(	const EnumValueInfo &	I,
		Object &	Obj )

static

Definition at line 402 of file JSONGenerator.cpp.

References clang::doc::EnumValueInfo::Name, clang::doc::EnumValueInfo::Value, and clang::doc::EnumValueInfo::ValueExpr.

◆ serializeInfo() [7/16]

void clang::doc::serializeInfo	(	const FieldTypeInfo &	I,
		Object &	Obj )

static

Definition at line 381 of file JSONGenerator.cpp.

References clang::doc::FieldTypeInfo::Name, clang::doc::Reference::Name, and clang::doc::TypeInfo::Type.

◆ serializeInfo() [8/16]

void clang::doc::serializeInfo	(	const FriendInfo &	I,
		Object &	Obj )

static

Definition at line 447 of file JSONGenerator.cpp.

References clang::doc::FriendInfo::IsClass, clang::doc::FriendInfo::Params, clang::doc::FriendInfo::Ref, clang::doc::FriendInfo::ReturnType, serializeArray(), serializeInfo(), SerializeInfoLambda, serializeReference(), and clang::doc::FriendInfo::Template.

◆ serializeInfo() [9/16]

void clang::doc::serializeInfo	(	const FunctionInfo &	F,
		json::Object &	Obj,
		const std::optional< StringRef >	RepositoryURL )

static

Definition at line 386 of file JSONGenerator.cpp.

References clang::doc::SymbolInfo::IsStatic, clang::doc::FunctionInfo::Params, clang::doc::FunctionInfo::ReturnType, serializeArray(), serializeCommonAttributes(), serializeInfo(), SerializeInfoLambda, and clang::doc::FunctionInfo::Template.

◆ serializeInfo() [10/16]

void clang::doc::serializeInfo	(	const NamespaceInfo &	I,
		json::Object &	Obj,
		const std::optional< StringRef >	RepositoryUrl )

static

Definition at line 555 of file JSONGenerator.cpp.

References clang::doc::NamespaceInfo::Children, clang::doc::ScopeChildren::Concepts, clang::doc::ScopeChildren::Functions, clang::doc::ScopeChildren::Namespaces, RepositoryUrl(), serializeArray(), serializeCommonAttributes(), serializeCommonChildren(), serializeInfo(), SerializeReferenceLambda, and clang::doc::ScopeChildren::Variables.

◆ serializeInfo() [11/16]

void clang::doc::serializeInfo	(	const RecordInfo &	I,
		json::Object &	Obj,
		const std::optional< StringRef > &	RepositoryUrl )

static

◆ serializeInfo() [12/16]

void clang::doc::serializeInfo	(	const RecordInfo &	I,
		Object &	Obj,
		const std::optional< StringRef > &	RepositoryUrl )

static

References RepositoryUrl().

◆ serializeInfo() [13/16]

void clang::doc::serializeInfo	(	const TemplateInfo &	Template,
		Object &	Obj )

static

Definition at line 341 of file JSONGenerator.cpp.

References serializeArray(), serializeInfo(), and SerializeInfoLambda.

◆ serializeInfo() [14/16]

void clang::doc::serializeInfo	(	const TypedefInfo &	I,
		json::Object &	Obj,
		const std::optional< StringRef > &	RepositoryUrl )

static

Definition at line 428 of file JSONGenerator.cpp.

References clang::doc::TypedefInfo::IsUsing, RepositoryUrl(), serializeCommonAttributes(), serializeInfo(), clang::doc::TypedefInfo::TypeDeclaration, and clang::doc::TypedefInfo::Underlying.

◆ serializeInfo() [15/16]

void clang::doc::serializeInfo	(	const TypeInfo &	I,
		Object &	Obj )

static

Definition at line 373 of file JSONGenerator.cpp.

References clang::doc::TypeInfo::IsBuiltIn, clang::doc::TypeInfo::IsTemplate, clang::doc::Reference::Name, clang::doc::Reference::QualName, clang::doc::TypeInfo::Type, and clang::doc::Reference::USR.

◆ serializeInfo() [16/16]

void clang::doc::serializeInfo	(	const VarInfo &	I,
		json::Object &	Obj,
		const std::optional< StringRef >	RepositoryUrl )

static

Definition at line 546 of file JSONGenerator.cpp.

References clang::doc::SymbolInfo::IsStatic, RepositoryUrl(), serializeCommonAttributes(), serializeInfo(), and clang::doc::VarInfo::Type.

◆ serializeLocation()

json::Object clang::doc::serializeLocation	(	const Location &	Loc,
		const std::optional< StringRef >	RepositoryUrl )

static

Definition at line 71 of file JSONGenerator.cpp.

References clang::doc::Location::Filename, clang::doc::Location::IsFileInRootDir, RepositoryUrl(), and clang::doc::Location::StartLineNumber.

Referenced by serializeCommonAttributes().

◆ serializeReference() [1/2]

void clang::doc::serializeReference	(	const Reference &	Ref,
		Object &	ReferenceObj )

static

Definition at line 275 of file JSONGenerator.cpp.

References clang::doc::Reference::DocumentationFileName, clang::doc::Reference::Name, clang::doc::Reference::Path, clang::doc::Reference::QualName, and clang::doc::Reference::USR.

Referenced by serializeIndex(), serializeInfo(), and serializeInfo().

◆ serializeReference() [2/2]

void clang::doc::serializeReference	(	llvm::raw_fd_ostream &	OS,
		Index &	I,
		int	Level )

static

Definition at line 314 of file MDGenerator.cpp.

References writeNameLink().

◆ setupTemplate()

Error clang::doc::setupTemplate	(	std::unique_ptr< MustacheTemplateFile > &	Template,
		StringRef	TemplatePath,
		std::vector< std::pair< StringRef, StringRef > >	Partials )

static

Definition at line 83 of file HTMLMustacheGenerator.cpp.

References clang::doc::MustacheTemplateFile::createMustacheFile().

Referenced by setupTemplateFiles().

◆ setupTemplateFiles()

Error clang::doc::setupTemplateFiles ( const clang::doc::ClangDocContext & CDCtx )

static

Definition at line 96 of file HTMLMustacheGenerator.cpp.

References clang::doc::ClangDocContext::MustacheTemplates, NamespaceTemplate, RecordTemplate, and setupTemplate().

Referenced by clang::doc::MustacheHTMLGenerator::generateDocs().

◆ setupTemplateValue()

Error clang::doc::setupTemplateValue	(	const ClangDocContext &	CDCtx,
		json::Value &	V )

static

Definition at line 202 of file HTMLMustacheGenerator.cpp.

References clang::doc::ClangDocContext::JsScripts, clang::doc::ClangDocContext::ProjectName, and clang::doc::ClangDocContext::UserStylesheets.

Referenced by generateDocForJSON().

◆ stringToCommentKind()

CommentKind clang::doc::stringToCommentKind ( llvm::StringRef KindStr )

Definition at line 30 of file Representation.cpp.

References CK_BlockCommandComment, CK_FullComment, CK_HTMLEndTagComment, CK_HTMLStartTagComment, CK_InlineCommandComment, CK_ParagraphComment, CK_ParamCommandComment, CK_TextComment, CK_TParamCommandComment, CK_Unknown, CK_VerbatimBlockComment, CK_VerbatimBlockLineComment, and CK_VerbatimLineComment.

Referenced by clang::doc::serialize::ClangDocCommentVisitor::parseComment(), and parseRecord().

◆ writeDescription()

void clang::doc::writeDescription	(	const CommentInfo &	I,
		raw_ostream &	OS )

static

Definition at line 77 of file MDGenerator.cpp.

Referenced by genMarkdown(), genMarkdown(), genMarkdown(), genMarkdown(), and writeDescription().

◆ writeHeader()

void clang::doc::writeHeader	(	const Twine &	Text,
		unsigned int	Num,
		raw_ostream &	OS )

static

Definition at line 51 of file MDGenerator.cpp.

Referenced by genMarkdown(), genMarkdown(), and genMarkdown().

◆ writeLine()

void clang::doc::writeLine	(	const Twine &	Text,
		raw_ostream &	OS )

static

Definition at line 45 of file MDGenerator.cpp.

Referenced by genMarkdown(), genMarkdown(), genMarkdown(), and writeDescription().

◆ writeNameLink()

void clang::doc::writeNameLink	(	const StringRef &	CurrentPath,
		const Reference &	R,
		llvm::raw_ostream &	OS )

static

Definition at line 147 of file MDGenerator.cpp.

References clang::doc::Reference::getFileBaseName(), clang::doc::Reference::getRelativeFilePath(), and clang::doc::Reference::Name.

Referenced by genMarkdown(), and serializeReference().

◆ writeNewLine()

void clang::doc::writeNewLine ( raw_ostream & OS )

static

Definition at line 49 of file MDGenerator.cpp.

Referenced by genMarkdown(), genMarkdown(), and writeDescription().

◆ writeSourceFileRef() [1/2]

std::unique_ptr< TagNode > clang::doc::writeSourceFileRef	(	const ClangDocContext &	CDCtx,
		const Location &	L )

static

Definition at line 453 of file HTMLGenerator.cpp.

References clang::doc::Location::Filename, clang::doc::Location::IsFileInRootDir, clang::doc::ClangDocContext::RepositoryLinePrefix, clang::doc::ClangDocContext::RepositoryUrl, and clang::doc::Location::StartLineNumber.

Referenced by maybeWriteSourceFileRef(), and maybeWriteSourceFileRef().

◆ writeSourceFileRef() [2/2]

void clang::doc::writeSourceFileRef	(	const ClangDocContext &	CDCtx,
		const Location &	L,
		raw_ostream &	OS )

static

Definition at line 55 of file MDGenerator.cpp.

References clang::doc::Location::Filename, clang::doc::ClangDocContext::RepositoryLinePrefix, clang::doc::ClangDocContext::RepositoryUrl, and clang::doc::Location::StartLineNumber.

◆ YAML()

GeneratorRegistry::Add< YAMLGenerator > clang::doc::YAML	(	YAMLGenerator::Format	,
		"Generator for YAML output."	)

static

References clang::doc::YAMLGenerator::Format.

Variable Documentation

◆ BlockIdCount

unsigned clang::doc::BlockIdCount = BI_LAST - BI_FIRST

staticconstexpr

Definition at line 164 of file BitcodeWriter.h.

◆ BlockIdNameMap

const llvm::IndexedMap<llvm::StringRef, BlockIdToIndexFunctor> clang::doc::BlockIdNameMap

static

Definition at line 109 of file BitcodeWriter.cpp.

◆ EmptySID

const SymbolID clang::doc::EmptySID = SymbolID()

static

Definition at line 17 of file BitcodeWriter.cpp.

Referenced by clang::doc::ClangDocBitcodeWriter::emitBlock(), clang::doc::FunctionInfo::merge(), clang::doc::VarInfo::merge(), and clang::doc::Info::mergeBase().

◆ HTMLGeneratorAnchorDest

int LLVM_ATTRIBUTE_UNUSED clang::doc::HTMLGeneratorAnchorDest

static

Initial value:

=

HTMLGeneratorAnchorSource

clang::doc::HTMLGeneratorAnchorSource

volatile int HTMLGeneratorAnchorSource

Definition HTMLGenerator.cpp:1151

Definition at line 104 of file Generators.cpp.

◆ HTMLGeneratorAnchorSource

volatile int clang::doc::HTMLGeneratorAnchorSource = 0

Definition at line 1151 of file HTMLGenerator.cpp.

◆ JSONGeneratorAnchorDest

int LLVM_ATTRIBUTE_UNUSED clang::doc::JSONGeneratorAnchorDest

static

Initial value:

=

JSONGeneratorAnchorSource

clang::doc::JSONGeneratorAnchorSource

volatile int JSONGeneratorAnchorSource

Definition JSONGenerator.cpp:665

Definition at line 108 of file Generators.cpp.

◆ JSONGeneratorAnchorSource

volatile int clang::doc::JSONGeneratorAnchorSource = 0

Definition at line 665 of file JSONGenerator.cpp.

◆ MDGeneratorAnchorDest

int LLVM_ATTRIBUTE_UNUSED clang::doc::MDGeneratorAnchorDest

static

Initial value:

=

MDGeneratorAnchorSource

clang::doc::MDGeneratorAnchorSource

volatile int MDGeneratorAnchorSource

Definition MDGenerator.cpp:506

Definition at line 102 of file Generators.cpp.

◆ MDGeneratorAnchorSource

volatile int clang::doc::MDGeneratorAnchorSource = 0

Definition at line 506 of file MDGenerator.cpp.

◆ MHTMLGeneratorAnchorDest

int LLVM_ATTRIBUTE_UNUSED clang::doc::MHTMLGeneratorAnchorDest

static

Initial value:

=

MHTMLGeneratorAnchorSource

clang::doc::MHTMLGeneratorAnchorSource

volatile int MHTMLGeneratorAnchorSource

Definition HTMLMustacheGenerator.cpp:294

Definition at line 106 of file Generators.cpp.

◆ MHTMLGeneratorAnchorSource

volatile int clang::doc::MHTMLGeneratorAnchorSource = 0

Definition at line 294 of file HTMLMustacheGenerator.cpp.

◆ NamespaceTemplate

std::unique_ptr<MustacheTemplateFile> clang::doc::NamespaceTemplate = nullptr

static

Definition at line 78 of file HTMLMustacheGenerator.cpp.

Referenced by generateDocForJSON(), and setupTemplateFiles().

◆ RecordIdCount

unsigned clang::doc::RecordIdCount = RI_LAST - RI_FIRST

staticconstexpr

Definition at line 165 of file BitcodeWriter.h.

◆ RecordIdNameMap

const llvm::IndexedMap<RecordIdDsc, RecordIdToIndexFunctor> clang::doc::RecordIdNameMap

static

Definition at line 144 of file BitcodeWriter.cpp.

◆ RecordsByBlock

const std::vector<std::pair<BlockId, std::vector<RecordId> > > clang::doc::RecordsByBlock

static

Definition at line 243 of file BitcodeWriter.cpp.

◆ RecordTemplate

std::unique_ptr<MustacheTemplateFile> clang::doc::RecordTemplate = nullptr

static

Definition at line 80 of file HTMLMustacheGenerator.cpp.

Referenced by generateDocForJSON(), and setupTemplateFiles().

◆ SerializeInfoLambda

auto clang::doc::SerializeInfoLambda

static

Initial value:

= [](const auto &Info, Object &Object) {
  serializeInfo(Info, Object);
}

Definition at line 39 of file JSONGenerator.cpp.

Referenced by serializeInfo(), serializeInfo(), serializeInfo(), serializeInfo(), and serializeInfo().

◆ SerializeReferenceLambda

auto clang::doc::SerializeReferenceLambda

static

Initial value:

= [](const auto &Ref, Object &Object) {
  serializeReference(Ref, Object);
}

Definition at line 42 of file JSONGenerator.cpp.

Referenced by serializeCommonChildren(), serializeInfo(), and serializeInfo().

◆ USRVisited

llvm::StringSet clang::doc::USRVisited

static

Definition at line 21 of file Mapper.cpp.

◆ USRVisitedGuard

llvm::sys::SmartMutex<true> clang::doc::USRVisitedGuard

static

Definition at line 22 of file Mapper.cpp.

◆ VersionNumber

const unsigned clang::doc::VersionNumber = 3

static

Definition at line 33 of file BitcodeWriter.h.

Referenced by clang::doc::ClangDocBitcodeReader::readBitcode().

◆ YAMLGeneratorAnchorDest

int LLVM_ATTRIBUTE_UNUSED clang::doc::YAMLGeneratorAnchorDest

static

Initial value:

=

YAMLGeneratorAnchorSource

clang::doc::YAMLGeneratorAnchorSource

volatile int YAMLGeneratorAnchorSource

Definition YAMLGenerator.cpp:427

Definition at line 100 of file Generators.cpp.

◆ YAMLGeneratorAnchorSource

volatile int clang::doc::YAMLGeneratorAnchorSource = 0

Definition at line 427 of file YAMLGenerator.cpp.

Namespaces

Classes

Typedefs

Enumerations

Functions

Variables

Typedef Documentation

◆ AbbrevDsc

◆ GeneratorRegistry

◆ Record

◆ SymbolID

Enumeration Type Documentation

◆ BlockId

◆ CommentKind

◆ FieldId

◆ InfoType

◆ RecordId

Function Documentation

◆ addChild() [1/13]

◆ addChild() [2/13]

◆ addChild() [3/13]

◆ addChild() [4/13]

◆ addChild() [5/13]

◆ addChild() [6/13]

◆ addChild() [7/13]

◆ addChild() [8/13]

◆ addChild() [9/13]

◆ addChild() [10/13]

◆ addChild() [11/13]

◆ addChild() [12/13]

◆ addChild() [13/13]

◆ addConstraint() [1/2]

◆ addConstraint() [2/2]

◆ addReference() [1/12]

◆ addReference() [2/12]

◆ addReference() [3/12]

◆ addReference() [4/12]

◆ addReference() [5/12]

◆ addReference() [6/12]

◆ addReference() [7/12]

◆ addReference() [8/12]

◆ addReference() [9/12]

◆ addReference() [10/12]

◆ addReference() [11/12]

◆ addReference() [12/12]

◆ addTemplate() [1/5]

◆ addTemplate() [2/5]

◆ addTemplate() [3/5]

◆ addTemplate() [4/5]

◆ addTemplate() [5/5]

◆ addTemplateParam() [1/3]

◆ addTemplateParam() [2/3]

◆ addTemplateParam() [3/3]

◆ addTemplateSpecialization() [1/2]

◆ addTemplateSpecialization() [2/2]

◆ addTypeInfo() [1/10]

◆ addTypeInfo() [2/10]

◆ addTypeInfo() [3/10]

◆ addTypeInfo() [4/10]

◆ addTypeInfo() [5/10]

◆ addTypeInfo() [6/10]

◆ addTypeInfo() [7/10]

◆ addTypeInfo() [8/10]

◆ addTypeInfo() [9/10]

◆ addTypeInfo() [10/10]

◆ appendVector()

◆ calculateRelativeFilePath()

◆ commentKindToString()

◆ computeRelativePath()

◆ copyFile()

◆ createFileOpenError()

◆ decodeRecord() [1/10]

◆ decodeRecord() [2/10]

◆ decodeRecord() [3/10]

◆ decodeRecord() [4/10]

◆ decodeRecord() [5/10]

◆ decodeRecord() [6/10]

◆ decodeRecord() [7/10]

◆ decodeRecord() [8/10]

◆ decodeRecord() [9/10]