clang
5.0.0
Main Page
Related Pages
Modules
Namespaces
Classes
Files
File List
File Members
include
clang
Index
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::index::CommentToXMLConverter::~CommentToXMLConverter
~CommentToXMLConverter()
Definition:
CommentToXML.cpp:1119
clang::ASTContext
Holds long-lived AST nodes (such as types and decls) that can be referred to throughout the semantic ...
Definition:
ASTContext.h:128
llvm::SmallVectorImpl
Definition:
LLVM.h:36
LLVM.h
Forward-declares and imports various common LLVM datatypes that clang wants to use unqualified...
clang::index::CommentToXMLConverter::convertCommentToHTML
void convertCommentToHTML(const comments::FullComment *FC, SmallVectorImpl< char > &HTML, const ASTContext &Context)
Definition:
CommentToXML.cpp:1121
Context
ASTContext * Context
Definition:
ASTMatchFinder.cpp:727
clang::index::CommentToXMLConverter::convertHTMLTagNodeToText
void convertHTMLTagNodeToText(const comments::HTMLTagComment *HTC, SmallVectorImpl< char > &Text, const ASTContext &Context)
Definition:
CommentToXML.cpp:1129
clang::comments::HTMLTagComment
Abstract class for opening and closing HTML tags.
Definition:
Comment.h:377
Text
StringRef Text
Definition:
Format.cpp:1302
clang::index::CommentToXMLConverter::CommentToXMLConverter
CommentToXMLConverter()
Definition:
CommentToXML.cpp:1118
clang::index::CommentToXMLConverter
Definition:
CommentToXML.h:25
clang::index::CommentToXMLConverter::convertCommentToXML
void convertCommentToXML(const comments::FullComment *FC, SmallVectorImpl< char > &XML, const ASTContext &Context)
Definition:
CommentToXML.cpp:1137
clang::comments::FullComment
A full comment attached to a declaration, contains block content.
Definition:
Comment.h:1097
Generated on Tue Sep 5 2017 11:45:12 for clang by
1.8.6