X-Git-Url: http://pileus.org/git/?a=blobdiff_plain;f=gtk%2Fgtkversion.h.in;h=89706c5d7abdcde4c1529716750dad0c61cf95e5;hb=50065b7ba07fe08f5c71e42101fedf5b6e810982;hp=e82f9c788670619f685086698fd15873b3e83dbf;hpb=db2168890834e3284de64b6a1a08f88417feda31;p=~andy%2Fgtk

diff --git a/gtk/gtkversion.h.in b/gtk/gtkversion.h.in
index e82f9c788..89706c5d7 100644
--- a/gtk/gtkversion.h.in
+++ b/gtk/gtkversion.h.in
@@ -8,13 +8,11 @@
  *
  * This library is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.	 See the GNU
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  * Lesser General Public License for more details.
  *
  * You should have received a copy of the GNU Lesser General Public
- * License along with this library; if not, write to the
- * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- * Boston, MA 02111-1307, USA.
+ * License along with this library. If not, see <http://www.gnu.org/licenses/>.
  */
 
 /*
@@ -31,19 +29,72 @@
 #ifndef __GTK_VERSION_H__
 #define __GTK_VERSION_H__
 
-/* compile time version
+/**
+ * SECTION:gtkfeatures
+ * @Short_description: Variables and functions to check the GTK+ version
+ * @Title: Version Information
+ *
+ * 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.
  */
-#define GTK_MAJOR_VERSION				(@GTK_MAJOR_VERSION@)
-#define GTK_MINOR_VERSION				(@GTK_MINOR_VERSION@)
-#define GTK_MICRO_VERSION				(@GTK_MICRO_VERSION@)
-#define GTK_BINARY_AGE					(@GTK_BINARY_AGE@)
-#define GTK_INTERFACE_AGE				(@GTK_INTERFACE_AGE@)
 
-/* check whether a Gtk+ version equal to or greater than
- * major.minor.micro is present.
+/**
+ * GTK_MAJOR_VERSION:
+ *
+ * Like gtk_get_major_version(), but from the headers used at
+ * application compile time, rather than from the library linked
+ * against at application run time.
+ */
+#define GTK_MAJOR_VERSION (@GTK_MAJOR_VERSION@)
+
+/**
+ * GTK_MINOR_VERSION:
+ *
+ * Like gtk_get_minor_version(), but from the headers used at
+ * application compile time, rather than from the library linked
+ * against at application run time.
+ */
+#define GTK_MINOR_VERSION (@GTK_MINOR_VERSION@)
+
+/**
+ * GTK_MICRO_VERSION:
+ *
+ * Like gtk_get_micro_version(), but from the headers used at
+ * application compile time, rather than from the library linked
+ * against at application run time.
+ */
+#define GTK_MICRO_VERSION (@GTK_MICRO_VERSION@)
+
+/**
+ * GTK_BINARY_AGE:
+ *
+ * Like gtk_get_binary_age(), but from the headers used at
+ * application compile time, rather than from the library linked
+ * against at application run time.
+ */
+#define GTK_BINARY_AGE    (@GTK_BINARY_AGE@)
+
+/**
+ * GTK_INTERFACE_AGE:
+ *
+ * Like gtk_get_interface_age(), but from the headers used at
+ * application compile time, rather than from the library linked
+ * against at application run time.
+ */
+#define GTK_INTERFACE_AGE (@GTK_INTERFACE_AGE@)
+
+/**
+ * GTK_CHECK_VERSION:
+ * @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)
+ *
+ * Returns %TRUE if the version of the GTK+ header files
+ * is the same as or newer than the passed-in version.
  */
-#define	GTK_CHECK_VERSION(major,minor,micro)	\
-    (GTK_MAJOR_VERSION > (major) || \
+#define GTK_CHECK_VERSION(major,minor,micro)                          \
+    (GTK_MAJOR_VERSION > (major) ||                                   \
      (GTK_MAJOR_VERSION == (major) && GTK_MINOR_VERSION > (minor)) || \
      (GTK_MAJOR_VERSION == (major) && GTK_MINOR_VERSION == (minor) && \
       GTK_MICRO_VERSION >= (micro)))