clang
3.9.0
Main Page
Related Pages
Modules
Namespaces
Classes
Files
File List
File Members
llvm.src
tools
clang
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
/// \brief 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
/// \brief Options for controlling comment parsing.
24
struct
CommentOptions
{
25
typedef
std::vector<std::string>
BlockCommandNamesTy
;
26
27
/// \brief Command names to treat as block commands in comments.
28
/// Should not include the leading backslash.
29
BlockCommandNamesTy
BlockCommandNames
;
30
31
/// \brief Treat ordinary comments as documentation comments.
32
bool
ParseAllComments
;
33
34
CommentOptions
() :
ParseAllComments
(
false
) { }
35
};
36
37
}
// end namespace clang
38
39
#endif
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()
Definition:
CommentOptions.h:34
false
#define false
Definition:
stdbool.h:33
clang::CommentOptions::ParseAllComments
bool ParseAllComments
Treat ordinary comments as documentation comments.
Definition:
CommentOptions.h:32
Generated on Wed Aug 31 2016 16:58:01 for clang by
1.8.6