Add flexible API version boundaries

[platform/upstream/glib.git] / glib / gversion.c

diff --git a/glib/gversion.c b/glib/gversion.c
index d80e262..70650b3 100644 (file)
--- a/glib/gversion.c
+++ b/glib/gversion.c
@@ -36,6 +36,18 @@
  * GLib provides version information, primarily useful in configure
  * checks for builds that have a configure script. Applications will
  * not typically use the features described here.
+ *
+ * The GLib headers annotate deprecated APIs in a way that produces
+ * compiler warnings if these deprecated APIs are used. The warnings
+ * can be turned off by defining the macro %GLIB_DISABLE_DEPRECATION_WARNINGS
+ * before including the glib.h header.
+ *
+ * GLib also provides support for building applications against
+ * defined subsets of deprecated or new GLib APIs. Define the macro
+ * %GLIB_VERSION_MIN_REQUIRED to specify up to what version of GLib
+ * you want to receive warnings about deprecated APIs. Define the
+ * macro %GLIB_VERSION_MAX_ALLOWED to specify the newest version of
+ * GLib whose API you want to use.
  */
 
 /**