summaryrefslogtreecommitdiff
path: root/gtk/gtkversion.h.in
diff options
context:
space:
mode:
authorMatthias Clasen <mclasen@redhat.com>2011-01-04 17:32:12 -0500
committerMatthias Clasen <mclasen@redhat.com>2011-01-04 17:32:12 -0500
commitb123bc41fdce1e2cbf4ab6f998b3dd372aab515f (patch)
tree1495af7f7c8882fd761336e208526216ac22e254 /gtk/gtkversion.h.in
parent98440ad03190396bd2bef02557f8d41e12dd5795 (diff)
downloadgtk+-b123bc41fdce1e2cbf4ab6f998b3dd372aab515f.tar.gz
Move docs for gtkmain inline
At the same time, introduce a gtkmainprivate.h header and various other cleanups. Based on a patch by Tadej Borovšak. https://bugzilla.gnome.org/show_bug.cgi?id=617471
Diffstat (limited to 'gtk/gtkversion.h.in')
-rw-r--r--gtk/gtkversion.h.in75
1 files changed, 64 insertions, 11 deletions
diff --git a/gtk/gtkversion.h.in b/gtk/gtkversion.h.in
index e82f9c7886..8734135eb1 100644
--- a/gtk/gtkversion.h.in
+++ b/gtk/gtkversion.h.in
@@ -8,7 +8,7 @@
*
* 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
@@ -24,6 +24,16 @@
* GTK+ at ftp://ftp.gtk.org/pub/gtk/.
*/
+/**
+ * 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.
+ */
+
#if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
#error "Only <gtk/gtk.h> can be included directly."
#endif
@@ -31,19 +41,62 @@
#ifndef __GTK_VERSION_H__
#define __GTK_VERSION_H__
-/* compile time version
+/**
+ * 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@)
-#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@)
+#define GTK_MAJOR_VERSION (@GTK_MAJOR_VERSION@)
-/* check whether a Gtk+ version equal to or greater than
- * major.minor.micro is present.
+/**
+ * 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)))