clang/Basic/CommentOptions.h

0001 //===- CommentOptions.h - Options for parsing comments ----------*- C++ -*-===//
0002 //
0003 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
0004 // See https://llvm.org/LICENSE.txt for license information.
0005 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
0006 //
0007 //===----------------------------------------------------------------------===//
0008 //
0009 /// \file
0010 /// Defines the clang::CommentOptions interface.
0011 //
0012 //===----------------------------------------------------------------------===//
0013
0014 #ifndef LLVM_CLANG_BASIC_COMMENTOPTIONS_H
0015 #define LLVM_CLANG_BASIC_COMMENTOPTIONS_H
0016
0017 #include <string>
0018 #include <vector>
0019
0020 namespace clang {
0021
0022 /// Options for controlling comment parsing.
0023 struct CommentOptions {
0024   using BlockCommandNamesTy = std::vector<std::string>;
0025
0026   /// Command names to treat as block commands in comments.
0027   /// Should not include the leading backslash.
0028   BlockCommandNamesTy BlockCommandNames;
0029
0030   /// Treat ordinary comments as documentation comments.
0031   bool ParseAllComments = false;
0032
0033   CommentOptions() = default;
0034 };
0035
0036 } // namespace clang
0037
0038 #endif // LLVM_CLANG_BASIC_COMMENTOPTIONS_H