From: Douglas Gregor <dgregor@apple.com>
Date: Wed, 20 Jan 2010 01:10:47 +0000 (+0000)
Subject: Attempt to improve CIndex Doxygen organization, although I can't actually test this... 
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=20d416c36b46dd19ee0b1ea2d0266ae43be86e51;p=clang

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

git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@93961 91177308-0d34-0410-b5e6-96231b3b80d8
---

diff --git a/include/clang-c/Index.h b/include/clang-c/Index.h
index 00e47be2b7..e8dac25d6b 100644
--- a/include/clang-c/Index.h
+++ b/include/clang-c/Index.h
@@ -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