clang API Documentation

Classes | Public Types | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes
clang::comments::Comment Class Reference

#include <Comment.h>

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

List of all members.

Classes

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

Public Types

enum  CommentKind { NoCommentKind = 0 }
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 (const ASTContext &Context) const
void dump (raw_ostream &OS, const CommandTraits *Traits, const SourceManager *SM) const
SourceRange getSourceRange () const LLVM_READONLY
SourceLocation getLocStart () const LLVM_READONLY
SourceLocation getLocEnd () 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.
SourceRange Range
 Source range of this AST node.
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 53 of file Comment.h.

Member Typedef Documentation

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

Definition at line 228 of file Comment.h.

Member Enumeration Documentation

anonymous enum [protected]
Enumerator:
NumParagraphCommentBits 

Definition at line 136 of file Comment.h.

anonymous enum [protected]
Enumerator:
NumBlockCommandCommentBits 

Definition at line 149 of file Comment.h.

anonymous enum [protected]
Enumerator:
NumParamCommandCommentBits 

Definition at line 163 of file Comment.h.

anonymous enum [protected]
Enumerator:
NumCommentBits 

Definition at line 67 of file Comment.h.

anonymous enum [protected]
Enumerator:
NumInlineContentCommentBits 

Definition at line 78 of file Comment.h.

anonymous enum [protected]
Enumerator:
NumTextCommentBits 

Definition at line 91 of file Comment.h.

anonymous enum [protected]
Enumerator:
NumInlineCommandCommentBits 

Definition at line 101 of file Comment.h.

anonymous enum [protected]
Enumerator:
NumHTMLTagCommentBits 

Definition at line 112 of file Comment.h.

anonymous enum [protected]
Enumerator:
NumHTMLStartTagCommentBits 

Definition at line 123 of file Comment.h.

enum clang::comments::Comment::CommentKind
Enumerator:
NoCommentKind 

Definition at line 186 of file Comment.h.

Constructor & Destructor Documentation

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

Definition at line 197 of file Comment.h.

References CommentBits.

Member Function Documentation

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

Reimplemented in clang::comments::FullComment, clang::comments::VerbatimLineComment, clang::comments::VerbatimBlockComment, clang::comments::VerbatimBlockLineComment, clang::comments::BlockCommandComment, clang::comments::ParagraphComment, clang::comments::HTMLEndTagComment, clang::comments::HTMLStartTagComment, clang::comments::InlineCommandComment, and clang::comments::TextComment.

Definition at line 69 of file Comment.cpp.

References getCommentKind(), and NoCommentKind.

Referenced by child_count().

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

Definition at line 235 of file Comment.h.

References child_begin(), and child_end().

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

Reimplemented in clang::comments::FullComment, clang::comments::VerbatimLineComment, clang::comments::VerbatimBlockComment, clang::comments::VerbatimBlockLineComment, clang::comments::BlockCommandComment, clang::comments::ParagraphComment, clang::comments::HTMLEndTagComment, clang::comments::HTMLStartTagComment, clang::comments::InlineCommandComment, and clang::comments::TextComment.

Definition at line 83 of file Comment.cpp.

References getCommentKind(), and NoCommentKind.

Referenced by child_count().

LLVM_DUMP_METHOD void Comment::dump ( ) const

Definition at line 2268 of file ASTDumper.cpp.

References dump().

LLVM_DUMP_METHOD void Comment::dump ( const ASTContext &  Context) const

Definition at line 2272 of file ASTDumper.cpp.

References dump(), clang::ASTContext::getCommentCommandTraits(), and clang::ASTContext::getSourceManager().

void Comment::dump ( raw_ostream &  OS,
const CommandTraits *  Traits,
const SourceManager *  SM 
) const

Definition at line 2277 of file ASTDumper.cpp.

LLVM_DUMP_METHOD void Comment::dumpColor ( ) const

Definition at line 2284 of file ASTDumper.cpp.

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

Definition at line 204 of file Comment.h.

References CommentBits.

