clang-tools 23.0.0git
Namespaces | Classes | Typedefs | Enumerations | Functions | Variables
clang::doc Namespace Reference

Namespaces

namespace  serialize

Classes

struct  BaseRecordInfo
class  BenchmarkVisitor
struct  BitCodeConstants
class  ClangDocBitcodeReader
class  ClangDocBitcodeWriter
struct  ClangDocContext
struct  CommentInfo
struct  ConceptInfo
class  ConcurrentStringPool
struct  ConstraintInfo
struct  Context
struct  EnumInfo
struct  EnumValueInfo
struct  FieldTypeInfo
struct  FriendInfo
struct  FunctionInfo
class  Generator
struct  has_children
struct  has_children< T, std::void_t< decltype(std::declval< T >().Children)> >
struct  has_description
struct  has_description< T, std::void_t< decltype(std::declval< T >().Description)> >
class  HTMLGenerator
struct  Index
struct  Info
 A base struct for Infos. More...
struct  InfoNode
struct  is_valid_child
struct  is_valid_child< TargetChild, std::void_t< decltype(getList(std::declval< ScopeChildren & >(), std::declval< TargetChild * >()))> >
class  JSONGenerator
struct  Location
class  MapASTVisitor
class  MapperActionFactory
class  MDGenerator
 Generator for Markdown documentation. More...
struct  MDMustacheGenerator
struct  MemberTypeInfo
struct  MustacheGenerator
class  MustacheTemplateFile
struct  NamespaceInfo
struct  RecordInfo
struct  Reference
struct  ScopeChildren
struct  SymbolInfo
class  TableCommentWriter
 Writer for writing comments to a table cell in MD. More...
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>
typedef llvm::Registry< Generator > GeneratorRegistry
typedef std::function< void(const Reference &, Object &)> ReferenceFunc
template<typename T>
using DocList = llvm::simple_ilist<InfoNode<T>>
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 , NAMESPACE_PARENT_USR , 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 , RECORD_PARENT_USR , 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 , CONCEPT_DEFLOCATION ,
  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
}
enum  OutputFormatTy {
  md , yaml , html , json ,
  md_mustache
}

Functions

static void BM_EmitInfoFunction (benchmark::State &State)
 BENCHMARK (BM_EmitInfoFunction)
static void BM_Mapper_Scale (benchmark::State &State)
 BENCHMARK (BM_Mapper_Scale) -> Range(10, 10000)
static void BM_SerializeFunctionInfo (benchmark::State &State)
 BENCHMARK (BM_SerializeFunctionInfo)
static void BM_MergeInfos_Scale (benchmark::State &State)
 BENCHMARK (BM_MergeInfos_Scale) -> Range(2, 10000)
static void BM_BitcodeReader_Scale (benchmark::State &State)
 BENCHMARK (BM_BitcodeReader_Scale) -> Range(10, 10000)
static void BM_JSONGenerator_Scale (benchmark::State &State)
 BENCHMARK (BM_JSONGenerator_Scale) -> Range(10, 10000)
static void BM_Index_Insertion (benchmark::State &State)
 BENCHMARK (BM_Index_Insertion) -> Range(10, 10000)
