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

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

1 files changed, 7 insertions, 0 deletions

diff --git a/include/clang-c/Index.h b/include/clang-c/Index.h
index d9b4b0906b..e5db52ea28 100644
--- 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);
 
 /**