clang  19.0.0git
Classes | Public Types | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
clang::comments::Comment Class Reference

Any part of the comment. More...

#include "clang/AST/Comment.h"

Inheritance diagram for clang::comments::Comment:
Inheritance graph
[legend]

Classes

struct  Argument
 
class  BlockCommandCommentBitfields
 
class  CommentBitfields
 
class  HTMLStartTagCommentBitfields
 
class  HTMLTagCommentBitfields
 
class  InlineCommandCommentBitfields
 
class  InlineContentCommentBitfields
 
class  ParagraphCommentBitfields
 
class  ParamCommandCommentBitfields
 
class  TextCommentBitfields
 

Public Types

typedef Comment *const * child_iterator
 

Public Member Functions

 Comment (CommentKind K, SourceLocation LocBegin, SourceLocation LocEnd)
 
CommentKind getCommentKind () const
 
const char * getCommentKindName () const
 
void dump () const
 
void dumpColor () const
 
void dump (raw_ostream &OS, const ASTContext &Context) const
 
SourceRange getSourceRange () const LLVM_READONLY
 
SourceLocation getBeginLoc () const LLVM_READONLY
 
SourceLocation getEndLoc () const LLVM_READONLY
 
SourceLocation getLocation () const LLVM_READONLY
 
child_iterator child_begin () const
 
child_iterator child_end () const
 
unsigned child_count () const
 

Protected Types

enum  { NumCommentBits = 8 }
 
enum  { NumInlineContentCommentBits = NumCommentBits + 1 }
 
enum  { NumTextCommentBits = NumInlineContentCommentBits + 2 }
 
enum  { NumInlineCommandCommentBits }
 
enum  { NumHTMLTagCommentBits = NumInlineContentCommentBits + 1 }
 
enum  { NumHTMLStartTagCommentBits = NumHTMLTagCommentBits + 1 }
 
enum  { NumParagraphCommentBits = NumCommentBits + 2 }
 
enum  { NumBlockCommandCommentBits }
 
enum  { NumParamCommandCommentBits = NumBlockCommandCommentBits + 3 }
 

Protected Member Functions

void setSourceRange (SourceRange SR)
 
void setLocation (SourceLocation L)
 

Protected Attributes

SourceLocation Loc
 Preferred location to show caret. More...
 
SourceRange Range
 Source range of this AST node. More...
 
union {
   CommentBitfields   CommentBits
 
   InlineContentCommentBitfields   InlineContentCommentBits
 
   TextCommentBitfields   TextCommentBits
 
   InlineCommandCommentBitfields   InlineCommandCommentBits
 
   HTMLTagCommentBitfields   HTMLTagCommentBits
 
   HTMLStartTagCommentBitfields   HTMLStartTagCommentBits
 
   ParagraphCommentBitfields   ParagraphCommentBits
 
   BlockCommandCommentBitfields   BlockCommandCommentBits
 
   ParamCommandCommentBitfields   ParamCommandCommentBits
 
}; 
 

Detailed Description

Any part of the comment.

Abstract class.

Definition at line 65 of file Comment.h.

Member Typedef Documentation

◆ child_iterator

typedef Comment* const* clang::comments::Comment::child_iterator

Definition at line 251 of file Comment.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
protected
Enumerator
NumHTMLStartTagCommentBits 

Definition at line 149 of file Comment.h.

◆ anonymous enum

anonymous enum
protected
Enumerator
NumParagraphCommentBits 

Definition at line 165 of file Comment.h.

◆ anonymous enum

anonymous enum
protected
Enumerator
NumBlockCommandCommentBits 

Definition at line 181 of file Comment.h.

◆ anonymous enum

anonymous enum
protected
Enumerator
NumParamCommandCommentBits 

Definition at line 198 of file Comment.h.

◆ anonymous enum

anonymous enum
protected
Enumerator
NumCommentBits 

Definition at line 80 of file Comment.h.

◆ anonymous enum

anonymous enum
protected
Enumerator
NumInlineContentCommentBits 

Definition at line 93 of file Comment.h.

◆ anonymous enum

anonymous enum
protected
Enumerator
NumTextCommentBits 

Definition at line 109 of file Comment.h.

◆ anonymous enum

anonymous enum
protected
Enumerator
NumInlineCommandCommentBits 

