CommentOptions.h

Go to the documentation of this file.

//===- CommentOptions.h - Options for parsing comments ----------*- C++ -*-===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
//
/// \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;
 
  /// Force the front end to retain all documentation comments in the AST, even
  /// when no comment consuming diagnostic or language option is enabled. Tools
  /// that query comments after parsing set this.
  bool RetainComments = false;
 
  /// Retain documentation comments from system headers in the AST.
  bool RetainCommentsFromSystemHeaders = false;
 
  CommentOptions() = default;
};
 
} // namespace clang
 
#endif // LLVM_CLANG_BASIC_COMMENTOPTIONS_H