CommentToXML.h

Go to the documentation of this file.

//===--- CommentToXML.h - Convert comments to XML representation ----------===//
//
// 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
//
//===----------------------------------------------------------------------===//
 
#ifndef LLVM_CLANG_INDEX_COMMENTTOXML_H
#define LLVM_CLANG_INDEX_COMMENTTOXML_H
 
#include "clang/Basic/LLVM.h"
 
namespace clang {
class ASTContext;
 
namespace comments {
class FullComment;
class HTMLTagComment;
}
 
namespace index {
class CommentToXMLConverter {
public:
  CommentToXMLConverter();
  ~CommentToXMLConverter();
 
  void convertCommentToHTML(const comments::FullComment *FC,
                            SmallVectorImpl<char> &HTML,
                            const ASTContext &Context);
 
  void convertHTMLTagNodeToText(const comments::HTMLTagComment *HTC,
                                SmallVectorImpl<char> &Text,
                                const ASTContext &Context);
 
  void convertCommentToXML(const comments::FullComment *FC,
                           SmallVectorImpl<char> &XML,
                           const ASTContext &Context);
};
 
} // namespace index
} // namespace clang
 
#endif // LLVM_CLANG_INDEX_COMMENTTOXML_H