clang
7.0.0
include
clang
Basic
CommentOptions.h
Go to the documentation of this file.
1
//===- CommentOptions.h - Options for parsing comments ----------*- C++ -*-===//
2
//
3
// The LLVM Compiler Infrastructure
4
//
5
// This file is distributed under the University of Illinois Open Source
6
// License. See LICENSE.TXT for details.
7
//
8
//===----------------------------------------------------------------------===//
9
//
10
/// \file
11
/// Defines the clang::CommentOptions interface.
12
//
13
//===----------------------------------------------------------------------===//
14
15
#ifndef LLVM_CLANG_BASIC_COMMENTOPTIONS_H
16
#define LLVM_CLANG_BASIC_COMMENTOPTIONS_H
17
18
#include <string>
19
#include <vector>
20
21
namespace
clang
{
22
23
/// Options for controlling comment parsing.
24
struct
CommentOptions
{
25
using
BlockCommandNamesTy
= std::vector<std::string>;
26
27
/// Command names to treat as block commands in comments.
28
/// Should not include the leading backslash.
29
BlockCommandNamesTy
BlockCommandNames
;
30
31
/// Treat ordinary comments as documentation comments.
32
bool
ParseAllComments
=
false
;
33
34
CommentOptions
() =
default
;
35
};
36
37
}
// namespace clang
38
39
#endif // LLVM_CLANG_BASIC_COMMENTOPTIONS_H
clang::CommentOptions
Options for controlling comment parsing.
Definition:
CommentOptions.h:24
clang::CommentOptions::BlockCommandNames
BlockCommandNamesTy BlockCommandNames
Command names to treat as block commands in comments.
Definition:
CommentOptions.h:29
clang::CommentOptions::BlockCommandNamesTy
std::vector< std::string > BlockCommandNamesTy
Definition:
CommentOptions.h:25
clang::CommentOptions::CommentOptions
CommentOptions()=default
clang
Dataflow Directional Tag Classes.
Definition:
CFGReachabilityAnalysis.h:22
clang::CommentOptions::ParseAllComments
bool ParseAllComments
Treat ordinary comments as documentation comments.
Definition:
CommentOptions.h:32
Generated on Mon Sep 17 2018 14:01:38 for clang by
1.8.13