From ea0907abf938f787ebfc0c41f439d1e2b2ef98ba Mon Sep 17 00:00:00 2001 From: Khaled Hosny Date: Thu, 31 Dec 2020 02:34:45 +0200 Subject: [PATCH] [docs] Document version macros --- src/hb-version.h | 29 +++++++++++++++++++++++++++++ src/hb-version.h.in | 29 +++++++++++++++++++++++++++++ 2 files changed, 58 insertions(+) diff --git a/src/hb-version.h b/src/hb-version.h index da377b9df..30d0252b6 100644 --- a/src/hb-version.h +++ b/src/hb-version.h @@ -36,12 +36,41 @@ HB_BEGIN_DECLS +/** + * HB_VERSION_MAJOR: + * + * The major component of the library version available at compile-time. + */ #define HB_VERSION_MAJOR 2 +/** + * HB_VERSION_MINOR: + * + * The minor component of the library version available at compile-time. + */ #define HB_VERSION_MINOR 7 +/** + * HB_VERSION_MICRO: + * + * The micro component of the library version available at compile-time. + */ #define HB_VERSION_MICRO 4 +/** + * HB_VERSION_STRING: + * + * A string literal containing the library version available at compile-time. + */ #define HB_VERSION_STRING "2.7.4" +/** + * HB_VERSION_ATLEAST: + * @major: the major component of the version number + * @minor: the minor component of the version number + * @micro: the micro component of the version number + * + * Tests the library version at compile-time against a minimum value, + * as three integer components. + */ #define HB_VERSION_ATLEAST(major,minor,micro) \ ((major)*10000+(minor)*100+(micro) <= \ HB_VERSION_MAJOR*10000+HB_VERSION_MINOR*100+HB_VERSION_MICRO) diff --git a/src/hb-version.h.in b/src/hb-version.h.in index 0ffd889b2..d9c95eba7 100644 --- a/src/hb-version.h.in +++ b/src/hb-version.h.in @@ -36,12 +36,41 @@ HB_BEGIN_DECLS +/** + * HB_VERSION_MAJOR: + * + * The major component of the library version available at compile-time. + */ #define HB_VERSION_MAJOR @HB_VERSION_MAJOR@ +/** + * HB_VERSION_MINOR: + * + * The minor component of the library version available at compile-time. + */ #define HB_VERSION_MINOR @HB_VERSION_MINOR@ +/** + * HB_VERSION_MICRO: + * + * The micro component of the library version available at compile-time. + */ #define HB_VERSION_MICRO @HB_VERSION_MICRO@ +/** + * HB_VERSION_STRING: + * + * A string literal containing the library version available at compile-time. + */ #define HB_VERSION_STRING "@HB_VERSION@" +/** + * HB_VERSION_ATLEAST: + * @major: the major component of the version number + * @minor: the minor component of the version number + * @micro: the micro component of the version number + * + * Tests the library version at compile-time against a minimum value, + * as three integer components. + */ #define HB_VERSION_ATLEAST(major,minor,micro) \ ((major)*10000+(minor)*100+(micro) <= \ HB_VERSION_MAJOR*10000+HB_VERSION_MINOR*100+HB_VERSION_MICRO)