clang  8.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

using BlockCommandNamesTy = std::vector< std::string >
 

Public Member Functions

 CommentOptions ()=default
 

Public Attributes

BlockCommandNamesTy BlockCommandNames
 Command names to treat as block commands in comments. More...
 
bool ParseAllComments = false
 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

using clang::CommentOptions::BlockCommandNamesTy = std::vector<std::string>

Definition at line 25 of file CommentOptions.h.

Constructor & Destructor Documentation

◆ CommentOptions()

clang::CommentOptions::CommentOptions ( )
default

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(), ParseCommentArgs(), and clang::comments::CommandTraits::registerCommentOptions().

◆ ParseAllComments

bool clang::CommentOptions::ParseAllComments = false

Treat ordinary comments as documentation comments.

Definition at line 32 of file CommentOptions.h.

Referenced by clang::ASTContext::getRawCommentForAnyRedecl(), clang::ASTContext::getRawCommentForDeclNoCache(), ParseCommentArgs(), and clang::RawComment::RawComment().


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