clang::doc::CommentInfo Struct Reference

#include <Representation.h>

Public Member Functions
	CommentInfo ()=default
	CommentInfo (const CommentInfo &Other)=default
CommentInfo &	operator= (const CommentInfo &Other)=default
	CommentInfo (const CommentInfo &Other, llvm::BumpPtrAllocator &Arena)
	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 246 of file Representation.h.

Constructor & Destructor Documentation

CommentInfo() [1/5]

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

default

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

CommentInfo() [2/5]

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

default

References CommentInfo().

CommentInfo() [3/5]

clang::doc::CommentInfo::CommentInfo	(	const CommentInfo &	Other,
		llvm::BumpPtrAllocator &	Arena )

Definition at line 335 of file Representation.cpp.

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

CommentInfo() [4/5]

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

default

References CommentInfo().

CommentInfo() [5/5]

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 254 of file Representation.h.

References Children, and Kind.

Member Function Documentation

operator<()

bool clang::doc::CommentInfo::operator<

(

const CommentInfo &

Other

)

const

Definition at line 315 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 300 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

Initial value:

=
      {}

Definition at line 284 of file Representation.h.

Referenced by CommentInfo(), 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 281 of file Representation.h.

Referenced by CommentInfo(), 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

Initial value:

=
      {}

Definition at line 282 of file Representation.h.

Referenced by CommentInfo(), 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

Initial value:

=
      {}

Definition at line 274 of file Representation.h.

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

CloseName

StringRef clang::doc::CommentInfo::CloseName = {}

Definition at line 279 of file Representation.h.

Referenced by CommentInfo(), 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 276 of file Representation.h.

Referenced by CommentInfo(), 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 294 of file Representation.h.

Referenced by CommentInfo(), 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 286 of file Representation.h.

Referenced by CommentInfo(), 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 277 of file Representation.h.

Referenced by CommentInfo(), 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 278 of file Representation.h.

Referenced by CommentInfo(), 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 293 of file Representation.h.

Referenced by CommentInfo(), 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 280 of file Representation.h.

Referenced by CommentInfo(), 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:

• Representation.h
• Representation.cpp