luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-09-20 09:16:15 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: Annotate glib_check_version()

Browse Source 
Add introspection annotations.

Reduce the indentation for the return value documentation string.

Use the appropriate gtk-doc syntax for symbols.
This commit is contained in:
Emmanuele Bassi 2021-08-02 14:52:06 +01:00
parent 6081e92daf
commit 2aedaf293b
1 changed files with 13 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
glib/gversion.c
View File

@ -151,24 +151,25 @@ const guint glib_binary_age = GLIB_BINARY_AGE;
* @required_micro: the required micro version * @required_micro: the required micro version
* *
* Checks that the GLib library in use is compatible with the * Checks that the GLib library in use is compatible with the
* given version. Generally you would pass in the constants * given version.
* #GLIB_MAJOR_VERSION, #GLIB_MINOR_VERSION, #GLIB_MICRO_VERSION *
* as the three arguments to this function; that produces * Generally you would pass in the constants %GLIB_MAJOR_VERSION,
* a check that the library in use is compatible with * %GLIB_MINOR_VERSION, %GLIB_MICRO_VERSION as the three arguments
* the version of GLib the application or module was compiled * to this function; that produces a check that the library in use
* against. * is compatible with the version of GLib the application or module
* was compiled against.
* *
* Compatibility is defined by two things: first the version * Compatibility is defined by two things: first the version
* of the running library is newer than 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 * 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.) * (same major version.)
* *
* Returns: %NULL if the GLib library is compatible with the * Returns: (transfer none) (nullable): %NULL if the GLib library is
* given version, or a string describing the version mismatch. * compatible with the given version, or a string describing the
* The returned string is owned by GLib and must not be modified * version mismatch. The returned string is owned by GLib and must
* or freed. * not be modified or freed.
* *
* Since: 2.6 * Since: 2.6
*/ */