static llvm::ExitOnError ExitOnErr ("clang-doc error: ")
static llvm::Error decodeRecord (const Record &R, llvm::SmallVectorImpl< char > &Field, llvm::StringRef Blob)
static llvm::Error decodeRecord (const Record &R, llvm::StringRef &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, DocList< 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, llvm::SmallVectorImpl< StringRef > &AttrKeys, llvm::SmallVectorImpl< StringRef > &AttrValues, llvm::SmallVectorImpl< StringRef > &Args)
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)
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<typename T, typename TTypeInfo>
static llvm::Error addTypeInfo (T I, TTypeInfo &&TI)
template<>
llvm::Error addTypeInfo (FunctionInfo *I, TypeInfo &&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<>
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)
static auto & getList (ScopeChildren &C, FunctionInfo *)
static auto & getList (ScopeChildren &C, EnumInfo *)
static auto & getList (ScopeChildren &C, TypedefInfo *)
static auto & getList (ScopeChildren &C, ConceptInfo *)
static auto & getList (ScopeChildren &C, VarInfo *)
template<typename Target, typename Child>
static void addChild (Target I, Child &&R)
template<typename Target, typename Child>
static void addChildPtr (Target I, Child *Node)
template<typename T>
static void addTemplateParam (T 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<>
void addTemplate (TypedefInfo *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)
std::unique_ptr< tooling::FrontendActionFactory > newMapperActionFactory (ClangDocContext CDCtx)
llvm::Expected< std::unique_ptr< Generator > > findGeneratorByName (llvm::StringRef Format)
llvm::StringRef getTagType (TagTypeKind AS)
Error createFileOpenError (StringRef FileName, std::error_code EC)
static GeneratorRegistry::Add< HTMLGenerator > HTML (HTMLGenerator::Format, "Generator for mustache HTML output.")
template<typename Container, typename SerializationFunc>
static void serializeArray (const Container &Records, Object &Obj, const StringRef Key, SerializationFunc SerializeInfo, const StringRef EndKey="End", function_ref< void(Object &)> UpdateJson=[](Object &Obj) {})
static constexpr unsigned getMaxParamWrapLimit ()
static void insertNonEmpty (StringRef Key, StringRef Value, Object &Obj)
static std::string infoTypeToString (InfoType IT)
static void insertComment (Object &Description, json::Value &Comment, StringRef Key)
 Insert comments into a key in the Description object.
static json::Value extractTextComments (Object *ParagraphComment)
 Takes the nested "Children" array from a comment Object.
static json::Value extractVerbatimComments (json::Array VerbatimLines)
static Object serializeComment (const CommentInfo &I, Object &Description)
static void serializeDescription (const DocList< CommentInfo > &Description, json::Object &Obj, StringRef Key="")
static void serializeTemplateSpecialization (TemplateInfo Template, Object &TemplateObj)
static void insertArray (Object &Obj, json::Value &Array, StringRef Key)
static std::vector< Index > preprocessCDCtxIndex (Index CDCtxIndex)
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 (llvm::ArrayRef< 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, const 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.")
static GeneratorRegistry::Add< MDMustacheGenerator > MDMustache (MDMustacheGenerator::Format, "Generator for mustache Markdown output.")
ConcurrentStringPool & getGlobalStringPool ()
CommentKind stringToCommentKind (llvm::StringRef KindStr)
llvm::StringRef commentKindToString (CommentKind Kind)
template<typename T>
static llvm::Expected< Info * > reduce (SmallVectorImpl< Info * > &Values)
template<typename T>
static void reduceChildren (DocList< T > &Children, DocList< T > &&ChildrenToMerge)
template<>
void reduceChildren< Reference > (DocList< Reference > &Children, DocList< Reference > &&ChildrenToMerge)
template<typename T>
static void mergeUnkeyed (DocList< T > &Target, DocList< T > &&Source)
template<>
void mergeUnkeyed< CommentInfo > (DocList< CommentInfo > &Target, DocList< CommentInfo > &&Source)
llvm::Error mergeSingleInfo (doc::Info *&Reduced, doc::Info *NewInfo, llvm::BumpPtrAllocator &Arena)
llvm::Expected< Info * > mergeInfos (SmallVectorImpl< Info * > &Values)
static llvm::SmallString< 64 > calculateRelativeFilePath (const InfoType &Type, const StringRef &Path, const StringRef &Name, const StringRef &CurrentPath)
StringRef internString (const Twine &T)
template<typename T>
llvm::ArrayRef< T > allocateArray (llvm::SmallVectorImpl< T > &V, llvm::BumpPtrAllocator &Alloc)
template<typename T>
llvm::ArrayRef< T > allocateArray (llvm::ArrayRef< T > V, llvm::BumpPtrAllocator &Alloc)
template<typename T>
llvm::ArrayRef< T > deepCopyArray (llvm::ArrayRef< T > V, llvm::BumpPtrAllocator &Alloc)
template<typename T, typename... Args>
T * allocateTransient (Args &&...args)
template<typename T, typename... Args>
T * allocatePersistent (Args &&...args)
template<typename T, typename... Args>
T * allocatePtr (llvm::BumpPtrAllocator &Alloc, Args &&...args)
template<typename T, typename... Args>
InfoNode< T > * allocateListNode (llvm::BumpPtrAllocator &Alloc, Args &&...args)
template<typename T, typename... Args>
InfoNode< T > * allocateListNodeTransient (Args &&...args)
template<typename T>
InfoNode< T > * allocateListNode (llvm::BumpPtrAllocator &Alloc, T *Item)
template<typename T>
InfoNode< T > * allocateListNodeTransient (T *Item)
template<typename T, typename... Args>
InfoNode< T > * allocateListNodePersistent (Args &&...args)
template<typename T>
InfoNode< T > * allocateListNodePersistent (T *Item)
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 unsigned VersionNumber = 3
static constexpr unsigned BlockIdCount = BI_LAST - BI_FIRST
static constexpr unsigned RecordIdCount = RI_LAST - RI_FIRST
static int YAMLGeneratorAnchorDest = YAMLGeneratorAnchorSource
static int MDGeneratorAnchorDest = MDGeneratorAnchorSource
static int HTMLGeneratorAnchorDest = HTMLGeneratorAnchorSource
static int JSONGeneratorAnchorDest = JSONGeneratorAnchorSource
static int MDMustacheGeneratorAnchorDest
volatile int YAMLGeneratorAnchorSource = 0
volatile int MDGeneratorAnchorSource = 0
volatile int HTMLGeneratorAnchorSource = 0
volatile int JSONGeneratorAnchorSource = 0
volatile int MDMustacheGeneratorAnchorSource = 0
static std::unique_ptr< MustacheTemplateFile > NamespaceTemplate = nullptr
static std::unique_ptr< MustacheTemplateFile > RecordTemplate = nullptr
static std::unique_ptr< MustacheTemplateFile > IndexTemplate = nullptr
static auto SerializeTemplateParam
static llvm::StringSet USRVisited
static llvm::sys::SmartMutex< true > USRVisitedGuard
static std::unique_ptr< MustacheTemplateFile > RecordTemplate = nullptr
static std::unique_ptr< MustacheTemplateFile > NamespaceTemplate = nullptr
static std::unique_ptr< MustacheTemplateFile > AllFilesTemplate = nullptr
static std::unique_ptr< MustacheTemplateFile > IndexTemplate = nullptr
thread_local llvm::BumpPtrAllocator TransientArena
thread_local llvm::BumpPtrAllocator PersistentArena
const SymbolID EmptySID = SymbolID()
constexpr SymbolID GlobalNamespaceID

Typedef Documentation

◆ DocList

template<typename T>
using clang::doc::DocList = llvm::simple_ilist<InfoNode<T>>

Definition at line 182 of file Representation.h.

◆ GeneratorRegistry

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

Definition at line 50 of file Generators.h.

◆ Record

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

Definition at line 22 of file BitcodeReader.cpp.

◆ ReferenceFunc

typedef std::function<void(const Reference &, Object &)> clang::doc::ReferenceFunc

Definition at line 38 of file JSONGenerator.cpp.

◆ SymbolID

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

Definition at line 185 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 49 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 210 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 167 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 198 of file Representation.h.

◆ OutputFormatTy

enum clang::doc::OutputFormatTy
Enumerator
md 
yaml 
html 
json 
md_mustache 

Definition at line 226 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 
NAMESPACE_PARENT_USR 
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 
RECORD_PARENT_USR 
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 
CONCEPT_DEFLOCATION 
CONSTRAINT_EXPRESSION 
VAR_USR 
VAR_NAME 
VAR_DEFLOCATION 
VAR_IS_STATIC 
FRIEND_IS_CLASS 
RI_LAST 
RI_FIRST 

Definition at line 76 of file BitcodeWriter.h.

Function Documentation

◆ addChild()

template<typename Target, typename Child>
void clang::doc::addChild ( Target I,
Child && R )
static

Definition at line 1096 of file BitcodeReader.cpp.

References allocateListNodeTransient(), ExitOnErr, and getList().

◆ addChildPtr()

template<typename Target, typename Child>
void clang::doc::addChildPtr ( Target I,
Child * Node )
static

Definition at line 1114 of file BitcodeReader.cpp.

References allocateListNodeTransient(), ExitOnErr, and getList().

◆ addConstraint()

template<typename T>
void clang::doc::addConstraint ( T I,
ConstraintInfo && C )
static

Definition at line 1170 of file BitcodeReader.cpp.

References ExitOnErr.

◆ addReference() [1/23]

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

Definition at line 1056 of file BitcodeReader.cpp.

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

◆ addReference() [2/23]

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

Definition at line 1056 of file BitcodeReader.cpp.

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

◆ addReference() [3/23]

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

Definition at line 1004 of file BitcodeReader.cpp.

◆ addReference() [4/23]

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

Definition at line 1004 of file BitcodeReader.cpp.

◆ addReference() [5/23]

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

Definition at line 981 of file BitcodeReader.cpp.

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

◆ addReference() [6/23]

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

Definition at line 981 of file BitcodeReader.cpp.

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

◆ addReference() [7/23]

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

Definition at line 1067 of file BitcodeReader.cpp.

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

◆ addReference() [8/23]

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

Definition at line 1067 of file BitcodeReader.cpp.

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

◆ addReference() [9/23]

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

Definition at line 1032 of file BitcodeReader.cpp.

References F_parent, and clang::doc::FunctionInfo::Parent.

◆ addReference() [10/23]

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

Definition at line 1032 of file BitcodeReader.cpp.

References F_parent, and clang::doc::FunctionInfo::Parent.

◆ addReference() [11/23]

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

Definition at line 993 of file BitcodeReader.cpp.

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

◆ addReference() [12/23]

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

Definition at line 993 of file BitcodeReader.cpp.

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

◆ addReference() [13/23]

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

Definition at line 1015 of file BitcodeReader.cpp.

References allocateListNodeTransient(), clang::doc::NamespaceInfo::Children, F_child_namespace, F_child_record, clang::doc::ScopeChildren::Namespaces, and clang::doc::ScopeChildren::Records.

◆ addReference() [14/23]

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

Definition at line 1015 of file BitcodeReader.cpp.

References allocateListNodeTransient(), clang::doc::NamespaceInfo::Children, F_child_namespace, F_child_record, clang::doc::ScopeChildren::Namespaces, and clang::doc::ScopeChildren::Records.

◆ addReference() [15/23]

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

Definition at line 1043 of file BitcodeReader.cpp.

References allocateListNodeTransient(), clang::doc::RecordInfo::Children, F_child_record, and clang::doc::ScopeChildren::Records.

◆ addReference() [16/23]

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

Definition at line 1043 of file BitcodeReader.cpp.

References allocateListNodeTransient(), clang::doc::RecordInfo::Children, F_child_record, and clang::doc::ScopeChildren::Records.

◆ addReference() [17/23]

template<typename T>
llvm::Error clang::doc::addReference ( T I,
Reference && R,
FieldId F )
static

Definition at line 959 of file BitcodeReader.cpp.

◆ addReference() [18/23]

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

Definition at line 1009 of file BitcodeReader.cpp.

◆ addReference() [19/23]

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

Definition at line 1009 of file BitcodeReader.cpp.

◆ addReference() [20/23]

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

Definition at line 969 of file BitcodeReader.cpp.

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

◆ addReference() [21/23]

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

Definition at line 969 of file BitcodeReader.cpp.

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

◆ addReference() [22/23]

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

Definition at line 964 of file BitcodeReader.cpp.

◆ addReference() [23/23]

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

Definition at line 964 of file BitcodeReader.cpp.

◆ addTemplate() [1/6]

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

Definition at line 1147 of file BitcodeReader.cpp.

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

◆ addTemplate() [2/6]

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

Definition at line 1150 of file BitcodeReader.cpp.

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

◆ addTemplate() [3/6]

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

Definition at line 1144 of file BitcodeReader.cpp.

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

◆ addTemplate() [4/6]

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

Definition at line 1141 of file BitcodeReader.cpp.

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

◆ addTemplate() [5/6]

template<typename T>
void clang::doc::addTemplate ( T I,
TemplateInfo && P )
static

Definition at line 1137 of file BitcodeReader.cpp.

References ExitOnErr.

◆ addTemplate() [6/6]

template<>
void clang::doc::addTemplate ( TypedefInfo * I,
TemplateInfo && P )

Definition at line 1153 of file BitcodeReader.cpp.

References clang::doc::TypedefInfo::Template.

◆ addTemplateParam()

template<typename T>
void clang::doc::addTemplateParam ( T I,
TemplateParamInfo && P )
static

Definition at line 1130 of file BitcodeReader.cpp.

References ExitOnErr.

◆ addTemplateSpecialization() [1/2]

template<typename T>
void clang::doc::addTemplateSpecialization ( T I,
TemplateSpecializationInfo && TSI )
static

Definition at line 1159 of file BitcodeReader.cpp.

References ExitOnErr.

◆ addTemplateSpecialization() [2/2]

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

Definition at line 1165 of file BitcodeReader.cpp.

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

◆ addTypeInfo() [1/6]

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

Definition at line 943 of file BitcodeReader.cpp.

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

◆ addTypeInfo() [2/6]

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

Definition at line 938 of file BitcodeReader.cpp.

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

◆ addTypeInfo() [3/6]

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

Definition at line 933 of file BitcodeReader.cpp.

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

◆ addTypeInfo() [4/6]

template<typename T, typename TTypeInfo>
llvm::Error clang::doc::addTypeInfo ( T I,
TTypeInfo && TI )
static

Definition at line 928 of file BitcodeReader.cpp.

◆ addTypeInfo() [5/6]

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

Definition at line 948 of file BitcodeReader.cpp.

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

◆ addTypeInfo() [6/6]

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

Definition at line 953 of file BitcodeReader.cpp.

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

◆ allocateArray() [1/2]

template<typename T>
llvm::ArrayRef< T > clang::doc::allocateArray ( llvm::ArrayRef< T > V,
llvm::BumpPtrAllocator & Alloc )

Definition at line 86 of file Representation.h.

◆ allocateArray() [2/2]

template<typename T>
llvm::ArrayRef< T > clang::doc::allocateArray ( llvm::SmallVectorImpl< T > & V,
llvm::BumpPtrAllocator & Alloc )

Definition at line 76 of file Representation.h.

Referenced by clang::doc::CommentInfo::CommentInfo(), clang::doc::serialize::Serializer::emitInfo(), clang::doc::serialize::Serializer::emitInfo(), clang::doc::FriendInfo::FriendInfo(), clang::doc::Info::Info(), clang::doc::ConceptInfo::merge(), clang::doc::FunctionInfo::merge(), clang::doc::RecordInfo::merge(), clang::doc::Info::mergeBase(), clang::doc::ClangDocBitcodeReader::readBlock(), clang::doc::ClangDocBitcodeReader::readBlock(), clang::doc::ClangDocBitcodeReader::readBlock(), clang::doc::ClangDocBitcodeReader::readBlock(), clang::doc::ClangDocBitcodeReader::readBlock(), clang::doc::ClangDocBitcodeReader::readBlock(), clang::doc::ClangDocBitcodeReader::readBlock(), clang::doc::ClangDocBitcodeReader::readBlock(), clang::doc::RecordInfo::RecordInfo(), clang::doc::TemplateInfo::TemplateInfo(), clang::doc::TemplateSpecializationInfo::TemplateSpecializationInfo(), clang::doc::serialize::ClangDocCommentVisitor::visitBlockCommandComment(), clang::doc::serialize::ClangDocCommentVisitor::visitHTMLStartTagComment(), and clang::doc::serialize::ClangDocCommentVisitor::visitInlineCommandComment().

◆ allocateListNode() [1/2]

template<typename T, typename... Args>
InfoNode< T > * clang::doc::allocateListNode ( llvm::BumpPtrAllocator & Alloc,
Args &&... args )

Definition at line 152 of file Representation.h.

References allocatePtr().

Referenced by allocateListNodePersistent(), allocateListNodePersistent(), allocateListNodeTransient(), allocateListNodeTransient(), and clang::doc::Info::Info().

◆ allocateListNode() [2/2]

template<typename T>
InfoNode< T > * clang::doc::allocateListNode ( llvm::BumpPtrAllocator & Alloc,
T * Item )

Definition at line 163 of file Representation.h.

References allocatePtr().

◆ allocateListNodePersistent() [1/2]

template<typename T, typename... Args>
InfoNode< T > * clang::doc::allocateListNodePersistent ( Args &&... args)

Definition at line 172 of file Representation.h.

References allocateListNode(), and PersistentArena.

Referenced by mergeUnkeyed(), mergeUnkeyed< CommentInfo >(), reduceChildren(), and reduceChildren< Reference >().

◆ allocateListNodePersistent() [2/2]

template<typename T>
InfoNode< T > * clang::doc::allocateListNodePersistent ( T * Item)

Definition at line 176 of file Representation.h.

References allocateListNode(), and PersistentArena.

◆ allocateListNodeTransient() [1/2]

template<typename T, typename... Args>
InfoNode< T > * clang::doc::allocateListNodeTransient ( Args &&... args)

Definition at line 158 of file Representation.h.

References allocateListNode(), and TransientArena.

Referenced by addChild(), addChildPtr(), addReference(), addReference(), BM_JSONGenerator_Scale(), decodeRecord(), and getCommentInfo().

◆ allocateListNodeTransient() [2/2]

template<typename T>
InfoNode< T > * clang::doc::allocateListNodeTransient ( T * Item)

Definition at line 167 of file Representation.h.

References allocateListNode(), and TransientArena.

◆ allocatePersistent()

template<typename T, typename... Args>
T * clang::doc::allocatePersistent ( Args &&... args)

Definition at line 114 of file Representation.h.

References PersistentArena.

◆ allocatePtr()

template<typename T, typename... Args>
T * clang::doc::allocatePtr ( llvm::BumpPtrAllocator & Alloc,
Args &&... args )

Definition at line 120 of file Representation.h.

Referenced by allocateListNode(), allocateListNode(), clang::doc::Info::Info(), and mergeSingleInfo().

◆ allocateTransient()

template<typename T, typename... Args>
T * clang::doc::allocateTransient ( Args &&... args)

Definition at line 109 of file Representation.h.

References TransientArena.

Referenced by BM_JSONGenerator_Scale(), BM_MergeInfos_Scale(), BM_SerializeFunctionInfo(), clang::doc::serialize::Serializer::emitInfo(), clang::doc::serialize::Serializer::emitInfo(), clang::doc::serialize::Serializer::emitInfo(), clang::doc::serialize::Serializer::emitInfo(), clang::doc::serialize::Serializer::emitInfo(), clang::doc::serialize::Serializer::emitInfo(), clang::doc::serialize::Serializer::emitInfo(), clang::doc::serialize::Serializer::emitInfo(), clang::doc::serialize::Serializer::emitInfo(), and reduce().

◆ BENCHMARK() [1/7]

clang::doc::BENCHMARK ( BM_BitcodeReader_Scale ) -> Range(10, 10000)

References BM_BitcodeReader_Scale().

◆ BENCHMARK() [2/7]

clang::doc::BENCHMARK ( BM_EmitInfoFunction )

References BM_EmitInfoFunction().

◆ BENCHMARK() [3/7]

clang::doc::BENCHMARK ( BM_Index_Insertion ) -> Range(10, 10000)

References BM_Index_Insertion().

◆ BENCHMARK() [4/7]

clang::doc::BENCHMARK ( BM_JSONGenerator_Scale ) -> Range(10, 10000)

References BM_JSONGenerator_Scale().

◆ BENCHMARK() [5/7]

clang::doc::BENCHMARK ( BM_Mapper_Scale ) -> Range(10, 10000)

References BM_Mapper_Scale().

◆ BENCHMARK() [6/7]

clang::doc::BENCHMARK ( BM_MergeInfos_Scale ) -> Range(2, 10000)

References BM_MergeInfos_Scale().

◆ BENCHMARK() [7/7]

clang::doc::BENCHMARK ( BM_SerializeFunctionInfo )

References BM_SerializeFunctionInfo().

◆ BM_BitcodeReader_Scale()

void clang::doc::BM_BitcodeReader_Scale ( benchmark::State & State)
static

Definition at line 141 of file ClangDocBenchmark.cpp.

References clang::doc::ClangDocBitcodeWriter::emitBlock(), internString(), clang::doc::Info::Name, clang::doc::ClangDocBitcodeReader::readBitcode(), and clang::doc::Info::USR.

Referenced by BENCHMARK().

◆ BM_EmitInfoFunction()

void clang::doc::BM_EmitInfoFunction ( benchmark::State & State)
static

Definition at line 51 of file ClangDocBenchmark.cpp.

References clang::doc::serialize::Serializer::emitInfo().

Referenced by BENCHMARK().

◆ BM_Index_Insertion()

void clang::doc::BM_Index_Insertion ( benchmark::State & State)
static

Definition at line 215 of file ClangDocBenchmark.cpp.

References clang::doc::Generator::addInfoToIndex(), internString(), clang::doc::Info::Name, clang::doc::Info::Path, and clang::doc::Info::USR.

Referenced by BENCHMARK().

◆ BM_JSONGenerator_Scale()

void clang::doc::BM_JSONGenerator_Scale ( benchmark::State & State)
static

Definition at line 176 of file ClangDocBenchmark.cpp.

References allocateListNodeTransient(), allocateTransient(), findGeneratorByName(), IT_record, and json.

Referenced by BENCHMARK().

◆ BM_Mapper_Scale()

void clang::doc::BM_Mapper_Scale ( benchmark::State & State)
static

Definition at line 70 of file ClangDocBenchmark.cpp.

References json, and newMapperActionFactory().

Referenced by BENCHMARK().

◆ BM_MergeInfos_Scale()

void clang::doc::BM_MergeInfos_Scale ( benchmark::State & State)
static

Definition at line 114 of file ClangDocBenchmark.cpp.

References allocateTransient(), and mergeInfos().

Referenced by BENCHMARK().

◆ BM_SerializeFunctionInfo()

void clang::doc::BM_SerializeFunctionInfo ( benchmark::State & State)
static

Definition at line 94 of file ClangDocBenchmark.cpp.

References allocateTransient(), IT_function, and clang::doc::serialize::serialize().

Referenced by BENCHMARK().

◆ calculateRelativeFilePath()

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

Definition at line 356 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 63 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 37 of file File.cpp.

Referenced by clang::doc::MustacheGenerator::getRelativePathToRoot().

◆ copyFile()

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

Definition at line 21 of file File.cpp.

References OutDirectory().

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

◆ createFileOpenError()

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

Definition at line 51 of file Generators.cpp.

Referenced by clang::doc::MustacheTemplateFile::createMustacheFile(), clang::doc::MustacheGenerator::generateDocumentation(), 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 66 of file BitcodeReader.cpp.

◆ decodeRecord() [2/10]

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

Definition at line 57 of file BitcodeReader.cpp.

◆ decodeRecord() [3/10]

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

Definition at line 157 of file BitcodeReader.cpp.

References allocateListNodeTransient().

◆ decodeRecord() [4/10]

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

Definition at line 135 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() [5/10]

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

Definition at line 113 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() [6/10]

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

Definition at line 25 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() [7/10]

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

Definition at line 32 of file BitcodeReader.cpp.

References internString().

◆ decodeRecord() [8/10]

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

Definition at line 100 of file BitcodeReader.cpp.

◆ decodeRecord() [9/10]

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

Definition at line 38 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 82 of file BitcodeReader.cpp.

◆ deepCopyArray()

template<typename T>
llvm::ArrayRef< T > clang::doc::deepCopyArray ( llvm::ArrayRef< T > V,
llvm::BumpPtrAllocator & Alloc )

Definition at line 96 of file Representation.h.

Referenced by clang::doc::EnumInfo::merge(), clang::doc::RecordInfo::merge(), and clang::doc::RecordInfo::RecordInfo().

◆ ExitOnErr()

llvm::ExitOnError clang::doc::ExitOnErr ( "clang-doc error: " )
static

◆ extractTextComments()

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

Takes the nested "Children" array from a comment Object.

Returns
a json::Array of comments, possible json::Value::Kind::Null

Definition at line 187 of file JSONGenerator.cpp.

Referenced by serializeComment(), and serializeDescription().

◆ extractVerbatimComments()

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

Definition at line 208 of file JSONGenerator.cpp.

Referenced by serializeComment().

◆ findGeneratorByName()

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

Definition at line 23 of file Generators.cpp.

Referenced by BM_JSONGenerator_Scale(), and clang::doc::MustacheGenerator::generateDocumentation().

◆ genEmphasis()

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

Definition at line 30 of file MDGenerator.cpp.

Referenced by writeDescription().

◆ genIndex()

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

Definition at line 445 of file MDGenerator.cpp.

References clang::doc::Index::getSortedChildren(), 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().

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

◆ genItalic()

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

Definition at line 26 of file MDGenerator.cpp.

Referenced by genMarkdown().

◆ genMarkdown() [1/5]

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

Definition at line 231 of file MDGenerator.cpp.

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

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 277 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 302 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

Definition at line 352 of file MDGenerator.cpp.

References clang::doc::RecordInfo::Children, clang::doc::SymbolInfo::DefLoc, clang::doc::Info::Description, clang::doc::ScopeChildren::Enums, clang::doc::ScopeChildren::Functions, genMarkdown(), genReferenceList(), getTagType(), maybeWriteSourceFileRef(), clang::doc::RecordInfo::Members, clang::doc::Info::Name, clang::doc::RecordInfo::Parents, clang::doc::ScopeChildren::Records, clang::doc::RecordInfo::TagType, clang::doc::RecordInfo::VirtualParents, writeDescription(), writeHeader(), writeLine(), and writeNewLine().

◆ genMarkdown() [5/5]

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

Definition at line 408 of file MDGenerator.cpp.

◆ genReferenceList()

std::string clang::doc::genReferenceList ( llvm::ArrayRef< Reference > Refs)
static

Definition at line 34 of file MDGenerator.cpp.

Referenced by genMarkdown().

◆ getCommentInfo()

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

Definition at line 911 of file BitcodeReader.cpp.

References allocateListNodeTransient().

◆ getGlobalStringPool()

ConcurrentStringPool & clang::doc::getGlobalStringPool ( )

Definition at line 35 of file Representation.cpp.

Referenced by internString().

◆ getList() [1/5]

auto & clang::doc::getList ( ScopeChildren & C,
ConceptInfo *  )
static

Definition at line 1079 of file BitcodeReader.cpp.

◆ getList() [2/5]

auto & clang::doc::getList ( ScopeChildren & C,
EnumInfo *  )
static

Definition at line 1077 of file BitcodeReader.cpp.

◆ getList() [3/5]

auto & clang::doc::getList ( ScopeChildren & C,
FunctionInfo *  )
static

Definition at line 1076 of file BitcodeReader.cpp.

Referenced by addChild(), and addChildPtr().

◆ getList() [4/5]

auto & clang::doc::getList ( ScopeChildren & C,
TypedefInfo *  )
static

Definition at line 1078 of file BitcodeReader.cpp.

◆ getList() [5/5]

auto & clang::doc::getList ( ScopeChildren & C,
VarInfo *  )
static

Definition at line 1080 of file BitcodeReader.cpp.

◆ getMaxParamWrapLimit()

constexpr unsigned clang::doc::getMaxParamWrapLimit ( )
staticconstexpr

Definition at line 36 of file JSONGenerator.cpp.

Referenced by serializeTemplateSpecialization().

◆ getTagType()

llvm::StringRef clang::doc::getTagType ( TagTypeKind AS)

Definition at line 35 of file Generators.cpp.

Referenced by genMarkdown().

◆ HTML()

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

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

◆ infoTypeToString()

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

Definition at line 109 of file JSONGenerator.cpp.

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

◆ insertArray()

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

Definition at line 720 of file JSONGenerator.cpp.

◆ insertComment()

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

Insert comments into a key in the Description object.

Parameters
CommentEither an Object or Array, depending on the comment type
KeyThe type (Brief, Code, etc.) of comment to be inserted

Definition at line 158 of file JSONGenerator.cpp.

Referenced by serializeComment(), and serializeDescription().

◆ insertNonEmpty()

void clang::doc::insertNonEmpty ( StringRef Key,
StringRef Value,
Object & Obj )
static

Definition at line 104 of file JSONGenerator.cpp.

◆ internString()

StringRef clang::doc::internString ( const Twine & T)
inline

Definition at line 57 of file Representation.h.

References getGlobalStringPool(), and clang::doc::ConcurrentStringPool::intern().

Referenced by BM_BitcodeReader_Scale(), BM_Index_Insertion(), decodeRecord(), clang::doc::serialize::Serializer::emitInfo(), clang::doc::EnumValueInfo::EnumValueInfo(), clang::doc::serialize::exprToString(), clang::doc::Info::extractName(), clang::doc::FieldTypeInfo::FieldTypeInfo(), clang::doc::JSONGenerator::generateDocumentation(), clang::doc::Info::getRelativeFilePath(), clang::doc::Reference::getRelativeFilePath(), clang::doc::Info::Info(), clang::doc::Location::Location(), parseRecord(), preprocessCDCtxIndex(), clang::doc::Reference::Reference(), clang::doc::Reference::Reference(), clang::doc::Reference::Reference(), clang::doc::TemplateParamInfo::TemplateParamInfo(), clang::doc::serialize::ClangDocCommentVisitor::visitBlockCommandComment(), clang::doc::serialize::ClangDocCommentVisitor::visitHTMLEndTagComment(), clang::doc::serialize::ClangDocCommentVisitor::visitHTMLStartTagComment(), clang::doc::serialize::ClangDocCommentVisitor::visitInlineCommandComment(), clang::doc::serialize::ClangDocCommentVisitor::visitParamCommandComment(), clang::doc::serialize::ClangDocCommentVisitor::visitTParamCommandComment(), clang::doc::serialize::ClangDocCommentVisitor::visitVerbatimBlockComment(), clang::doc::serialize::ClangDocCommentVisitor::visitVerbatimBlockLineComment(), and clang::doc::serialize::ClangDocCommentVisitor::visitVerbatimLineComment().

◆ 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 clang::doc::HTMLGenerator::generateDocForJSON(), clang::doc::MDMustacheGenerator::generateDocForJSON(), and clang::doc::MustacheGenerator::generateDocForJSON().

◆ maybeWriteSourceFileRef()

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

Definition at line 144 of file MDGenerator.cpp.

References writeSourceFileRef().

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

◆ MD()

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

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

◆ MDMustache()

GeneratorRegistry::Add< MDMustacheGenerator > clang::doc::MDMustache ( MDMustacheGenerator::Format ,
"Generator for mustache Markdown output."  )
static

References clang::doc::MDMustacheGenerator::Format.

◆ mergeInfos()

llvm::Expected< Info * > clang::doc::mergeInfos ( SmallVectorImpl< Info * > & Values)

Definition at line 256 of file Representation.cpp.

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

Referenced by BM_MergeInfos_Scale().

◆ mergeSingleInfo()

llvm::Error clang::doc::mergeSingleInfo ( doc::Info *& Reduced,
doc::Info * NewInfo,
llvm::BumpPtrAllocator & Arena )

Definition at line 176 of file Representation.cpp.

References allocatePtr(), clang::doc::Info::IT, IT_concept, IT_enum, IT_friend, IT_function, IT_namespace, IT_record, IT_typedef, IT_variable, and clang::doc::Info::USR.

◆ mergeUnkeyed()

template<typename T>
void clang::doc::mergeUnkeyed ( DocList< T > & Target,
DocList< T > && Source )
static

Definition at line 149 of file Representation.cpp.

References allocateListNodePersistent().

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

◆ mergeUnkeyed< CommentInfo >()

template<>
void clang::doc::mergeUnkeyed< CommentInfo > ( DocList< CommentInfo > & Target,
DocList< CommentInfo > && Source )

Definition at line 162 of file Representation.cpp.

References allocateListNodePersistent(), and PersistentArena.

◆ newMapperActionFactory()

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

Definition at line 52 of file ClangDoc.cpp.

Referenced by BM_Mapper_Scale().

◆ parseRecord() [1/20]

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

Definition at line 224 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,
llvm::SmallVectorImpl< StringRef > & AttrKeys,
llvm::SmallVectorImpl< StringRef > & AttrValues,
llvm::SmallVectorImpl< StringRef > & Args )
static

Definition at line 370 of file BitcodeReader.cpp.

References clang::doc::CommentInfo::CloseName, COMMENT_ARG, COMMENT_ATTRKEY, COMMENT_ATTRVAL, COMMENT_CLOSENAME, COMMENT_DIRECTION, COMMENT_EXPLICIT, COMMENT_KIND, COMMENT_NAME, COMMENT_PARAMNAME, COMMENT_SELFCLOSING, COMMENT_TEXT, decodeRecord(), clang::doc::CommentInfo::Direction, clang::doc::CommentInfo::Explicit, internString(), clang::doc::CommentInfo::Kind, clang::doc::CommentInfo::Name, clang::doc::CommentInfo::ParamName, clang::doc::CommentInfo::SelfClosing, stringToCommentKind(), and clang::doc::CommentInfo::Text.

◆ parseRecord() [3/20]

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

Definition at line 854 of file BitcodeReader.cpp.

References CONCEPT_CONSTRAINT_EXPRESSION, CONCEPT_DEFLOCATION, CONCEPT_IS_TYPE, CONCEPT_NAME, CONCEPT_USR, clang::doc::ConceptInfo::ConstraintExpression, decodeRecord(), clang::doc::SymbolInfo::DefLoc, 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 172 of file BitcodeReader.cpp.

References VERSION.

Referenced by clang::doc::ClangDocBitcodeReader::readBlock(), and 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 871 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 247 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 283 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 334 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 298 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 351 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 180 of file BitcodeReader.cpp.

References decodeRecord(), clang::doc::Info::Name, NAMESPACE_NAME, NAMESPACE_PARENT_USR, NAMESPACE_PATH, NAMESPACE_USR, clang::doc::Info::ParentUSR, 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 197 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::ParentUSR, clang::doc::Info::Path, RECORD_DEFLOCATION, RECORD_IS_TYPE_DEF, RECORD_LOCATION, RECORD_MANGLED_NAME, RECORD_NAME, RECORD_PARENT_USR, 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 807 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 830 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 846 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 837 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 266 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 321 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 879 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 896 of file BitcodeReader.cpp.

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

◆ preprocessCDCtxIndex()

std::vector< Index > clang::doc::preprocessCDCtxIndex ( Index CDCtxIndex)
static
Parameters
CDCtxIndexPassed by copy since clang-doc's context is passed to the generator as const

Definition at line 880 of file JSONGenerator.cpp.

References clang::doc::Index::Children, clang::doc::Reference::getFileBaseName(), clang::doc::Reference::getRelativeFilePath(), clang::doc::Index::getSortedChildren(), internString(), clang::doc::Reference::Path, and clang::doc::Index::sort().

◆ reduce()

template<typename T>
llvm::Expected< Info * > clang::doc::reduce ( SmallVectorImpl< Info * > & Values)
static

Definition at line 98 of file Representation.cpp.

References allocateTransient().

Referenced by mergeInfos().

◆ reduceChildren()

template<typename T>
void clang::doc::reduceChildren ( DocList< T > & Children,
DocList< T > && ChildrenToMerge )
static

Definition at line 109 of file Representation.cpp.

References allocateListNodePersistent().

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

◆ reduceChildren< Reference >()

template<>
void clang::doc::reduceChildren< Reference > ( DocList< Reference > & Children,
DocList< Reference > && ChildrenToMerge )

Definition at line 128 of file Representation.cpp.

References allocateListNodePersistent(), clang::doc::Reference::RefType, and clang::doc::Reference::USR.

◆ serializeArray()

template<typename Container, typename SerializationFunc>
void clang::doc::serializeArray ( const Container & Records,
Object & Obj,
const StringRef Key,
SerializationFunc SerializeInfo,
const StringRef EndKey = "End",
function_ref< void(Object &)> UpdateJson = [](Object &Obj) {} )
static

Definition at line 557 of file JSONGenerator.cpp.

Referenced by serializeTemplateSpecialization().

◆ serializeComment()

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

Definition at line 220 of file JSONGenerator.cpp.

References clang::doc::CommentInfo::Args, clang::doc::CommentInfo::AttrKeys, clang::doc::CommentInfo::AttrValues, clang::doc::CommentInfo::Children, CK_BlockCommandComment, CK_FullComment, CK_HTMLEndTagComment, CK_HTMLStartTagComment, CK_InlineCommandComment, CK_ParagraphComment, CK_ParamCommandComment, CK_TextComment, CK_TParamCommandComment, CK_Unknown, CK_VerbatimBlockComment, CK_VerbatimBlockLineComment, CK_VerbatimLineComment, clang::doc::CommentInfo::CloseName, commentKindToString(), clang::doc::CommentInfo::Direction, clang::doc::CommentInfo::Explicit, extractTextComments(), extractVerbatimComments(), insertComment(), clang::doc::CommentInfo::Kind, clang::doc::CommentInfo::Name, clang::doc::CommentInfo::ParamName, clang::doc::CommentInfo::SelfClosing, serializeComment(), and clang::doc::CommentInfo::Text.

Referenced by serializeComment(), and serializeDescription().

◆ serializeDescription()

void clang::doc::serializeDescription ( const DocList< CommentInfo > & Description,
json::Object & Obj,
StringRef Key = "" )
static

Definition at line 406 of file JSONGenerator.cpp.

References extractTextComments(), insertComment(), and serializeComment().

◆ serializeIndex()

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

Definition at line 421 of file MDGenerator.cpp.

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

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

◆ serializeReference()

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

Definition at line 413 of file MDGenerator.cpp.

References writeNameLink().

Referenced by serializeIndex().

◆ serializeTemplateSpecialization()

void clang::doc::serializeTemplateSpecialization ( TemplateInfo Template,
Object & TemplateObj )
static

Definition at line 469 of file JSONGenerator.cpp.

References getMaxParamWrapLimit(), serializeArray(), and SerializeTemplateParam.

◆ stringToCommentKind()

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

Definition at line 40 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 151 of file MDGenerator.cpp.

References clang::doc::CommentInfo::AttrKeys, clang::doc::CommentInfo::AttrValues, clang::doc::CommentInfo::Children, CK_BlockCommandComment, CK_FullComment, CK_HTMLEndTagComment, CK_HTMLStartTagComment, CK_InlineCommandComment, CK_ParagraphComment, CK_ParamCommandComment, CK_TextComment, CK_TParamCommandComment, CK_Unknown, CK_VerbatimBlockComment, CK_VerbatimBlockLineComment, CK_VerbatimLineComment, clang::doc::CommentInfo::Direction, clang::doc::CommentInfo::Explicit, genEmphasis(), clang::doc::CommentInfo::Kind, clang::doc::CommentInfo::Name, clang::doc::CommentInfo::ParamName, clang::doc::CommentInfo::SelfClosing, clang::doc::CommentInfo::Text, writeDescription(), writeLine(), and writeNewLine().

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(), and writeDescription().

◆ writeNameLink()

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

Definition at line 221 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()

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.

Referenced by maybeWriteSourceFileRef().

◆ YAML()

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

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

Variable Documentation

◆ AllFilesTemplate

std::unique_ptr<MustacheTemplateFile> clang::doc::AllFilesTemplate = nullptr
static

Definition at line 26 of file MDMustacheGenerator.cpp.

Referenced by clang::doc::MDMustacheGenerator::generateDocForJSON(), and clang::doc::MDMustacheGenerator::setupTemplateFiles().

◆ BlockIdCount

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

Definition at line 163 of file BitcodeWriter.h.

◆ EmptySID

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

Definition at line 95 of file Representation.cpp.

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

◆ GlobalNamespaceID

SymbolID clang::doc::GlobalNamespaceID
constexpr
Initial value:
= {0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0, 0, 0}

Definition at line 187 of file Representation.h.

◆ HTMLGeneratorAnchorDest

int clang::doc::HTMLGeneratorAnchorDest = HTMLGeneratorAnchorSource
static

Definition at line 253 of file Generators.cpp.

◆ HTMLGeneratorAnchorSource

volatile int clang::doc::HTMLGeneratorAnchorSource = 0

Definition at line 201 of file HTMLGenerator.cpp.

◆ IndexTemplate [1/2]

std::unique_ptr<MustacheTemplateFile> clang::doc::IndexTemplate = nullptr
static

Definition at line 32 of file HTMLGenerator.cpp.

Referenced by clang::doc::HTMLGenerator::generateDocForJSON(), clang::doc::MDMustacheGenerator::generateDocForJSON(), clang::doc::HTMLGenerator::setupTemplateFiles(), and clang::doc::MDMustacheGenerator::setupTemplateFiles().

◆ IndexTemplate [2/2]

std::unique_ptr<MustacheTemplateFile> clang::doc::IndexTemplate = nullptr
static

Definition at line 28 of file MDMustacheGenerator.cpp.

◆ JSONGeneratorAnchorDest

int clang::doc::JSONGeneratorAnchorDest = JSONGeneratorAnchorSource
static

Definition at line 254 of file Generators.cpp.

◆ JSONGeneratorAnchorSource

volatile int clang::doc::JSONGeneratorAnchorSource = 0

Definition at line 1083 of file JSONGenerator.cpp.

◆ MDGeneratorAnchorDest

int clang::doc::MDGeneratorAnchorDest = MDGeneratorAnchorSource
static

Definition at line 252 of file Generators.cpp.

◆ MDGeneratorAnchorSource

volatile int clang::doc::MDGeneratorAnchorSource = 0

Definition at line 608 of file MDGenerator.cpp.

◆ MDMustacheGeneratorAnchorDest

int clang::doc::MDMustacheGeneratorAnchorDest
static
Initial value:
=
MDMustacheGeneratorAnchorSource
clang::doc::MDMustacheGeneratorAnchorSource
volatile int MDMustacheGeneratorAnchorSource
Definition MDMustacheGenerator.cpp:115

Definition at line 255 of file Generators.cpp.

◆ MDMustacheGeneratorAnchorSource

volatile int clang::doc::MDMustacheGeneratorAnchorSource = 0

Definition at line 115 of file MDMustacheGenerator.cpp.

◆ NamespaceTemplate [1/2]

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

Definition at line 28 of file HTMLGenerator.cpp.

Referenced by clang::doc::HTMLGenerator::generateDocForJSON(), clang::doc::MDMustacheGenerator::generateDocForJSON(), clang::doc::HTMLGenerator::setupTemplateFiles(), and clang::doc::MDMustacheGenerator::setupTemplateFiles().

◆ NamespaceTemplate [2/2]

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

Definition at line 24 of file MDMustacheGenerator.cpp.

◆ PersistentArena

thread_local llvm::BumpPtrAllocator clang::doc::PersistentArena

Definition at line 33 of file Representation.cpp.

Referenced by allocateListNodePersistent(), allocateListNodePersistent(), allocatePersistent(), clang::doc::ConceptInfo::merge(), clang::doc::EnumInfo::merge(), clang::doc::FunctionInfo::merge(), clang::doc::RecordInfo::merge(), clang::doc::TypedefInfo::merge(), clang::doc::Info::mergeBase(), and mergeUnkeyed< CommentInfo >().

◆ RecordIdCount

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

Definition at line 164 of file BitcodeWriter.h.

◆ RecordTemplate [1/2]

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

Definition at line 30 of file HTMLGenerator.cpp.

Referenced by clang::doc::HTMLGenerator::generateDocForJSON(), clang::doc::MDMustacheGenerator::generateDocForJSON(), clang::doc::HTMLGenerator::setupTemplateFiles(), and clang::doc::MDMustacheGenerator::setupTemplateFiles().

◆ RecordTemplate [2/2]

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

Definition at line 22 of file MDMustacheGenerator.cpp.

◆ SerializeTemplateParam

auto clang::doc::SerializeTemplateParam
static
Initial value:
= [](const TemplateParamInfo &Param,
Object &JsonObj) {
JsonObj["Param"] = Param.Contents;
}

Definition at line 464 of file JSONGenerator.cpp.

Referenced by serializeTemplateSpecialization().

◆ TransientArena

thread_local llvm::BumpPtrAllocator clang::doc::TransientArena

Definition at line 32 of file Representation.cpp.

Referenced by allocateListNodeTransient(), allocateListNodeTransient(), allocateTransient(), clang::doc::serialize::Serializer::emitInfo(), clang::doc::serialize::Serializer::emitInfo(), clang::doc::MapASTVisitor::HandleTranslationUnit(), clang::doc::serialize::ClangDocCommentVisitor::parseComment(), clang::doc::ClangDocBitcodeReader::readBlock(), clang::doc::ClangDocBitcodeReader::readBlock(), clang::doc::ClangDocBitcodeReader::readBlock(), clang::doc::ClangDocBitcodeReader::readBlock(), clang::doc::ClangDocBitcodeReader::readBlock(), clang::doc::ClangDocBitcodeReader::readBlock(), clang::doc::ClangDocBitcodeReader::readBlock(), clang::doc::ClangDocBitcodeReader::readBlock(), clang::doc::serialize::ClangDocCommentVisitor::visitBlockCommandComment(), clang::doc::serialize::ClangDocCommentVisitor::visitHTMLStartTagComment(), and clang::doc::serialize::ClangDocCommentVisitor::visitInlineCommandComment().

◆ 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 29 of file BitcodeWriter.h.

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

◆ YAMLGeneratorAnchorDest

int clang::doc::YAMLGeneratorAnchorDest = YAMLGeneratorAnchorSource
static

Definition at line 251 of file Generators.cpp.

◆ YAMLGeneratorAnchorSource

volatile int clang::doc::YAMLGeneratorAnchorSource = 0

Definition at line 600 of file YAMLGenerator.cpp.

Generated on for clang-tools by doxygen 1.14.0