summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorChristian Persch <chpe@src.gnome.org>2008-06-24 18:12:02 +0000
committerChristian Persch <chpe@src.gnome.org>2008-06-24 18:12:02 +0000
commit460fcb3becf82346c62cedfde23bace926b5b112 (patch)
tree676963e44400bdf6ebfe533cc400177e708c3ac5 /doc
parent089b2a4ec92e6c2b0ade68c38b2d41c55335023d (diff)
downloadvte-460fcb3becf82346c62cedfde23bace926b5b112.tar.gz
Bug 535468 – need version check macros
svn path=/trunk/; revision=2061
Diffstat (limited to 'doc')
-rw-r--r--doc/reference/tmpl/vteversion.sgml59
-rw-r--r--doc/reference/vte-sections.txt10
-rw-r--r--doc/reference/vte.types1
3 files changed, 70 insertions, 0 deletions
diff --git a/doc/reference/tmpl/vteversion.sgml b/doc/reference/tmpl/vteversion.sgml
new file mode 100644
index 00000000..d3e41e9d
--- /dev/null
+++ b/doc/reference/tmpl/vteversion.sgml
@@ -0,0 +1,59 @@
+<!-- ##### SECTION Title ##### -->
+Version Information
+
+<!-- ##### SECTION Short_Description ##### -->
+Defines and macros to check the VTE version
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+VTE provides version information, primarily useful in configure checks
+for builds that have a configure script, and for use in C preprocessor directives.
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### MACRO VTE_MAJOR_VERSION ##### -->
+<para>
+The major version number of the VTE library used at compile time. (e.g. in VTE version
+0.16.15 this is 0.)
+</para>
+
+@Since: 0.16.15
+
+
+<!-- ##### MACRO VTE_MINOR_VERSION ##### -->
+<para>
+The minor version number of the VTE library used at compile time. (e.g. in VTE version
+0.16.15 this is 16.)
+</para>
+
+@Since: 0.16.15
+
+
+<!-- ##### MACRO VTE_MICRO_VERSION ##### -->
+<para>
+The micro version number of the VTE library used at compile time. (e.g. in VTE version
+0.16.15 this is 15.)
+</para>
+
+@Since: 0.16.15
+
+
+<!-- ##### MACRO VTE_CHECK_VERSION ##### -->
+<para>
+Returns %TRUE if the version of the VTE header files is the same
+as or newer than the passed-in version.
+</para>
+
+@major: major version to check for
+@minor: minor version to check for
+@micro: micro version to check for
+@Since: 0.16.15
+
+
diff --git a/doc/reference/vte-sections.txt b/doc/reference/vte-sections.txt
index bcba75a9..a5355818 100644
--- a/doc/reference/vte-sections.txt
+++ b/doc/reference/vte-sections.txt
@@ -98,6 +98,16 @@ vte_terminal_get_window_title
</SECTION>
<SECTION>
+<FILE>vteversion</FILE>
+<TITLE>Version Information</TITLE>
+<SUBSECTION>
+VTE_MAJOR_VERSION
+VTE_MINOR_VERSION
+VTE_MICRO_VERSION
+VTE_CHECK_VERSION
+</SECTION>
+
+<SECTION>
<FILE>vteaccess</FILE>
<TITLE>VteTerminalAccessible</TITLE>
VteTerminalAccessible
diff --git a/doc/reference/vte.types b/doc/reference/vte.types
index 85aad0dd..e50bc5be 100644
--- a/doc/reference/vte.types
+++ b/doc/reference/vte.types
@@ -2,6 +2,7 @@
#include <glib-object.h>
#include <gtk/gtk.h>
#include "vte.h"
+#include "vteversion.h"
#include "vteaccess.h"
#include "reaper.h"