diff options
Diffstat (limited to 'clang-r344140b/include/clang/Basic/CommentOptions.h')
| -rw-r--r-- | clang-r344140b/include/clang/Basic/CommentOptions.h | 39 |
1 files changed, 39 insertions, 0 deletions
diff --git a/clang-r344140b/include/clang/Basic/CommentOptions.h b/clang-r344140b/include/clang/Basic/CommentOptions.h new file mode 100644 index 00000000..6cc9cf6b --- /dev/null +++ b/clang-r344140b/include/clang/Basic/CommentOptions.h @@ -0,0 +1,39 @@ +//===- CommentOptions.h - Options for parsing comments ----------*- C++ -*-===// +// +// The LLVM Compiler Infrastructure +// +// This file is distributed under the University of Illinois Open Source +// License. See LICENSE.TXT for details. +// +//===----------------------------------------------------------------------===// +// +/// \file +/// Defines the clang::CommentOptions interface. +// +//===----------------------------------------------------------------------===// + +#ifndef LLVM_CLANG_BASIC_COMMENTOPTIONS_H +#define LLVM_CLANG_BASIC_COMMENTOPTIONS_H + +#include <string> +#include <vector> + +namespace clang { + +/// Options for controlling comment parsing. +struct CommentOptions { + using BlockCommandNamesTy = std::vector<std::string>; + + /// Command names to treat as block commands in comments. + /// Should not include the leading backslash. + BlockCommandNamesTy BlockCommandNames; + + /// Treat ordinary comments as documentation comments. + bool ParseAllComments = false; + + CommentOptions() = default; +}; + +} // namespace clang + +#endif // LLVM_CLANG_BASIC_COMMENTOPTIONS_H |
