Merge branch 'version-macro-docs' into 'master'

docs: Add documentation for GLIB_VERSION_CUR_STABLE and PREV_STABLE

See merge request GNOME/glib!1888
This commit is contained in:
Emmanuele Bassi 2021-01-19 16:05:29 +00:00
commit 9d40b0ceb9
2 changed files with 23 additions and 3 deletions

View File

@ -138,6 +138,8 @@ GLIB_VERSION_2_62
GLIB_VERSION_2_64 GLIB_VERSION_2_64
GLIB_VERSION_2_66 GLIB_VERSION_2_66
GLIB_VERSION_2_68 GLIB_VERSION_2_68
GLIB_VERSION_CUR_STABLE
GLIB_VERSION_PREV_STABLE
GLIB_VERSION_MIN_REQUIRED GLIB_VERSION_MIN_REQUIRED
GLIB_VERSION_MAX_ALLOWED GLIB_VERSION_MAX_ALLOWED
GLIB_DISABLE_DEPRECATION_WARNINGS GLIB_DISABLE_DEPRECATION_WARNINGS

View File

@ -255,8 +255,16 @@
*/ */
#define GLIB_VERSION_2_68 (G_ENCODE_VERSION (2, 68)) #define GLIB_VERSION_2_68 (G_ENCODE_VERSION (2, 68))
/* evaluates to the current stable version; for development cycles, /**
* this means the next stable target * GLIB_VERSION_CUR_STABLE:
*
* A macro that evaluates to the current stable version of GLib, in a format
* that can be used by the C pre-processor.
*
* During an unstable development cycle, this evaluates to the next stable
* (unreleased) version which will be the result of the development cycle.
*
* Since: 2.32
*/ */
#if (GLIB_MINOR_VERSION % 2) #if (GLIB_MINOR_VERSION % 2)
#define GLIB_VERSION_CUR_STABLE (G_ENCODE_VERSION (GLIB_MAJOR_VERSION, GLIB_MINOR_VERSION + 1)) #define GLIB_VERSION_CUR_STABLE (G_ENCODE_VERSION (GLIB_MAJOR_VERSION, GLIB_MINOR_VERSION + 1))
@ -264,7 +272,17 @@
#define GLIB_VERSION_CUR_STABLE (G_ENCODE_VERSION (GLIB_MAJOR_VERSION, GLIB_MINOR_VERSION)) #define GLIB_VERSION_CUR_STABLE (G_ENCODE_VERSION (GLIB_MAJOR_VERSION, GLIB_MINOR_VERSION))
#endif #endif
/* evaluates to the previous stable version */ /**
* GLIB_VERSION_PREV_STABLE:
*
* A macro that evaluates to the previous stable version of GLib, in a format
* that can be used by the C pre-processor.
*
* During an unstable development cycle, this evaluates to the most recent
* released stable release, which preceded this development cycle.
*
* Since: 2.32
*/
#if (GLIB_MINOR_VERSION % 2) #if (GLIB_MINOR_VERSION % 2)
#define GLIB_VERSION_PREV_STABLE (G_ENCODE_VERSION (GLIB_MAJOR_VERSION, GLIB_MINOR_VERSION - 1)) #define GLIB_VERSION_PREV_STABLE (G_ENCODE_VERSION (GLIB_MAJOR_VERSION, GLIB_MINOR_VERSION - 1))
#else #else