Make 3.0 parallel-installable to 2.x

[~andy/gtk] / docs / reference / gtk / tmpl / gtkfeatures.sgml

diff --git a/docs/reference/gtk/tmpl/gtkfeatures.sgml b/docs/reference/gtk/tmpl/gtkfeatures.sgml
index bf85207886952ba3a4fc1b0cc8ab1aca9ace5915..16e0adddc54ad479b5a97b24659e34f5c8006d67 100644 (file)
--- a/docs/reference/gtk/tmpl/gtkfeatures.sgml
+++ b/docs/reference/gtk/tmpl/gtkfeatures.sgml
@@ -1,12 +1,14 @@
 <!-- ##### SECTION Title ##### -->
-Feature Test Macros
+Version Information
 
 <!-- ##### SECTION Short_Description ##### -->
-
+Variables and functions to check the GTK+ version
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
-
+GTK+ 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 ##### -->
@@ -14,39 +16,72 @@ Feature Test Macros
 
 </para>
 
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### SECTION Image ##### -->
+
+
 <!-- ##### VARIABLE gtk_major_version ##### -->
 <para>
+The major version number of the GTK+ library.  (e.g. in GTK+ version
+1.2.5 this is 1.) 
+</para>
 
+<para>
+This variable is in the library, so represents the
+GTK+ library you have linked against. Contrast with the
+#GTK_MAJOR_VERSION macro, which represents the major version of the
+GTK+ headers you have included.
 </para>
 
 
 <!-- ##### VARIABLE gtk_minor_version ##### -->
 <para>
+The minor version number of the GTK+ library.
+(e.g. in GTK+ version 1.2.5 this is 2.)
+</para>
 
+<para>
+This variable is in the library, so represents the
+GTK+ library you have linked against. Contrast with the
+#GTK_MINOR_VERSION macro, which represents the minor version of the
+GTK+ headers you have included.
 </para>
 
 
 <!-- ##### VARIABLE gtk_micro_version ##### -->
 <para>
+The micro version number of the GTK+ library.
+(e.g. in GTK+ version 1.2.5 this is 5.)
+</para>
+
 
+<para>
+This variable is in the library, so represents the GTK+ library you
+have linked against. Contrast with the #GTK_MICRO_VERSION macro, which
+represents the micro version of the GTK+ headers you have included.
 </para>
 
 
 <!-- ##### VARIABLE gtk_binary_age ##### -->
 <para>
-
+This is the binary age passed to <application>libtool</application>. If 
+<application>libtool</application> means nothing to you, don't worry 
+about it. ;-)
 </para>
 
 
 <!-- ##### VARIABLE gtk_interface_age ##### -->
 <para>
-
+This is the interface age passed to <application>libtool</application>. If 
+<application>libtool</application> means nothing to you, don't worry 
+about it. ;-)
 </para>
 
 
 <!-- ##### FUNCTION gtk_check_version ##### -->
 <para>
-
 </para>
 
 @required_major: 
@@ -55,3 +90,59 @@ Feature Test Macros
 @Returns: 
 
 
+<!-- ##### MACRO GTK_MAJOR_VERSION ##### -->
+<para>
+Like #gtk_major_version, but from the headers used at
+application compile time, rather than from the library linked against
+at application run time.
+</para>
+
+
+
+<!-- ##### MACRO GTK_MINOR_VERSION ##### -->
+<para>
+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 GTK_MICRO_VERSION ##### -->
+<para>
+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 GTK_BINARY_AGE ##### -->
+<para>
+Like #gtk_binary_age, but from the headers used at
+application compile time, rather than from the library linked against
+at application run time.
+</para>
+
+
+
+<!-- ##### MACRO GTK_INTERFACE_AGE ##### -->
+<para>
+Like #gtk_interface_age, but from the headers used at
+application compile time, rather than from the library linked against
+at application run time.
+</para>
+
+
+
+<!-- ##### MACRO GTK_CHECK_VERSION ##### -->
+<para>
+Returns %TRUE if the version of the GTK+ header files is the same 
+as or newer than the passed-in version.
+</para>
+
+@major: major version (e.g. 1 for version 1.2.5)
+@minor: minor version (e.g. 2 for version 1.2.5)
+@micro: micro version (e.g. 5 for version 1.2.5)
+
+