clang API Documentation

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

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

#include <Comment.h>

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

List of all members.

Classes

struct  Argument

Public Types

enum  RenderKind { RenderNormal, RenderBold, RenderMonospaced, RenderEmphasized }

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

Static Public Member Functions

static bool classof (const Comment *C)

Protected Attributes

ArrayRef< ArgumentArgs
 Command arguments.

Detailed Description

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

Definition at line 303 of file Comment.h.


Member Enumeration Documentation

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

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

Reimplemented from clang::comments::Comment.

Definition at line 341 of file Comment.h.

Reimplemented from clang::comments::Comment.

Definition at line 343 of file Comment.h.

static bool clang::comments::InlineCommandComment::classof ( const Comment C) [inline, static]

Reimplemented from clang::comments::InlineContentComment.

Definition at line 337 of file Comment.h.

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

Definition at line 370 of file Comment.h.

References Args.

Definition at line 366 of file Comment.h.

References Args.

Definition at line 345 of file Comment.h.

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

Referenced by getCommandName().

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

Definition at line 362 of file Comment.h.

References Args.

Definition at line 358 of file Comment.h.

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


Member Data Documentation

Command arguments.

Definition at line 323 of file Comment.h.

Referenced by getArgRange(), getArgText(), and getNumArgs().


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