clang-tools 8.0.0

Classes | Public Member Functions | List of all members
clang::doc::ClangDocBitcodeWriter Class Reference

`#include <BitcodeWriter.h>`

## Public Member Functions
| ClangDocBitcodeWriter (llvm::BitstreamWriter &Stream)
bool | dispatchInfoForWrite (Info *I)
void | emitBlock (const NamespaceInfo &I)
void | emitBlock (const RecordInfo &I)
void | emitBlock (const FunctionInfo &I)
void | emitBlock (const EnumInfo &I)
void | emitBlock (const TypeInfo &B)
void | emitBlock (const FieldTypeInfo &B)
void | emitBlock (const MemberTypeInfo &B)
void | emitBlock (const CommentInfo &B)
void | emitBlock (const Reference &B, FieldId F)

## Detailed Description

Definition at line 128 of file BitcodeWriter.h.

## Constructor & Destructor Documentation

## ◆ ClangDocBitcodeWriter()

clang::doc::ClangDocBitcodeWriter::ClangDocBitcodeWriter | ( | llvm::BitstreamWriter & | Stream | ) |
| inline

Definition at line 130 of file BitcodeWriter.h.

## Member Function Documentation

## ◆ dispatchInfoForWrite()

bool clang::doc::ClangDocBitcodeWriter::dispatchInfoForWrite | ( | Info * | I | ) |

Definition at line 508 of file BitcodeWriter.cpp.

References clang::doc::Info::IT, clang::doc::IT_enum, clang::doc::IT_function, clang::doc::IT_namespace, and clang::doc::IT_record.

## ◆ emitBlock() [1/9]

void clang::doc::ClangDocBitcodeWriter::emitBlock | ( | const NamespaceInfo & | I | ) |

Definition at line 427 of file BitcodeWriter.cpp.

References clang::doc::BI_NAMESPACE_BLOCK_ID, clang::doc::NamespaceInfo::ChildEnums, clang::doc::NamespaceInfo::ChildFunctions, clang::doc::NamespaceInfo::ChildNamespaces, clang::doc::NamespaceInfo::ChildRecords, clang::doc::Info::Description, clang::doc::F_child_namespace, clang::doc::F_child_record, clang::doc::F_namespace, clang::doc::Info::Name, clang::doc::Info::Namespace, clang::doc::NAMESPACE_NAME, clang::doc::NAMESPACE_USR, and clang::doc::Info::USR.

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

## ◆ emitBlock() [2/9]

void clang::doc::ClangDocBitcodeWriter::emitBlock | ( | const RecordInfo & | I | ) |

Definition at line 462 of file BitcodeWriter.cpp.

References clang::doc::BI_RECORD_BLOCK_ID, clang::doc::RecordInfo::ChildEnums, clang::doc::RecordInfo::ChildFunctions, clang::doc::RecordInfo::ChildRecords, clang::doc::SymbolInfo::DefLoc, clang::doc::Info::Description, clang::doc::F_child_record, clang::doc::F_namespace, clang::doc::F_parent, clang::doc::F_vparent, clang::doc::SymbolInfo::Loc, clang::doc::RecordInfo::Members, clang::doc::Info::Name, clang::doc::Info::Namespace, clang::doc::RecordInfo::Parents, clang::doc::RECORD_DEFLOCATION, clang::doc::RECORD_LOCATION, clang::doc::RECORD_NAME, clang::doc::RECORD_TAG_TYPE, clang::doc::RECORD_USR, clang::doc::RecordInfo::TagType, clang::doc::Info::USR, and clang::doc::RecordInfo::VirtualParents.

## ◆ emitBlock() [3/9]

void clang::doc::ClangDocBitcodeWriter::emitBlock | ( | const FunctionInfo & | I | ) |

Definition at line 489 of file BitcodeWriter.cpp.

References clang::doc::BI_FUNCTION_BLOCK_ID, clang::doc::SymbolInfo::DefLoc, clang::doc::Info::Description, clang::doc::F_namespace, clang::doc::F_parent, clang::doc::FUNCTION_DEFLOCATION, clang::doc::FUNCTION_IS_METHOD, clang::doc::FUNCTION_LOCATION, clang::doc::FUNCTION_NAME, clang::doc::FUNCTION_USR, clang::doc::FunctionInfo::IsMethod, clang::doc::SymbolInfo::Loc, clang::doc::Info::Name, clang::doc::Info::Namespace, clang::doc::FunctionInfo::Params, clang::doc::FunctionInfo::Parent, clang::doc::FunctionInfo::ReturnType, and clang::doc::Info::USR.

