clang-tools 8.0.0

Public Member Functions | Public Attributes | List of all members
clang::doc::CommentInfo Struct Reference

`#include <Representation.h>`

Collaboration diagram for clang::doc::CommentInfo:
[legend]

## Public Member Functions
| CommentInfo ()=default
| CommentInfo (CommentInfo &Other)=delete
| CommentInfo (CommentInfo &&Other)=default

## Public Attributes
SmallString< 16 > | Kind
SmallString< 64 > | Text
SmallString< 16 > | Name
SmallString< 8 > | Direction
SmallString< 16 > | ParamName
SmallString< 16 > | CloseName
bool | SelfClosing = false
bool | Explicit = false
llvm::SmallVector< SmallString< 16 >, 4 > | AttrKeys
llvm::SmallVector< SmallString< 16 >, 4 > | AttrValues
llvm::SmallVector< SmallString< 16 >, 4 > | Args
std::vector< std::unique_ptr< CommentInfo > > | Children

## Detailed Description

Definition at line 46 of file Representation.h.

## Constructor & Destructor Documentation

## ◆ CommentInfo() [1/3]

clang::doc::CommentInfo::CommentInfo | ( |  | ) |
| default

## ◆ CommentInfo() [2/3]

clang::doc::CommentInfo::CommentInfo | ( | CommentInfo & | Other | ) |
| delete

## ◆ CommentInfo() [3/3]

clang::doc::CommentInfo::CommentInfo | ( | CommentInfo && | Other | ) |
| default

## Member Data Documentation

## ◆ Args

llvm::SmallVector<SmallString<16>, 4> clang::doc::CommentInfo::Args

Definition at line 70 of file Representation.h.

Referenced by llvm::yaml::CommentInfoMapping(), clang::doc::ClangDocBitcodeWriter::emitBlock(), clang::doc::serialize::ClangDocCommentVisitor::visitBlockCommandComment(), and clang::doc::serialize::ClangDocCommentVisitor::visitInlineCommandComment().

## ◆ AttrKeys

llvm::SmallVector<SmallString<16>, 4> clang::doc::CommentInfo::AttrKeys

Definition at line 66 of file Representation.h.

Referenced by llvm::yaml::CommentInfoMapping(), clang::doc::ClangDocBitcodeWriter::emitBlock(), and clang::doc::serialize::ClangDocCommentVisitor::visitHTMLStartTagComment().

## ◆ AttrValues

llvm::SmallVector<SmallString<16>, 4> clang::doc::CommentInfo::AttrValues

Definition at line 68 of file Representation.h.

Referenced by llvm::yaml::CommentInfoMapping(), clang::doc::ClangDocBitcodeWriter::emitBlock(), and clang::doc::serialize::ClangDocCommentVisitor::visitHTMLStartTagComment().

## ◆ Children

std::vector<std::unique_ptr<CommentInfo> > clang::doc::CommentInfo::Children

Definition at line 72 of file Representation.h.

Referenced by llvm::yaml::CommentInfoMapping(), clang::doc::ClangDocBitcodeWriter::emitBlock(), and clang::doc::getCommentInfo().

## ◆ CloseName

SmallString<16> clang::doc::CommentInfo::CloseName

Definition at line 61 of file Representation.h.

Referenced by llvm::yaml::CommentInfoMapping(), clang::doc::ClangDocBitcodeWriter::emitBlock(), and clang::doc::serialize::ClangDocCommentVisitor::visitVerbatimBlockComment().

## ◆ Direction

SmallString<8> clang::doc::CommentInfo::Direction

Definition at line 59 of file Representation.h.

Referenced by llvm::yaml::CommentInfoMapping(), clang::doc::ClangDocBitcodeWriter::emitBlock(), and clang::doc::serialize::ClangDocCommentVisitor::visitParamCommandComment().

## ◆ Explicit

bool clang::doc::CommentInfo::Explicit = false

Definition at line 63 of file Representation.h.

Referenced by llvm::yaml::CommentInfoMapping(), clang::doc::ClangDocBitcodeWriter::emitBlock(), and clang::doc::serialize::ClangDocCommentVisitor::visitParamCommandComment().

## ◆ Kind

SmallString<16> clang::doc::CommentInfo::Kind

Definition at line 52 of file Representation.h.

Referenced by llvm::yaml::CommentInfoMapping(), clang::doc::ClangDocBitcodeWriter::emitBlock(), clang::doc::serialize::ClangDocCommentVisitor::parseComment(), and clang::doc::writeDescription().

## ◆ Name

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

Definition at line 58 of file Representation.h.

Referenced by llvm::yaml::CommentInfoMapping(), clang::doc::ClangDocBitcodeWriter::emitBlock(), clang::doc::serialize::ClangDocCommentVisitor::visitBlockCommandComment(), clang::doc::serialize::ClangDocCommentVisitor::visitHTMLEndTagComment(), clang::doc::serialize::ClangDocCommentVisitor::visitHTMLStartTagComment(), clang::doc::serialize::ClangDocCommentVisitor::visitInlineCommandComment(), and clang::doc::serialize::ClangDocCommentVisitor::visitVerbatimBlockComment().

## ◆ ParamName

SmallString<16> clang::doc::CommentInfo::ParamName

Definition at line 60 of file Representation.h.

Referenced by llvm::yaml::CommentInfoMapping(), clang::doc::ClangDocBitcodeWriter::emitBlock(), clang::doc::serialize::ClangDocCommentVisitor::visitParamCommandComment(), and clang::doc::serialize::ClangDocCommentVisitor::visitTParamCommandComment().

## ◆ SelfClosing

bool clang::doc::CommentInfo::SelfClosing = false

Definition at line 62 of file Representation.h.

Referenced by llvm::yaml::CommentInfoMapping(), clang::doc::ClangDocBitcodeWriter::emitBlock(), clang::doc::serialize::ClangDocCommentVisitor::visitHTMLEndTagComment(), and clang::doc::serialize::ClangDocCommentVisitor::visitHTMLStartTagComment().

## ◆ Text

SmallString<64> clang::doc::CommentInfo::Text

Definition at line 57 of file Representation.h.

Referenced by llvm::yaml::CommentInfoMapping(), clang::doc::ClangDocBitcodeWriter::emitBlock(), clang::doc::serialize::ClangDocCommentVisitor::visitTextComment(), clang::doc::serialize::ClangDocCommentVisitor::visitVerbatimBlockLineComment(), and clang::doc::serialize::ClangDocCommentVisitor::visitVerbatimLineComment().

The documentation for this struct was generated from the following file:

- Representation.h