Note that a CXIndex cannot be destroyed until after all of its translation units...

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

diff --git a/include/clang-c/Index.h b/include/clang-c/Index.h
index d9b4b0906bed97db0c7c5872af5a51df593b400a..e5db52ea289ee0cd35ff6698b98c79a8e17584ec 100644 (file)
--- a/include/clang-c/Index.h
+++ b/include/clang-c/Index.h
@@ -171,6 +171,13 @@ CINDEX_LINKAGE void clang_disposeString(CXString string);
  * (which gives the indexer the same performance benefit as the compiler).
  */
 CINDEX_LINKAGE CXIndex clang_createIndex(int excludeDeclarationsFromPCH);
+  
+/**
+ * \brief Destroy the given index.
+ *
+ * The index must not be destroyed until all of the translation units created
+ * within that index have been destroyed.
+ */
 CINDEX_LINKAGE void clang_disposeIndex(CXIndex index);
 
 /**