From b8e1f3778e61e3c5a809f610a1af97ea56a9960e Mon Sep 17 00:00:00 2001
From: Behdad Esfahbod <behdad@behdad.org>
Date: Wed, 6 Dec 2006 23:38:20 -0500
Subject: [PATCH] [docs] Document various CAIRO_VERSION_* macros

---
 doc/public/tmpl/cairo-version.sgml | 20 ++++++++++++--------
 1 file changed, 12 insertions(+), 8 deletions(-)

diff --git a/doc/public/tmpl/cairo-version.sgml b/doc/public/tmpl/cairo-version.sgml
index bc76dce85..a06c56aee 100644
--- a/doc/public/tmpl/cairo-version.sgml
+++ b/doc/public/tmpl/cairo-version.sgml
@@ -119,28 +119,29 @@ if (cairo_version() >= %CAIRO_VERSION_ENCODE(1, 0, 0))
 
 <!-- ##### MACRO CAIRO_VERSION ##### -->
 <para>
-
+The version of cairo available at compile-time, encoded using
+CAIRO_VERSION_ENCODE().
 </para>
 
 
 
 <!-- ##### MACRO CAIRO_VERSION_MAJOR ##### -->
 <para>
-
+The major component of the version of cairo available at compile-time.
 </para>
 
 
 
 <!-- ##### MACRO CAIRO_VERSION_MINOR ##### -->
 <para>
-
+The minor component of the version of cairo available at compile-time.
 </para>
 
 
 
 <!-- ##### MACRO CAIRO_VERSION_MICRO ##### -->
 <para>
-
+The micro component of the version of cairo available at compile-time.
 </para>
 
 
@@ -154,12 +155,15 @@ if (cairo_version() >= %CAIRO_VERSION_ENCODE(1, 0, 0))
 
 <!-- ##### MACRO CAIRO_VERSION_ENCODE ##### -->
 <para>
-
+This macro encodes the given cairo version into an integer.  The numbers
+returned by %CAIRO_VERSION and pango_version() are encoded using this macro.
+Two encoded version numbers can be compared as integers.  The encoding ensures
+that later versions compare greater than earlier versions.
 </para>
 
-@major: 
-@minor: 
-@micro: 
+@major: the major component of the version number
+@minor: the minor component of the version number
+@micro: the micro component of the version number
 
 
 <!-- ##### FUNCTION cairo_version ##### -->