Attempt to improve CIndex Doxygen organization, although I can't actually test this locally

llvm-svn: 93961
This commit is contained in:
Douglas Gregor 2010-01-20 01:10:47 +00:00
parent 3b2a68ceb8
commit 52606ff2ca
1 changed files with 18 additions and 9 deletions

View File

@ -34,15 +34,21 @@ extern "C" {
#define CINDEX_LINKAGE
#endif
/*
Clang indeX abstractions. The backing store for the following API's will be
clangs AST file (currently based on PCH). AST files are created as follows:
"clang -emit-ast <sourcefile.langsuffix> -o <sourcefile.ast>".
Naming Conventions: To avoid namespace pollution, data types are prefixed
with "CX" and functions are prefixed with "clang_".
*/
/** \defgroup CINDEX C Interface to Clang
*
* Clang indeX abstractions. The backing store for the following
* API's will be clangs AST file (currently based on PCH). AST files
* are created as follows:
*
* \code
* clang -emit-ast <sourcefile.langsuffix> -o <sourcefile.ast>".
* \endcode
*
* Naming Conventions: To avoid namespace pollution, data types are
* prefixed with "CX" and functions are prefixed with "clang_".
*
* @{
*/
typedef void *CXIndex; /* An indexing instance. */
typedef void *CXTranslationUnit; /* A translation unit instance. */
@ -960,6 +966,9 @@ CXCodeCompleteResults *clang_codeComplete(CXIndex CIdx,
CINDEX_LINKAGE
void clang_disposeCodeCompleteResults(CXCodeCompleteResults *Results);
/**
* @}
*/
#ifdef __cplusplus
}
#endif