aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorArgyrios Kyrtzidis <akyrtzi@gmail.com>2012-11-06 21:21:49 +0000
committerArgyrios Kyrtzidis <akyrtzi@gmail.com>2012-11-06 21:21:49 +0000
commit4d9eff53c49a2c1b9b460b899c95dcdbb3e056e1 (patch)
treeec558619463529abcbd92b87a5d8ee09eaf2995b
parent1307120129bd084378f1c22611402ae24c7bebb2 (diff)
[libclang] Add some comments about the version constants for the libclang API.
git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@167489 91177308-0d34-0410-b5e6-96231b3b80d8
-rw-r--r--include/clang-c/Index.h8
1 files changed, 8 insertions, 0 deletions
diff --git a/include/clang-c/Index.h b/include/clang-c/Index.h
index 2b52c0c89c..aa3403cc80 100644
--- a/include/clang-c/Index.h
+++ b/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