clang  6.0.0svn
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
clang::comments::InlineCommandComment Class Reference

A command with word-like arguments that is considered inline content. More...

#include "clang/AST/Comment.h"

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

Classes

struct  Argument
 

Public Types

enum  RenderKind { RenderNormal, RenderBold, RenderMonospaced, RenderEmphasized }
 The most appropriate rendering mode for this command, chosen on command semantics in Doxygen. More...
 
- Public Types inherited from clang::comments::Comment
enum  CommentKind { NoCommentKind = 0 }
 
typedef Comment *const * child_iterator
 

Public Member Functions

 InlineCommandComment (SourceLocation LocBegin, SourceLocation LocEnd, unsigned CommandID, RenderKind RK, ArrayRef< Argument > Args)
 
child_iterator child_begin () const
 
child_iterator child_end () const
 
unsigned getCommandID () const
 
StringRef getCommandName (const CommandTraits &Traits) const
 
SourceRange getCommandNameRange () const
 
RenderKind getRenderKind () const
 
unsigned getNumArgs () const
 
StringRef getArgText (unsigned Idx) const
 
SourceRange getArgRange (unsigned Idx) const
 
- Public Member Functions inherited from clang::comments::InlineContentComment
void addTrailingNewline ()
 
bool hasTrailingNewline () const
 
- Public Member Functions inherited from clang::comments::Comment
 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
 

Static Public Member Functions

static bool classof (const Comment *C)
 
- Static Public Member Functions inherited from clang::comments::InlineContentComment
static bool classof (const Comment *C)
 

Protected Attributes

ArrayRef< ArgumentArgs
 Command arguments. More...
 
- Protected Attributes inherited from clang::comments::Comment
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
 
}; 
 

Additional Inherited Members

- Protected Types inherited from clang::comments::Comment
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 inherited from clang::comments::InlineContentComment
 InlineContentComment (CommentKind K, SourceLocation LocBegin, SourceLocation LocEnd)
 
- Protected Member Functions inherited from clang::comments::Comment
void setSourceRange (SourceRange SR)
 
void setLocation (SourceLocation L)
 

Detailed Description

A command with word-like arguments that is considered inline content.

Definition at line 303 of file Comment.h.

Member Enumeration Documentation

◆ RenderKind

The most appropriate rendering mode for this command, chosen on command semantics in Doxygen.

Enumerator
RenderNormal 
RenderBold 
RenderMonospaced 
RenderEmphasized 

Definition at line 314 of file Comment.h.

Constructor & Destructor Documentation

◆ InlineCommandComment()

clang::comments::InlineCommandComment::InlineCommandComment ( SourceLocation  LocBegin,
SourceLocation  LocEnd,
unsigned  CommandID,
RenderKind  RK,
ArrayRef< Argument Args 
)
inline

Definition at line 326 of file Comment.h.

References clang::comments::Comment::InlineCommandCommentBits.

Member Function Documentation

◆ child_begin()

child_iterator clang::comments::InlineCommandComment::child_begin ( ) const
inline

Definition at line 341 of file Comment.h.

◆ child_end()

child_iterator clang::comments::InlineCommandComment::child_end ( ) const
inline

Definition at line 343 of file Comment.h.

◆ classof()

static bool clang::comments::InlineCommandComment::classof ( const Comment C)
inlinestatic

Definition at line 337 of file Comment.h.

References clang::comments::Comment::getCommentKind().

◆ getArgRange()

SourceRange clang::comments::InlineCommandComment::getArgRange ( unsigned  Idx) const
inline

Definition at line 370 of file Comment.h.

◆ getArgText()

StringRef clang::comments::InlineCommandComment::getArgText ( unsigned  Idx) const
inline

Definition at line 366 of file Comment.h.

◆ getCommandID()

unsigned clang::comments::InlineCommandComment::getCommandID ( ) const
inline

Definition at line 345 of file Comment.h.

References clang::comments::Comment::InlineCommandCommentBits.

◆ getCommandName()

StringRef clang::comments::InlineCommandComment::getCommandName ( const CommandTraits Traits) const
inline

◆ getCommandNameRange()

SourceRange clang::comments::InlineCommandComment::getCommandNameRange ( ) const
inline

◆ getNumArgs()

unsigned clang::comments::InlineCommandComment::getNumArgs ( ) const
inline

Definition at line 362 of file Comment.h.

◆ getRenderKind()

RenderKind clang::comments::InlineCommandComment::getRenderKind ( ) const
inline

Definition at line 358 of file Comment.h.

References clang::comments::Comment::InlineCommandCommentBits.

Member Data Documentation

◆ Args

ArrayRef<Argument> clang::comments::InlineCommandComment::Args
protected

Command arguments.

Definition at line 323 of file Comment.h.


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