1 //===- CommentOptions.h - Options for parsing comments ----------*- C++ -*-===//
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
7 //===----------------------------------------------------------------------===//
10 /// Defines the clang::CommentOptions interface.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_CLANG_BASIC_COMMENTOPTIONS_H
15 #define LLVM_CLANG_BASIC_COMMENTOPTIONS_H
22 /// Options for controlling comment parsing.
23 struct CommentOptions {
24 using BlockCommandNamesTy = std::vector<std::string>;
26 /// Command names to treat as block commands in comments.
27 /// Should not include the leading backslash.
28 BlockCommandNamesTy BlockCommandNames;
30 /// Treat ordinary comments as documentation comments.
31 bool ParseAllComments = false;
33 CommentOptions() = default;
38 #endif // LLVM_CLANG_BASIC_COMMENTOPTIONS_H