Referenced by child_begin(), child_end(), clang::comments::InlineContentComment::classof(), clang::comments::TextComment::classof(), clang::comments::InlineCommandComment::classof(), clang::comments::HTMLTagComment::classof(), clang::comments::HTMLStartTagComment::classof(), clang::comments::HTMLEndTagComment::classof(), clang::comments::BlockContentComment::classof(), clang::comments::ParagraphComment::classof(), clang::comments::BlockCommandComment::classof(), clang::comments::ParamCommandComment::classof(), clang::comments::TParamCommandComment::classof(), clang::comments::VerbatimBlockLineComment::classof(), clang::comments::VerbatimBlockComment::classof(), clang::comments::VerbatimLineComment::classof(), clang::comments::FullComment::classof(), getCommentKindName(), and clang::comments::CommentVisitorBase< make_const_ptr, ImplClass, RetTy >::visit().

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

Definition at line 22 of file Comment.cpp.

References getCommentKind(), and NoCommentKind.

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

Definition at line 226 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::Sema::checkBlockCommandDuplicate(), clang::comments::Sema::checkContainerDecl(), clang::comments::Sema::checkContainerDeclVerbatimLine(), clang::comments::Sema::checkDeprecatedCommand(), clang::comments::Sema::checkFunctionDeclVerbatimLine(), clang::comments::Sema::checkReturnsCommand(), and clang::comments::HTMLTagComment::getTagNameSourceRange().

SourceLocation clang::comments::Comment::getLocEnd ( ) const [inline]

Definition at line 222 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().

SourceLocation clang::comments::Comment::getLocStart ( ) const [inline]

Definition at line 218 of file Comment.h.

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

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

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

Definition at line 216 of file Comment.h.

References Range.

Referenced by clang::comments::Sema::actOnFullComment(), clang::comments::Sema::actOnHTMLEndTag(), clang::comments::Sema::checkBlockCommandDuplicate(), clang::comments::Sema::checkBlockCommandEmptyParagraph(), clang::comments::Sema::checkContainerDecl(), clang::comments::Sema::checkContainerDeclVerbatimLine(), clang::comments::Sema::checkDeprecatedCommand(), clang::comments::Sema::checkFunctionDeclVerbatimLine(), and clang::comments::Sema::checkReturnsCommand().

void clang::comments::Comment::setLocation ( SourceLocation  L) [inline, protected]

Definition at line 181 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().

void clang::comments::Comment::setSourceRange ( SourceRange  SR) [inline, protected]

Definition at line 177 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 { ... } [protected]
BlockCommandCommentBitfields clang::comments::Comment::BlockCommandCommentBits

Definition at line 173 of file Comment.h.

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

CommentBitfields clang::comments::Comment::CommentBits

Definition at line 166 of file Comment.h.

Referenced by Comment(), and getCommentKind().

HTMLStartTagCommentBitfields clang::comments::Comment::HTMLStartTagCommentBits

Definition at line 171 of file Comment.h.

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

HTMLTagCommentBitfields clang::comments::Comment::HTMLTagCommentBits

Definition at line 170 of file Comment.h.

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

InlineCommandCommentBitfields clang::comments::Comment::InlineCommandCommentBits

Definition at line 169 of file Comment.h.

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

InlineContentCommentBitfields clang::comments::Comment::InlineContentCommentBits

Definition at line 167 of file Comment.h.

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

SourceLocation clang::comments::Comment::Loc [protected]

Preferred location to show caret.

Definition at line 56 of file Comment.h.

Referenced by getLocation(), and setLocation().

ParagraphCommentBitfields clang::comments::Comment::ParagraphCommentBits

Definition at line 172 of file Comment.h.

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

ParamCommandCommentBitfields clang::comments::Comment::ParamCommandCommentBits

Definition at line 174 of file Comment.h.

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

SourceRange clang::comments::Comment::Range [protected]

Source range of this AST node.

Definition at line 59 of file Comment.h.

Referenced by getLocEnd(), getLocStart(), getSourceRange(), clang::comments::HTMLStartTagComment::setAttrs(), clang::comments::HTMLStartTagComment::setGreaterLoc(), and setSourceRange().

TextCommentBitfields clang::comments::Comment::TextCommentBits

Definition at line 168 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 Tue Nov 18 2014 04:30:11 for r222231 by Doxygen 1.7.6.1.

See the Main Clang Web Page for more information.