clang  6.0.0svn
Public Types | Public Member Functions | Public Attributes | List of all members
clang::CommentOptions Struct Reference

Options for controlling comment parsing. More...

#include "clang/Basic/CommentOptions.h"

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

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. More...
 
bool ParseAllComments
 Treat ordinary comments as documentation comments. More...
 

Detailed Description

Options for controlling comment parsing.

Definition at line 24 of file CommentOptions.h.

Member Typedef Documentation

◆ BlockCommandNamesTy

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

Definition at line 25 of file CommentOptions.h.

Constructor & Destructor Documentation

◆ CommentOptions()

clang::CommentOptions::CommentOptions ( )
inline

Definition at line 34 of file CommentOptions.h.

Member Data Documentation

◆ BlockCommandNames

BlockCommandNamesTy clang::CommentOptions::BlockCommandNames

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(), and ParseCommentArgs().

◆ ParseAllComments

bool clang::CommentOptions::ParseAllComments

Treat ordinary comments as documentation comments.

Definition at line 32 of file CommentOptions.h.

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


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