1 //===--- CommentOptions.h - Options for parsing comments -----*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
11 /// \brief Defines the clang::CommentOptions interface.
13 //===----------------------------------------------------------------------===//
15 #ifndef LLVM_CLANG_BASIC_COMMENTOPTIONS_H
16 #define LLVM_CLANG_BASIC_COMMENTOPTIONS_H
23 /// \brief Options for controlling comment parsing.
24 struct CommentOptions {
25 typedef std::vector<std::string> BlockCommandNamesTy;
27 /// \brief Command names to treat as block commands in comments.
28 /// Should not include the leading backslash.
29 BlockCommandNamesTy BlockCommandNames;
31 /// \brief Treat ordinary comments as documentation comments.
32 bool ParseAllComments;
34 CommentOptions() : ParseAllComments(false) { }
37 } // end namespace clang