clang
3.7.0
Main Page
Related Pages
Modules
Namespaces
Classes
Files
File List
File Members
work
release_test
rc4
llvm.src
tools
clang
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
SimpleFormatContext
;
26
27
class
CommentToXMLConverter
{
28
std::unique_ptr<SimpleFormatContext> FormatContext;
29
unsigned
FormatInMemoryUniqueId;
30
31
public
:
32
CommentToXMLConverter
();
33
~CommentToXMLConverter
();
34
35
void
convertCommentToHTML
(
const
comments::FullComment
*FC,
36
SmallVectorImpl<char>
&HTML,
37
const
ASTContext
&
Context
);
38
39
void
convertHTMLTagNodeToText
(
const
comments::HTMLTagComment
*HTC,
40
SmallVectorImpl<char>
&Text,
41
const
ASTContext
&Context);
42
43
void
convertCommentToXML
(
const
comments::FullComment
*FC,
44
SmallVectorImpl<char>
&XML,
45
const
ASTContext
&Context);
46
};
47
48
}
// namespace index
49
}
// namespace clang
50
51
#endif // LLVM_CLANG_INDEX_COMMENTTOXML_H
52
clang::index::CommentToXMLConverter::~CommentToXMLConverter
~CommentToXMLConverter()
Definition:
CommentToXML.cpp:1134
clang::index::SimpleFormatContext
A small class to be used by libclang clients to format a declaration string in memory. This object is instantiated once and used each time a formatting is needed.
Definition:
SimpleFormatContext.h:35
clang::ASTContext
Holds long-lived AST nodes (such as types and decls) that can be referred to throughout the semantic ...
Definition:
ASTContext.h:89
llvm::SmallVectorImpl
Definition:
LLVM.h:35
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:1136
Context
ASTContext * Context
Definition:
ASTMatchFinder.cpp:707
clang::index::CommentToXMLConverter::convertHTMLTagNodeToText
void convertHTMLTagNodeToText(const comments::HTMLTagComment *HTC, SmallVectorImpl< char > &Text, const ASTContext &Context)
Definition:
CommentToXML.cpp:1144
clang::comments::HTMLTagComment
Definition:
Comment.h:377
clang::index::CommentToXMLConverter::CommentToXMLConverter
CommentToXMLConverter()
Definition:
CommentToXML.cpp:1133
clang::index::CommentToXMLConverter
Definition:
CommentToXML.h:27
clang::index::CommentToXMLConverter::convertCommentToXML
void convertCommentToXML(const comments::FullComment *FC, SmallVectorImpl< char > &XML, const ASTContext &Context)
Definition:
CommentToXML.cpp:1152
clang::comments::FullComment
A full comment attached to a declaration, contains block content.
Definition:
Comment.h:1097
Generated on Mon Aug 31 2015 10:45:14 for clang by
1.8.6