clang::comments Namespace Reference

Namespaces
namespace	tok
Classes
class	Comment
class	InlineContentComment
class	TextComment
	Plain text. More...
class	InlineCommandComment
	A command with word-like arguments that is considered inline content. More...
class	HTMLTagComment
class	HTMLStartTagComment
	An opening HTML tag with attributes. More...
class	HTMLEndTagComment
	A closing HTML tag. More...
class	BlockContentComment
class	ParagraphComment
	A single paragraph that contains inline content. More...
class	BlockCommandComment
class	ParamCommandComment
	Doxygen \param command. More...
class	TParamCommandComment
	Doxygen \tparam command, describes a template parameter. More...
class	VerbatimBlockLineComment
	A line of text contained in a verbatim block. More...
class	VerbatimBlockComment
class	VerbatimLineComment
struct	DeclInfo
	Information about the declaration, useful to clients of FullComment. More...
class	FullComment
	A full comment attached to a declaration, contains block content. More...
class	BriefParser
struct	CommandInfo
	Information about a single command. More...
class	CommandTraits
class	Token
	Comment token. More...
class	Lexer
	Comment lexer. More...
class	Parser
	Doxygen comment parser. More...
class	Sema
struct	make_ptr
struct	make_const_ptr
class	CommentVisitorBase
class	CommentVisitor
class	ConstCommentVisitor
class	TextTokenRetokenizer
	Re-lexes a sequence of tok::text tokens. More...
Enumerations
enum	CommandMarkerKind { CMK_Backslash = 0, CMK_At = 1 }
Functions
static bool	isHTMLNamedCharacterReferenceCharacter (char C)
static bool	isHTMLDecimalCharacterReferenceCharacter (char C)
static bool	isHTMLHexCharacterReferenceCharacter (char C)
static StringRef	convertCodePointToUTF8 (llvm::BumpPtrAllocator &Allocator, unsigned CodePoint)
static int	getParamPassDirection (StringRef Arg)
	Turn a string into the corresponding PassDirection or -1 if it's not valid.

---

Enumeration Type Documentation

enum clang::comments::CommandMarkerKind

Describes the syntax that was used in a documentation command.

Exact values of this enumeration are important because they used to select parts of diagnostic messages. Audit diagnostics before changing or adding a new value.

Enumerator:

CMK_Backslash	Command started with a backslash character: \foo
CMK_At	Command started with an 'at' character: @foo

Definition at line 37 of file Comment.h.

---

Function Documentation

static StringRef clang::comments::convertCodePointToUTF8	(	llvm::BumpPtrAllocator &	Allocator,
		unsigned	CodePoint
	)		[inline, static]

Definition at line 31 of file CommentLexer.cpp.

static int clang::comments::getParamPassDirection

(

StringRef

Arg

)

[static]

Turn a string into the corresponding PassDirection or -1 if it's not valid.

Definition at line 220 of file CommentSema.cpp.

References clang::comments::ParamCommandComment::In, clang::comments::ParamCommandComment::InOut, and clang::comments::ParamCommandComment::Out.

Referenced by clang::comments::Sema::actOnParamCommandDirectionArg().

static bool clang::comments::isHTMLDecimalCharacterReferenceCharacter

(

char

C

)

[inline, static]

Definition at line 23 of file CommentLexer.cpp.

References clang::isDigit().

static bool clang::comments::isHTMLHexCharacterReferenceCharacter

(

char

C

)

[inline, static]

Definition at line 27 of file CommentLexer.cpp.

References clang::isHexDigit().

static bool clang::comments::isHTMLNamedCharacterReferenceCharacter

(

char

C

)

[inline, static]

Definition at line 19 of file CommentLexer.cpp.

References clang::isLetter().