contrib/llvm/tools/clang/include/clang/Index/CommentToXML.h

   1 //===--- CommentToXML.h - Convert comments to XML representation ----------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9
  10 #ifndef LLVM_CLANG_INDEX_COMMENTTOXML_H
  11 #define LLVM_CLANG_INDEX_COMMENTTOXML_H
  12
  13 #include "clang/Basic/LLVM.h"
  14 #include <memory>
  15
  16 namespace clang {
  17 class ASTContext;
  18
  19 namespace comments {
  20 class FullComment;
  21 class HTMLTagComment;
  22 }
  23
  24 namespace index {
  25 class CommentToXMLConverter {
  26 public:
  27   CommentToXMLConverter();
  28   ~CommentToXMLConverter();
  29
  30   void convertCommentToHTML(const comments::FullComment *FC,
  31                             SmallVectorImpl<char> &HTML,
  32                             const ASTContext &Context);
  33
  34   void convertHTMLTagNodeToText(const comments::HTMLTagComment *HTC,
  35                                 SmallVectorImpl<char> &Text,
  36                                 const ASTContext &Context);
  37
  38   void convertCommentToXML(const comments::FullComment *FC,
  39                            SmallVectorImpl<char> &XML,
  40                            const ASTContext &Context);
  41 };
  42
  43 } // namespace index
  44 } // namespace clang
  45
  46 #endif // LLVM_CLANG_INDEX_COMMENTTOXML_H
  47