[cfe-commits] r93961 - /cfe/trunk/include/clang-c/Index.h

[Douglas Gregor]

Author: dgregor
Date: Tue Jan 19 19:10:47 2010
New Revision: 93961

URL: http://llvm.org/viewvc/llvm-project?rev=93961&view=rev
Log:
Attempt to improve CIndex Doxygen organization, although I can't actually test this locally

Modified:
    cfe/trunk/include/clang-c/Index.h

Modified: cfe/trunk/include/clang-c/Index.h
URL: http://llvm.org/viewvc/llvm-project/cfe/trunk/include/clang-c/Index.h?rev=93961&r1=93960&r2=93961&view=diff

==============================================================================
--- cfe/trunk/include/clang-c/Index.h (original)
+++ cfe/trunk/include/clang-c/Index.h Tue Jan 19 19:10:47 2010
@@ -34,15 +34,21 @@
   #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 @@
 CINDEX_LINKAGE 
 void clang_disposeCodeCompleteResults(CXCodeCompleteResults *Results);
   
+/**
+ * @}
+ */
 #ifdef __cplusplus
 }
 #endif