luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-12-26 07:26:15 +01:00
Code Issues Packages Projects Releases Wiki Activity

Move version docs inline

Browse Source
This commit is contained in:
Matthias Clasen 2011-07-17 23:50:31 -04:00
parent 20cd4936b9
commit adc325fac0
4 changed files with 60 additions and 115 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/reference/glib/tmpl/.gitignore vendored
View File

@ -30,6 +30,7 @@ misc_utils.sgml
option.sgml option.sgml
patterns.sgml patterns.sgml
quarks.sgml quarks.sgml
queue.sgml
random_numbers.sgml random_numbers.sgml
relations.sgml relations.sgml
sequence.sgml sequence.sgml
@ -42,3 +43,4 @@ trees-binary.sgml
trees-nary.sgml trees-nary.sgml
timers.sgml timers.sgml
timezone.sgml timezone.sgml
version.sgml

115
docs/reference/glib/tmpl/version.sgml
View File

@ -1,115 +0,0 @@
<!-- ##### SECTION Title ##### -->
Version Information
<!-- ##### SECTION Short_Description ##### -->
Variables and functions to check the GLib version
<!-- ##### SECTION Long_Description ##### -->
<para>
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.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### SECTION Image ##### -->
<!-- ##### VARIABLE glib_major_version ##### -->
<para>
</para>
<!-- ##### VARIABLE glib_minor_version ##### -->
<para>
</para>
<!-- ##### VARIABLE glib_micro_version ##### -->
<para>
</para>
<!-- ##### VARIABLE glib_binary_age ##### -->
<para>
</para>
<!-- ##### VARIABLE glib_interface_age ##### -->
<para>
</para>
<!-- ##### FUNCTION glib_check_version ##### -->
<para>
</para>
@required_major:
@required_minor:
@required_micro:
@Returns:
<!-- ##### MACRO GLIB_MAJOR_VERSION ##### -->
<para>
The major version number of the GLib library.
Like #glib_major_version, but from the headers used at
application compile time, rather than from the library linked against
at application run time.
</para>
<!-- ##### MACRO GLIB_MINOR_VERSION ##### -->
<para>
The minor version number of the GLib library.
Like #gtk_minor_version, but from the headers used at
application compile time, rather than from the library linked against
at application run time.
</para>
<!-- ##### MACRO GLIB_MICRO_VERSION ##### -->
<para>
The micro version number of the GLib library.
Like #gtk_micro_version, but from the headers used at
application compile time, rather than from the library linked against
at application run time.
</para>
<!-- ##### MACRO GLIB_CHECK_VERSION ##### -->
<para>
Checks the version of the GLib library.
Returns %TRUE if the version of the GLib header files is the same
as or newer than the passed-in version.
<example>
<title>Checking the version of the GLib library</title>
<programlisting>
if (!GLIB_CHECK_VERSION (1, 2, 0))
g_error ("GLib version 1.2.0 or above is needed");
</programlisting>
</example>
</para>
@major: the major version number.
@minor: the minor version number.
@micro: the micro version number.

40
glib/gutils.c
View File

@ -28,6 +28,46 @@
* MT safe for the unix part, FIXME: make the win32 part MT safe as well. * MT safe for the unix part, FIXME: make the win32 part MT safe as well.
*/ */
/**
* SECTION:version
* @Title: Version Information
* @Short_description: Variables and functions to check the GLib version
*
* 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.
*/
/**
* GLIB_MAJOR_VERSION:
*
* The major version number of the GLib library.
*
* Like #glib_major_version, but from the headers used at
* application compile time, rather than from the library
* linked against at application run time.
*/
/**
* GLIB_MINOR_VERSION:
*
* The minor version number of the GLib library.
*
* Like #gtk_minor_version, but from the headers used at
* application compile time, rather than from the library
* linked against at application run time.
*/
/**
* GLIB_MICRO_VERSION:
*
* The micro version number of the GLib library.
*
* Like #gtk_micro_version, but from the headers used at
* application compile time, rather than from the library
* linked against at application run time.
*/
#include "config.h" #include "config.h"
#ifdef HAVE_UNISTD_H #ifdef HAVE_UNISTD_H

18
glib/gutils.h
View File

@ -446,6 +446,24 @@ const gchar * glib_check_version (guint required_major,
guint required_minor, guint required_minor,
guint required_micro); guint required_micro);
/**
* GLIB_CHECK_VERSION:
* @major: the major version to check for
* @minor: the minor version to check for
* @micro: the micro version to check for
*
* Checks the version of the GLib library.
* Returns %TRUE if the version of the GLib header files
* is the same as or newer than the passed-in version.
*
* <example>
* <title>Checking the version of the GLib library</title>
* <programlisting>
* if (!GLIB_CHECK_VERSION (1, 2, 0))
* g_error ("GLib version 1.2.0 or above is needed");
* </programlisting>
* </example>
*/
#define GLIB_CHECK_VERSION(major,minor,micro) \ #define GLIB_CHECK_VERSION(major,minor,micro) \
(GLIB_MAJOR_VERSION > (major) || \ (GLIB_MAJOR_VERSION > (major) || \
(GLIB_MAJOR_VERSION == (major) && GLIB_MINOR_VERSION > (minor)) || \ (GLIB_MAJOR_VERSION == (major) && GLIB_MINOR_VERSION > (minor)) || \