clang 8.0.0

CommentToXML.h
Go to the documentation of this file.
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
clang::ASTContext
Holds long-lived AST nodes (such as types and decls) that can be referred to throughout the semantic ...
Definition: ASTContext.h:155
llvm::SmallVectorImpl
Definition: LLVM.h:37
LLVM.h
Forward-declares and imports various common LLVM datatypes that clang wants to use unqualified...
clang
Dataflow Directional Tag Classes.
Definition: CFGReachabilityAnalysis.h:22
clang::comments::HTMLTagComment
Abstract class for opening and closing HTML tags.
Definition: Comment.h:372
Text
StringRef Text
Definition: Format.cpp:1630
clang::index::CommentToXMLConverter
Definition: CommentToXML.h:25
clang::comments::FullComment
A full comment attached to a declaration, contains block content.
Definition: Comment.h:1092