clang-tools 23.0.0git
Public Member Functions | Public Attributes | List of all members
clang::doc::CommentInfo Struct Reference

#include <Representation.h>

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

Public Member Functions

 CommentInfo ()=default
 CommentInfo (const CommentInfo &Other)=default
CommentInfo & operator= (const CommentInfo &Other)=default
 CommentInfo (CommentInfo &&Other)=default
CommentInfo & operator= (CommentInfo &&Other)=default
 CommentInfo (CommentKind Kind, llvm::ArrayRef< CommentInfo > Children={}, StringRef Text=StringRef(), StringRef Name=StringRef(), StringRef CloseName=StringRef(), StringRef Direction=StringRef(), StringRef ParamName=StringRef(), bool Explicit=false, bool SelfClosing=false, llvm::ArrayRef< StringRef > AttrKeys={}, llvm::ArrayRef< StringRef > AttrValues={})
bool operator== (const CommentInfo &Other) const
bool operator< (const CommentInfo &Other) const

Public Attributes

llvm::ArrayRef< CommentInfo > Children
StringRef Direction
StringRef Name
StringRef ParamName
StringRef CloseName
StringRef Text
llvm::ArrayRef< StringRef > AttrKeys
llvm::ArrayRef< StringRef > AttrValues
llvm::ArrayRef< StringRef > Args
CommentKind Kind
bool SelfClosing = false
bool Explicit = false

Detailed Description

Definition at line 168 of file Representation.h.

Constructor & Destructor Documentation

◆ CommentInfo() [1/4]

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

Referenced by CommentInfo(), CommentInfo(), operator<(), operator=(), operator=(), and operator==().

◆ CommentInfo() [2/4]

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

References CommentInfo().

◆ CommentInfo() [3/4]

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

References CommentInfo().

◆ CommentInfo() [4/4]

clang::doc::CommentInfo::CommentInfo ( CommentKind Kind,
llvm::ArrayRef< CommentInfo > Children = {},
StringRef Text = StringRef(),
StringRef Name = StringRef(),
StringRef CloseName = StringRef(),
StringRef Direction = StringRef(),
StringRef ParamName = StringRef(),
bool Explicit = false,
bool SelfClosing = false,
llvm::ArrayRef< StringRef > AttrKeys = {},
llvm::ArrayRef< StringRef > AttrValues = {} )
inline

Definition at line 175 of file Representation.h.

References Children, and Kind.

Member Function Documentation

◆ operator<()

bool clang::doc::CommentInfo::operator< ( const CommentInfo & Other) const

Definition at line 202 of file Representation.cpp.

References Args, AttrKeys, AttrValues, Children, CloseName, CommentInfo(), Direction, Explicit, Kind, Name, ParamName, SelfClosing, and Text.

◆ operator=() [1/2]

CommentInfo & clang::doc::CommentInfo::operator= ( CommentInfo && Other)
default

References CommentInfo().

◆ operator=() [2/2]

CommentInfo & clang::doc::CommentInfo::operator= ( const CommentInfo & Other)
default

References CommentInfo().

◆ operator==()

bool clang::doc::CommentInfo::operator== ( const CommentInfo & Other) const

Definition at line 187 of file Representation.cpp.

References Args, AttrKeys, AttrValues, Children, CloseName, CommentInfo(), Direction, Explicit, Kind, Name, ParamName, SelfClosing, and Text.

Member Data Documentation

◆ Args

llvm::ArrayRef<StringRef> clang::doc::CommentInfo::Args

Definition at line 206 of file Representation.h.

Referenced by llvm::yaml::commentInfoMapping(), clang::doc::ClangDocBitcodeWriter::emitBlock(), operator<(), operator==(), clang::doc::ClangDocBitcodeReader::readBlock(), and clang::doc::serializeComment().

◆ AttrKeys

llvm::ArrayRef<StringRef> clang::doc::CommentInfo::AttrKeys

Definition at line 202 of file Representation.h.

Referenced by llvm::yaml::commentInfoMapping(), clang::doc::ClangDocBitcodeWriter::emitBlock(), operator<(), operator==(), clang::doc::ClangDocBitcodeReader::readBlock(), clang::doc::serializeComment(), and clang::doc::writeDescription().

