[glib: 1/2] gversion: Clarify that GLIB_CHECK_VERSION is a >= check




commit 8a498fa98919395aa54f182b814a8122b6dffbd4
Author: Philip Withnall <pwithnall endlessos org>
Date:   Mon Apr 25 15:20:16 2022 +0100

    gversion: Clarify that GLIB_CHECK_VERSION is a >= check
    
    The documentation body makes it sound like it might be a `==` check;
    only the ‘returns’ line previously clarified this.
    
    Signed-off-by: Philip Withnall <pwithnall endlessos org>

 glib/gversion.c | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)
---
diff --git a/glib/gversion.c b/glib/gversion.c
index 9b7765c8e4..cc29a67429 100644
--- a/glib/gversion.c
+++ b/glib/gversion.c
@@ -111,8 +111,10 @@
  * @minor: the minor version to check for
  * @micro: the micro version to check for
  *
- * Checks the version of the GLib library that is being compiled
- * against. See glib_check_version() for a runtime check.
+ * Checks whether the version of the GLib library that is being compiled
+ * against is greater than or equal to the given one.
+ *
+ * See glib_check_version() for a runtime check.
  *
  * Returns: %TRUE if the version of the GLib header files
  * is the same as or newer than the passed-in version.


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]