clang  6.0.0svn
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.
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.
33 
34  CommentOptions() : ParseAllComments(false) { }
35 };
36 
37 } // end namespace clang
38 
39 #endif
Options for controlling comment parsing.
BlockCommandNamesTy BlockCommandNames
Command names to treat as block commands in comments.
std::vector< std::string > BlockCommandNamesTy
#define false
Definition: stdbool.h:33
Dataflow Directional Tag Classes.
bool ParseAllComments
Treat ordinary comments as documentation comments.