Options for controlling comment parsing. More...

#include "clang/Basic/CommentOptions.h"

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.
bool	ParseAllComments = false
	Treat ordinary comments as documentation comments.
bool	RetainComments = false
	Force the front end to retain all documentation comments in the AST, even when no comment consuming diagnostic or language option is enabled.
bool	RetainCommentsFromSystemHeaders = false
	Retain documentation comments from system headers in the AST.

Detailed Description

Options for controlling comment parsing.

Definition at line 23 of file CommentOptions.h.

Member Typedef Documentation

◆ BlockCommandNamesTy

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

Definition at line 24 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 28 of file CommentOptions.h.

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

◆ ParseAllComments

bool clang::CommentOptions::ParseAllComments = false

Treat ordinary comments as documentation comments.

Definition at line 31 of file CommentOptions.h.

Referenced by clang::RawCommentList::addComment(), and clang::RawComment::RawComment().

◆ RetainComments

bool clang::CommentOptions::RetainComments = false

Force the front end to retain all documentation comments in the AST, even when no comment consuming diagnostic or language option is enabled.

Tools that query comments after parsing set this.

Definition at line 36 of file CommentOptions.h.

Referenced by clang::ASTDumpAction::CreateASTConsumer(), and clang::GenerateModuleInterfaceAction::PrepareToExecuteAction().

◆ RetainCommentsFromSystemHeaders

bool clang::CommentOptions::RetainCommentsFromSystemHeaders = false

Retain documentation comments from system headers in the AST.

Definition at line 39 of file CommentOptions.h.

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

include/clang/Basic/CommentOptions.h

Public Types

Public Member Functions

Public Attributes