clang API Documentation
00001 //===--- CommentOptions.h - Options for parsing comments -----*- C++ -*-===// 00002 // 00003 // The LLVM Compiler Infrastructure 00004 // 00005 // This file is distributed under the University of Illinois Open Source 00006 // License. See LICENSE.TXT for details. 00007 // 00008 //===----------------------------------------------------------------------===// 00009 /// 00010 /// \file 00011 /// \brief Defines the clang::CommentOptions interface. 00012 /// 00013 //===----------------------------------------------------------------------===// 00014 00015 #ifndef LLVM_CLANG_BASIC_COMMENTOPTIONS_H 00016 #define LLVM_CLANG_BASIC_COMMENTOPTIONS_H 00017 00018 #include <string> 00019 #include <vector> 00020 00021 namespace clang { 00022 00023 /// \brief Options for controlling comment parsing. 00024 struct CommentOptions { 00025 typedef std::vector<std::string> BlockCommandNamesTy; 00026 00027 /// \brief Command names to treat as block commands in comments. 00028 /// Should not include the leading backslash. 00029 BlockCommandNamesTy BlockCommandNames; 00030 00031 /// \brief Treat ordinary comments as documentation comments. 00032 bool ParseAllComments; 00033 00034 CommentOptions() : ParseAllComments(false) { } 00035 }; 00036 00037 } // end namespace clang 00038 00039 #endif