clang API Documentation

Public Types | Public Member Functions | Public Attributes
clang::CommentOptions Struct Reference

Options for controlling comment parsing. More...

#include <CommentOptions.h>

Collaboration diagram for clang::CommentOptions:
Collaboration graph
[legend]

List of all members.

Public Types

typedef std::vector< std::string > BlockCommandNamesTy

Public Member Functions

 CommentOptions ()

Public Attributes

BlockCommandNamesTy BlockCommandNames
 Command names to treat as block commands in comments. Should not include the leading backslash.
bool ParseAllComments
 Treat ordinary comments as documentation comments.

Detailed Description

Options for controlling comment parsing.

Definition at line 24 of file CommentOptions.h.


Member Typedef Documentation

typedef std::vector<std::string> clang::CommentOptions::BlockCommandNamesTy

Definition at line 25 of file CommentOptions.h.


Constructor & Destructor Documentation

Definition at line 34 of file CommentOptions.h.


Member Data Documentation

Command names to treat as block commands in comments. Should not include the leading backslash.

Definition at line 29 of file CommentOptions.h.

Referenced by checkLanguageOptions(), ParseCommentArgs(), and clang::comments::CommandTraits::registerCommentOptions().

Treat ordinary comments as documentation comments.

Definition at line 32 of file CommentOptions.h.

Referenced by clang::Sema::ActOnComment(), clang::ASTContext::getRawCommentForDeclNoCache(), ParseCommentArgs(), and clang::ASTReader::ReadComments().


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