◆ AttrValues

llvm::ArrayRef<StringRef> clang::doc::CommentInfo::AttrValues

Definition at line 204 of file Representation.h.

Referenced by llvm::yaml::commentInfoMapping(), clang::doc::ClangDocBitcodeWriter::emitBlock(), operator<(), operator==(), clang::doc::ClangDocBitcodeReader::readBlock(), clang::doc::serializeComment(), and clang::doc::writeDescription().

◆ Children

llvm::ArrayRef<CommentInfo> clang::doc::CommentInfo::Children

Definition at line 196 of file Representation.h.

Referenced by CommentInfo(), llvm::yaml::commentInfoMapping(), clang::doc::ClangDocBitcodeWriter::emitBlock(), operator<(), operator==(), clang::doc::serialize::ClangDocCommentVisitor::parseComment(), clang::doc::ClangDocBitcodeReader::readBlock(), clang::doc::serializeComment(), and clang::doc::writeDescription().

◆ CloseName

StringRef clang::doc::CommentInfo::CloseName

Definition at line 200 of file Representation.h.

Referenced by llvm::yaml::commentInfoMapping(), clang::doc::ClangDocBitcodeWriter::emitBlock(), operator<(), operator==(), clang::doc::parseRecord(), and clang::doc::serializeComment().

◆ Direction

StringRef clang::doc::CommentInfo::Direction

Definition at line 197 of file Representation.h.

Referenced by llvm::yaml::commentInfoMapping(), clang::doc::ClangDocBitcodeWriter::emitBlock(), operator<(), operator==(), clang::doc::parseRecord(), clang::doc::serializeComment(), and clang::doc::writeDescription().

◆ Explicit

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

Definition at line 215 of file Representation.h.

Referenced by llvm::yaml::commentInfoMapping(), clang::doc::ClangDocBitcodeWriter::emitBlock(), operator<(), operator==(), clang::doc::parseRecord(), clang::doc::serializeComment(), and clang::doc::writeDescription().

◆ Kind

CommentKind clang::doc::CommentInfo::Kind
Initial value:
= CommentKind::
CK_Unknown

Definition at line 207 of file Representation.h.

Referenced by CommentInfo(), llvm::yaml::commentInfoMapping(), clang::doc::ClangDocBitcodeWriter::emitBlock(), operator<(), operator==(), clang::doc::serialize::ClangDocCommentVisitor::parseComment(), clang::doc::parseRecord(), clang::doc::serializeComment(), and clang::doc::writeDescription().

◆ Name

StringRef clang::doc::CommentInfo::Name

Definition at line 198 of file Representation.h.

Referenced by llvm::yaml::commentInfoMapping(), clang::doc::ClangDocBitcodeWriter::emitBlock(), operator<(), operator==(), clang::doc::parseRecord(), clang::doc::serializeComment(), and clang::doc::writeDescription().

◆ ParamName

StringRef clang::doc::CommentInfo::ParamName

Definition at line 199 of file Representation.h.

Referenced by llvm::yaml::commentInfoMapping(), clang::doc::ClangDocBitcodeWriter::emitBlock(), operator<(), operator==(), clang::doc::parseRecord(), clang::doc::serializeComment(), and clang::doc::writeDescription().

◆ SelfClosing

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

Definition at line 214 of file Representation.h.

Referenced by llvm::yaml::commentInfoMapping(), clang::doc::ClangDocBitcodeWriter::emitBlock(), operator<(), operator==(), clang::doc::parseRecord(), clang::doc::serializeComment(), and clang::doc::writeDescription().

◆ Text

StringRef clang::doc::CommentInfo::Text

Definition at line 201 of file Representation.h.

Referenced by llvm::yaml::commentInfoMapping(), clang::doc::ClangDocBitcodeWriter::emitBlock(), operator<(), operator==(), clang::doc::parseRecord(), clang::doc::serializeComment(), and clang::doc::writeDescription().

The documentation for this struct was generated from the following files:
Generated on for clang-tools by doxygen 1.14.0