Definition at line 123 of file Comment.h.

◆ anonymous enum

anonymous enum
protected
Enumerator
NumHTMLTagCommentBits 

Definition at line 136 of file Comment.h.

Constructor & Destructor Documentation

◆ Comment()

clang::comments::Comment::Comment ( CommentKind  K,
SourceLocation  LocBegin,
SourceLocation  LocEnd 
)
inline

Definition at line 226 of file Comment.h.

References CommentBits.

Member Function Documentation

◆ child_begin()

Comment::child_iterator clang::comments::Comment::child_begin ( ) const

Definition at line 83 of file Comment.cpp.

References getCommentKind(), and clang::comments::None.

Referenced by child_count().

◆ child_count()

unsigned clang::comments::Comment::child_count ( ) const
inline

Definition at line 258 of file Comment.h.

References child_begin(), and child_end().

◆ child_end()

Comment::child_iterator clang::comments::Comment::child_end ( ) const

Definition at line 98 of file Comment.cpp.

References getCommentKind(), and clang::comments::None.

Referenced by child_count().

◆ dump() [1/2]

LLVM_DUMP_METHOD void Comment::dump ( ) const

Definition at line 310 of file ASTDumper.cpp.

References clang::ASTNodeTraverser< Derived, NodeDelegateType >::Visit().

◆ dump() [2/2]

LLVM_DUMP_METHOD void Comment::dump ( raw_ostream &  OS,
const ASTContext &  Context 
) const

Definition at line 318 of file ASTDumper.cpp.

◆ dumpColor()

LLVM_DUMP_METHOD void Comment::dumpColor ( ) const

Definition at line 327 of file ASTDumper.cpp.

References clang::ASTNodeTraverser< Derived, NodeDelegateType >::Visit().

◆ getBeginLoc()

SourceLocation clang::comments::Comment::getBeginLoc ( ) const
inline

Definition at line 245 of file Comment.h.

References clang::SourceRange::getBegin(), and Range.

Referenced by clang::comments::BlockCommandComment::getCommandNameBeginLoc(), clang::comments::InlineCommandComment::getCommandNameRange(), clang::comments::BlockCommandComment::setArgs(), and clang::comments::BlockCommandComment::setParagraph().

◆ getCommentKind()

CommentKind clang::comments::Comment::getCommentKind ( ) const
inline

Definition at line 233 of file Comment.h.

References CommentBits.

Referenced by child_begin(), child_end(), and getCommentKindName().

◆ getCommentKindName()

const char * clang::comments::Comment::getCommentKindName ( ) const

Definition at line 35 of file Comment.cpp.

References getCommentKind(), and clang::comments::None.

◆ getEndLoc()

SourceLocation clang::comments::Comment::getEndLoc ( ) const
inline

Definition at line 247 of file Comment.h.

References clang::SourceRange::getEnd(), and Range.

Referenced by clang::comments::InlineCommandComment::getCommandNameRange(), clang::comments::VerbatimLineComment::getTextRange(), and clang::comments::BlockCommandComment::setParagraph().

◆ getLocation()

SourceLocation clang::comments::Comment::getLocation ( ) const
inline

Definition at line 249 of file Comment.h.

References Loc.

Referenced by clang::comments::Sema::actOnFullComment(), clang::comments::Sema::actOnHTMLEndTag(), clang::comments::Sema::actOnParamCommandStart(), clang::comments::Sema::actOnTParamCommandParamNameArg(), clang::comments::Sema::actOnTParamCommandStart(), clang::comments::HTMLTagComment::getTagNameSourceRange(), and clang::comments::Parser::parseHTMLStartTag().

◆ getSourceRange()

SourceRange clang::comments::Comment::getSourceRange ( ) const
inline

Definition at line 243 of file Comment.h.

References Range.

Referenced by clang::comments::Sema::actOnFullComment(), clang::comments::Sema::actOnHTMLEndTag(), and clang::comments::Parser::parseHTMLStartTag().

◆ setLocation()

void clang::comments::Comment::setLocation ( SourceLocation  L)
inlineprotected

Definition at line 216 of file Comment.h.

References Loc.

