[docs] Document version macros

This commit is contained in:
Khaled Hosny 2020-12-31 02:34:45 +02:00 committed by Behdad Esfahbod
parent 5e9f05ff3f
commit ea0907abf9
2 changed files with 58 additions and 0 deletions

View File

@ -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)

View File

@ -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)