clang/Index/CommentToXML.h

0001 //===--- CommentToXML.h - Convert comments to XML representation ----------===//
0002 //
0003 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
0004 // See https://llvm.org/LICENSE.txt for license information.
0005 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
0006 //
0007 //===----------------------------------------------------------------------===//
0008
0009 #ifndef LLVM_CLANG_INDEX_COMMENTTOXML_H
0010 #define LLVM_CLANG_INDEX_COMMENTTOXML_H
0011
0012 #include "clang/Basic/LLVM.h"
0013
0014 namespace clang {
0015 class ASTContext;
0016
0017 namespace comments {
0018 class FullComment;
0019 class HTMLTagComment;
0020 }
0021
0022 namespace index {
0023 class CommentToXMLConverter {
0024 public:
0025   CommentToXMLConverter();
0026   ~CommentToXMLConverter();
0027
0028   void convertCommentToHTML(const comments::FullComment *FC,
0029                             SmallVectorImpl<char> &HTML,
0030                             const ASTContext &Context);
0031
0032   void convertHTMLTagNodeToText(const comments::HTMLTagComment *HTC,
0033                                 SmallVectorImpl<char> &Text,
0034                                 const ASTContext &Context);
0035
0036   void convertCommentToXML(const comments::FullComment *FC,
0037                            SmallVectorImpl<char> &XML,
0038                            const ASTContext &Context);
0039 };
0040
0041 } // namespace index
0042 } // namespace clang
0043
0044 #endif // LLVM_CLANG_INDEX_COMMENTTOXML_H
0045