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

[Argyrios Kyrtzidis]

Author: akirtzidis
Date: Tue Nov  6 15:21:49 2012
New Revision: 167489

URL: http://llvm.org/viewvc/llvm-project?rev=167489&view=rev
Log:
[libclang] Add some comments about the version constants for the libclang API.

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=167489&r1=167488&r2=167489&view=diff
==============================================================================
--- cfe/trunk/include/clang-c/Index.h (original)
+++ cfe/trunk/include/clang-c/Index.h Tue Nov  6 15:21:49 2012
@@ -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