## ◆ emitBlock() [4/9]

void clang::doc::ClangDocBitcodeWriter::emitBlock | ( | const EnumInfo & | I | ) |

Definition at line 445 of file BitcodeWriter.cpp.

References clang::doc::BI_ENUM_BLOCK_ID, clang::doc::SymbolInfo::DefLoc, clang::doc::Info::Description, clang::doc::ENUM_DEFLOCATION, clang::doc::ENUM_LOCATION, clang::doc::ENUM_MEMBER, clang::doc::ENUM_NAME, clang::doc::ENUM_SCOPED, clang::doc::ENUM_USR, clang::doc::F_namespace, clang::doc::SymbolInfo::Loc, clang::doc::EnumInfo::Members, clang::doc::Info::Name, clang::doc::Info::Namespace, clang::doc::EnumInfo::Scoped, and clang::doc::Info::USR.

## ◆ emitBlock() [5/9]

void clang::doc::ClangDocBitcodeWriter::emitBlock | ( | const TypeInfo & | B | ) |

Definition at line 387 of file BitcodeWriter.cpp.

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

## ◆ emitBlock() [6/9]

void clang::doc::ClangDocBitcodeWriter::emitBlock | ( | const FieldTypeInfo & | B | ) |

Definition at line 392 of file BitcodeWriter.cpp.

References clang::doc::BI_FIELD_TYPE_BLOCK_ID, clang::doc::F_type, clang::doc::FIELD_TYPE_NAME, clang::doc::FieldTypeInfo::Name, and clang::doc::TypeInfo::Type.

## ◆ emitBlock() [7/9]

void clang::doc::ClangDocBitcodeWriter::emitBlock | ( | const MemberTypeInfo & | B | ) |

Definition at line 398 of file BitcodeWriter.cpp.

References clang::doc::MemberTypeInfo::Access, clang::doc::BI_MEMBER_TYPE_BLOCK_ID, clang::doc::F_type, clang::doc::MEMBER_TYPE_ACCESS, clang::doc::MEMBER_TYPE_NAME, clang::doc::FieldTypeInfo::Name, and clang::doc::TypeInfo::Type.

## ◆ emitBlock() [8/9]

void clang::doc::ClangDocBitcodeWriter::emitBlock | ( | const CommentInfo & | B | ) |

Definition at line 405 of file BitcodeWriter.cpp.

References clang::doc::CommentInfo::Args, clang::doc::CommentInfo::AttrKeys, clang::doc::CommentInfo::AttrValues, clang::doc::BI_COMMENT_BLOCK_ID, clang::doc::CommentInfo::Children, clang::doc::CommentInfo::CloseName, clang::doc::COMMENT_ARG, clang::doc::COMMENT_ATTRKEY, clang::doc::COMMENT_ATTRVAL, clang::doc::COMMENT_CLOSENAME, clang::doc::COMMENT_DIRECTION, clang::doc::COMMENT_EXPLICIT, clang::doc::COMMENT_KIND, clang::doc::COMMENT_NAME, clang::doc::COMMENT_PARAMNAME, clang::doc::COMMENT_SELFCLOSING, clang::doc::COMMENT_TEXT, clang::doc::CommentInfo::Direction, clang::doc::CommentInfo::Explicit, clang::doc::CommentInfo::Kind, clang::doc::CommentInfo::Name, clang::doc::CommentInfo::ParamName, clang::doc::CommentInfo::SelfClosing, and clang::doc::CommentInfo::Text.

## ◆ emitBlock() [9/9]

void clang::doc::ClangDocBitcodeWriter::emitBlock | ( | const Reference & | B,
|  | FieldId | F
| ) |  |

Definition at line 377 of file BitcodeWriter.cpp.

References clang::doc::BI_REFERENCE_BLOCK_ID, clang::doc::Reference::Name, clang::doc::REFERENCE_NAME, clang::doc::REFERENCE_TYPE, clang::doc::REFERENCE_USR, clang::doc::Reference::RefType, and clang::doc::Reference::USR.

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

- BitcodeWriter.h
- BitcodeWriter.cpp