From: Argyrios Kyrtzidis <akyrtzi@gmail.com>
Date: Tue, 6 Nov 2012 21:21:49 +0000 (+0000)
Subject: [libclang] Add some comments about the version constants for the libclang API.
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=4d9eff53c49a2c1b9b460b899c95dcdbb3e056e1;p=clang

[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
---

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