1//===- CommentOptions.h - Options for parsing comments ----------*- C++ -*-===//
2//
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
6//
7//===----------------------------------------------------------------------===//
8//
9/// \file
10/// Defines the clang::CommentOptions interface.
11//
12//===----------------------------------------------------------------------===//
13
14#ifndef LLVM_CLANG_BASIC_COMMENTOPTIONS_H
15#define LLVM_CLANG_BASIC_COMMENTOPTIONS_H
16
17#include <string>
18#include <vector>
19
20namespace clang {
21
22/// Options for controlling comment parsing.
23struct CommentOptions {
24 using BlockCommandNamesTy = std::vector<std::string>;
25
26 /// Command names to treat as block commands in comments.
27 /// Should not include the leading backslash.
28 BlockCommandNamesTy BlockCommandNames;
29
30 /// Treat ordinary comments as documentation comments.
31 bool ParseAllComments = false;
32
33 CommentOptions() = default;
34};
35
36} // namespace clang
37
38#endif // LLVM_CLANG_BASIC_COMMENTOPTIONS_H
39