2007-11-23 Emmanuele Bassi <ebassi@openedhand.com>

	* clutter-gst/clutter-gst-audio.h:
	* clutter-gst/clutter-gst-version.h.in:
	* clutter-gst/clutter-gst-video-sink.h:
	* clutter-gst/clutter-gst-video-texture.h: Add missing
	documentation.

	* doc/reference/Makefile.am: Fix EXTRA_DIST.

	* doc/reference/clutter-gst-docs.sgml: Fix wording a bit.

	* examples/video-player.c (effect1_tl_cb): Update for upstream
	API changes.

1 files changed, 43 insertions, 0 deletions

diff --git a/clutter-gst/clutter-gst-version.h.in b/clutter-gst/clutter-gst-version.h.in
index 0b1651e..871fd4d 100644
--- a/clutter-gst/clutter-gst-version.h.in
+++ b/clutter-gst/clutter-gst-version.h.in
@@ -33,16 +33,59 @@
 #ifndef __CLUTTER_GST_VERSION_H__
 #define __CLUTTER_GST_VERSION_H__
 
+/**
+ * CLUTTER_GST_MAJOR_VERSION:
+ *
+ * ClutterGst major version (e.g. "1", if %CLUTTER_GST_VERSION is "1.2.3")
+ */
 #define CLUTTER_GST_MAJOR_VERSION   (@CLUTTER_GST_MAJOR_VERSION@)
+
+/**
+ * CLUTTER_GST_MINOR_VERSION:
+ *
+ * ClutterGst minor version (e.g. "2", if %CLUTTER_GST_VERSION is "1.2.3")
+ */
 #define CLUTTER_GST_MINOR_VERSION   (@CLUTTER_GST_MINOR_VERSION@)
+
+/**
+ * CLUTTER_GST_MICRO_VERSION:
+ *
+ * ClutterGst micro version (e.g. "3", if %CLUTTER_GST_VERSION is "1.2.3")
+ */
 #define CLUTTER_GST_MICRO_VERSION   (@CLUTTER_GST_MICRO_VERSION@)
 
+/**
+ * CLUTTER_GST_VERSION:
+ *
+ * ClutterGst full version (e.g. "1.2.3")
+ */
 #define CLUTTER_GST_VERSION         (@CLUTTER_GST_VERSION@)
+
+/**
+ * CLUTTER_GST_VERSION_S:
+ *
+ * ClutterGst full version, encoded as a string.
+ */
 #define CLUTTER_GST_VERSION_S       "@CLUTTER_GST_VERSION@"
+
+/**
+ * CLUTTER_GST_VERSION_HEX:
+ *
+ * ClutterGst full version, encoded as an hexadecimal value.
+ */
 #define CLUTTER_GST_VERSION_HEX     ((CLUTTER_GST_MAJOR_VERSION << 24) | \
                                      (CLUTTER_GST_MINOR_VERSION << 16) | \
                                      (CLUTTER_GST_MICRO_VERSION << 8))
 
+/**
+ * CLUTTER_GST_CHECK_VERSION:
+ * @major: major version, like 1 in 1.2.3
+ * @minor: minor version, like 2 in 1.2.3
+ * @micro: micro version, like 3 in 1.2.3
+ *
+ * Evaluates to %TRUE if the version of ClutterGst is greater than
+ * the @major, @minor and @micro values.
+ */
 #define CLUTTER_GST_CHECK_VERSION(major,minor,micro) \
         (CLUTTER_GST_MAJOR_VERSION > (major) || \
          (CLUTTER_GST_MAJOR_VERSION == (major) && CLUTTER_GST_MINOR_VERSION > (minor)) || \