Move version docs inline

diff --git a/docs/reference/glib/tmpl/.gitignore b/docs/reference/glib/tmpl/.gitignore
index 2d9b777..eb37d58 100644 (file)
--- a/docs/reference/glib/tmpl/.gitignore
+++ b/docs/reference/glib/tmpl/.gitignore
@@ -30,6 +30,7 @@ misc_utils.sgml
 option.sgml
 patterns.sgml
 quarks.sgml
 option.sgml
 patterns.sgml
 quarks.sgml

+queue.sgml

 random_numbers.sgml
 relations.sgml
 sequence.sgml
 random_numbers.sgml
 relations.sgml
 sequence.sgml


@@ -42,3 +43,4 @@ trees-binary.sgml
 trees-nary.sgml
 timers.sgml
 timezone.sgml
 trees-nary.sgml
 timers.sgml
 timezone.sgml

+version.sgml

diff --git a/docs/reference/glib/tmpl/version.sgml b/docs/reference/glib/tmpl/version.sgml
deleted file mode 100644 (file)
index 027a0f4..0000000
--- a/docs/reference/glib/tmpl/version.sgml
+++ /dev/null
@@ -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.
-
-

diff --git a/glib/gutils.c b/glib/gutils.c
index a487257..de7f41e 100644 (file)
--- a/glib/gutils.c
+++ b/glib/gutils.c
@@ -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"
 
 #ifdef HAVE_UNISTD_H
 #include "config.h"
 
 #ifdef HAVE_UNISTD_H

diff --git a/glib/gutils.h b/glib/gutils.h
index a070971..a082903 100644 (file)
--- a/glib/gutils.h
+++ b/glib/gutils.h
@@ -446,6 +446,24 @@ const gchar * glib_check_version (guint required_major,
                                   guint required_minor,
                                   guint required_micro);
 
                                   guint required_minor,
                                   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)    \
     (GLIB_MAJOR_VERSION > (major) || \
      (GLIB_MAJOR_VERSION == (major) && GLIB_MINOR_VERSION > (minor)) || \
 #define GLIB_CHECK_VERSION(major,minor,micro)    \
     (GLIB_MAJOR_VERSION > (major) || \
      (GLIB_MAJOR_VERSION == (major) && GLIB_MINOR_VERSION > (minor)) || \