1249261Sdim//===--- CommentOptions.h - Options for parsing comments -----*- C++ -*-===// 2249261Sdim// 3249261Sdim// The LLVM Compiler Infrastructure 4249261Sdim// 5249261Sdim// This file is distributed under the University of Illinois Open Source 6249261Sdim// License. See LICENSE.TXT for details. 7249261Sdim// 8249261Sdim//===----------------------------------------------------------------------===// 9249261Sdim/// 10249261Sdim/// \file 11249261Sdim/// \brief Defines the clang::CommentOptions interface. 12249261Sdim/// 13249261Sdim//===----------------------------------------------------------------------===// 14249261Sdim 15249261Sdim#ifndef LLVM_CLANG_COMMENTOPTIONS_H 16249261Sdim#define LLVM_CLANG_COMMENTOPTIONS_H 17249261Sdim 18249261Sdim#include <string> 19249261Sdim#include <vector> 20249261Sdim 21249261Sdimnamespace clang { 22249261Sdim 23249261Sdim/// \brief Options for controlling comment parsing. 24249261Sdimstruct CommentOptions { 25249261Sdim typedef std::vector<std::string> BlockCommandNamesTy; 26249261Sdim 27249261Sdim /// \brief Command names to treat as block commands in comments. 28249261Sdim /// Should not include the leading backslash. 29249261Sdim BlockCommandNamesTy BlockCommandNames; 30252723Sdim 31252723Sdim /// \brief Treat ordinary comments as documentation comments. 32252723Sdim bool ParseAllComments; 33252723Sdim 34252723Sdim CommentOptions() : ParseAllComments(false) { } 35249261Sdim}; 36249261Sdim 37249261Sdim} // end namespace clang 38249261Sdim 39249261Sdim#endif 40