[libclang] Add some comments about the version constants for the libclang API.

llvm-svn: 167489

diff --git a/clang/include/clang-c/Index.h b/clang/include/clang-c/Index.h
index 2b52c0c..aa3403c 100644 (file)
--- a/clang/include/clang-c/Index.h
+++ b/clang/include/clang-c/Index.h
@@ -23,6 +23,14 @@
 #include "clang-c/Platform.h"
 #include "clang-c/CXString.h"
 
+/**
+ * \brief The version constants for the libclang API.
+ * CINDEX_VERSION_MINOR should increase when there are API additions.
+ * CINDEX_VERSION_MAJOR is intended for "major" source/ABI breaking changes.
+ *
+ * The policy about the libclang API was always to keep it source and ABI
+ * compatible, thus CINDEX_VERSION_MAJOR is expected to remain stable.
+ */
 #define CINDEX_VERSION_MAJOR 0
 #define CINDEX_VERSION_MINOR 6