meta: document version information for libgit2
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38
diff --git a/include/git2/version.h b/include/git2/version.h
index ad36eb5..84af817 100644
--- a/include/git2/version.h
+++ b/include/git2/version.h
@@ -7,13 +7,33 @@
#ifndef INCLUDE_git_version_h__
#define INCLUDE_git_version_h__
+/**
+ * The version string for libgit2. This string follows semantic
+ * versioning (v2) guidelines.
+ */
#define LIBGIT2_VERSION "1.5.0-alpha"
+
+/** The major version number for this version of libgit2. */
#define LIBGIT2_VER_MAJOR 1
+
+/** The minor version number for this version of libgit2. */
#define LIBGIT2_VER_MINOR 5
+
+/** The revision ("teeny") version number for this version of libgit2. */
#define LIBGIT2_VER_REVISION 0
+
+/** The Windows DLL patch number for this version of libgit2. */
#define LIBGIT2_VER_PATCH 0
+
+/**
+ * The prerelease string for this version of libgit2. For development
+ * (nightly) builds, this will be "alpha". For prereleases, this will be
+ * a prerelease name like "beta" or "rc1". For final releases, this will
+ * be `NULL`.
+ */
#define LIBGIT2_VER_PRERELEASE "alpha"
+/** The library ABI soversion for this version of libgit2. */
#define LIBGIT2_SOVERSION "1.5"
#endif