[glib/docgen-fixes: 10/15] docs: Annotate glib_check_version()




commit 2aedaf293b24abca2b9ce152c149f7fb3b633c63
Author: Emmanuele Bassi <ebassi gnome org>
Date:   Mon Aug 2 14:52:06 2021 +0100

    docs: Annotate glib_check_version()
    
    Add introspection annotations.
    
    Reduce the indentation for the return value documentation string.
    
    Use the appropriate gtk-doc syntax for symbols.

 glib/gversion.c | 25 +++++++++++++------------
 1 file changed, 13 insertions(+), 12 deletions(-)
---
diff --git a/glib/gversion.c b/glib/gversion.c
index 02acb7d8e..9b7765c8e 100644
--- a/glib/gversion.c
+++ b/glib/gversion.c
@@ -151,24 +151,25 @@ const guint glib_binary_age = GLIB_BINARY_AGE;
  * @required_micro: the required micro version
  *
  * Checks that the GLib library in use is compatible with the
- * given version. Generally you would pass in the constants
- * #GLIB_MAJOR_VERSION, #GLIB_MINOR_VERSION, #GLIB_MICRO_VERSION
- * as the three arguments to this function; that produces
- * a check that the library in use is compatible with
- * the version of GLib the application or module was compiled
- * against.
+ * given version.
+ *
+ * Generally you would pass in the constants %GLIB_MAJOR_VERSION,
+ * %GLIB_MINOR_VERSION, %GLIB_MICRO_VERSION as the three arguments
+ * to this function; that produces a check that the library in use
+ * is compatible with the version of GLib the application or module
+ * was compiled against.
  *
  * Compatibility is defined by two things: first the version
  * of the running library is newer than the version
- * @required_major.required_minor.@required_micro. Second
+ * `@required_major.required_minor.@required_micro`. Second
  * the running library must be binary compatible with the
- * version @required_major.required_minor.@required_micro
+ * version `@required_major.@required_minor.@required_micro`
  * (same major version.)
  *
- * Returns: %NULL if the GLib library is compatible with the
- *     given version, or a string describing the version mismatch.
- *     The returned string is owned by GLib and must not be modified
- *     or freed.
+ * Returns: (transfer none) (nullable): %NULL if the GLib library is
+ *   compatible with the given version, or a string describing the
+ *   version mismatch. The returned string is owned by GLib and must
+ *   not be modified or freed.
  *
  * Since: 2.6
  */


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