Referenced by clang::comments::BlockCommandComment::BlockCommandComment(), clang::comments::FullComment::FullComment(), clang::comments::HTMLTagComment::HTMLTagComment(), and clang::comments::ParagraphComment::ParagraphComment().

◆ setSourceRange()

void clang::comments::Comment::setSourceRange ( SourceRange  SR)
inlineprotected

Definition at line 212 of file Comment.h.

References Range.

Referenced by clang::comments::FullComment::FullComment(), clang::comments::ParagraphComment::ParagraphComment(), clang::comments::BlockCommandComment::setArgs(), and clang::comments::BlockCommandComment::setParagraph().

Member Data Documentation

◆ 

union { ... }

◆ BlockCommandCommentBits

BlockCommandCommentBitfields clang::comments::Comment::BlockCommandCommentBits

Definition at line 208 of file Comment.h.

Referenced by clang::comments::BlockCommandComment::BlockCommandComment(), clang::comments::BlockCommandComment::getCommandID(), and clang::comments::BlockCommandComment::getCommandMarker().

◆ CommentBits

CommentBitfields clang::comments::Comment::CommentBits

Definition at line 201 of file Comment.h.

Referenced by Comment(), and getCommentKind().

◆ HTMLStartTagCommentBits

HTMLStartTagCommentBitfields clang::comments::Comment::HTMLStartTagCommentBits

Definition at line 206 of file Comment.h.

Referenced by clang::comments::HTMLStartTagComment::HTMLStartTagComment(), clang::comments::HTMLStartTagComment::isSelfClosing(), and clang::comments::HTMLStartTagComment::setSelfClosing().

◆ HTMLTagCommentBits

HTMLTagCommentBitfields clang::comments::Comment::HTMLTagCommentBits

Definition at line 205 of file Comment.h.

Referenced by clang::comments::HTMLTagComment::HTMLTagComment(), clang::comments::HTMLTagComment::isMalformed(), and clang::comments::HTMLTagComment::setIsMalformed().

◆ InlineCommandCommentBits

InlineCommandCommentBitfields clang::comments::Comment::InlineCommandCommentBits

Definition at line 204 of file Comment.h.

Referenced by clang::comments::InlineCommandComment::getCommandID(), clang::comments::InlineCommandComment::getRenderKind(), and clang::comments::InlineCommandComment::InlineCommandComment().

◆ InlineContentCommentBits

InlineContentCommentBitfields clang::comments::Comment::InlineContentCommentBits

Definition at line 202 of file Comment.h.

Referenced by clang::comments::InlineContentComment::addTrailingNewline(), clang::comments::InlineContentComment::hasTrailingNewline(), and clang::comments::InlineContentComment::InlineContentComment().

◆ Loc

SourceLocation clang::comments::Comment::Loc
protected

Preferred location to show caret.

Definition at line 68 of file Comment.h.

Referenced by getLocation(), and setLocation().

◆ ParagraphCommentBits

ParagraphCommentBitfields clang::comments::Comment::ParagraphCommentBits

Definition at line 207 of file Comment.h.

Referenced by clang::comments::ParagraphComment::isWhitespace(), and clang::comments::ParagraphComment::ParagraphComment().

◆ ParamCommandCommentBits

ParamCommandCommentBitfields clang::comments::Comment::ParamCommandCommentBits

Definition at line 209 of file Comment.h.

Referenced by clang::comments::ParamCommandComment::getDirection(), clang::comments::ParamCommandComment::isDirectionExplicit(), clang::comments::ParamCommandComment::ParamCommandComment(), and clang::comments::ParamCommandComment::setDirection().

◆ Range

SourceRange clang::comments::Comment::Range
protected

Source range of this AST node.

Definition at line 71 of file Comment.h.

Referenced by getBeginLoc(), getEndLoc(), getSourceRange(), clang::comments::HTMLStartTagComment::setAttrs(), clang::comments::HTMLStartTagComment::setGreaterLoc(), and setSourceRange().

◆ TextCommentBits

TextCommentBitfields clang::comments::Comment::TextCommentBits

Definition at line 203 of file Comment.h.

Referenced by clang::comments::TextComment::isWhitespace(), and clang::comments::TextComment::TextComment().

The documentation for this class was generated from the following files:
Generated on Mon Jul 1 2024 01:39:34 for clang by doxygen 1.9.1