Doc updates.

Original commit message from CVS:
* docs/design/part-TODO.txt:
* gst/gstiterator.c:
* gst/gstsystemclock.c:
* gst/gstsystemclock.h:
Doc updates.

diff --git a/ChangeLog b/ChangeLog
index a174f39..713feda 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,11 @@
+2005-10-28  Wim Taymans  <wim@fluendo.com>
+
+       * docs/design/part-TODO.txt:
+       * gst/gstiterator.c:
+       * gst/gstsystemclock.c:
+       * gst/gstsystemclock.h:
+       Doc updates.
+
 2005-10-28  Edward Hervey  <edward@fluendo.com>
 
        * docs/gst/gstreamer-docs.sgml:

diff --git a/docs/design/part-TODO.txt b/docs/design/part-TODO.txt
index fa82fb2..77a77ba 100644 (file)
--- a/docs/design/part-TODO.txt
+++ b/docs/design/part-TODO.txt
@@ -34,3 +34,9 @@
   or chain to the parent.
 
 - make it possible to seek on other formats than bytes in basesrc.
+
+- GstFormat quarks, get_name. 
+
+- GstQuery quark, get_name.
+
+- GstEvent, GstMessage register like GstFormat or GstQuery.

diff --git a/gst/gstiterator.c b/gst/gstiterator.c
index d3ea252..d2653d5 100644 (file)
--- a/gst/gstiterator.c
+++ b/gst/gstiterator.c
@@ -56,6 +56,8 @@
  *    gst_iterator_free (it);
  *   </programlisting>
  * </example>
+ *
+ * Last reviewed on 2005-10-28 (0.9.4)
  */
 
 #include "gst_private.h"

diff --git a/gst/gstsystemclock.c b/gst/gstsystemclock.c
index d814dbb..eedead7 100644 (file)
--- a/gst/gstsystemclock.c
+++ b/gst/gstsystemclock.c
@@ -25,7 +25,17 @@
  * @short_description: Default clock that uses the current system time
  * @see_also: #GstClock
  *
- * The System clock is an implementation of GstClock using the system time.
+ * The GStreamer core provides a GstSystemClock based on the system time.
+ * Asynchronous callbacks are scheduled from an internal thread.
+ *
+ * Clock implementors are encouraged to subclass this systemclock as it
+ * implements the async notification.
+ *
+ * Subclasses can however override all of the important methods for sync and
+ * async notifications to implement their own callback methods or blocking
+ * wait operations.
+ *
+ * Last reviewed on 2005-10-28 (0.9.4)
  */
 
 #include "gst_private.h"

diff --git a/gst/gstsystemclock.h b/gst/gstsystemclock.h
index 892b3f4..b164c72 100644 (file)
--- a/gst/gstsystemclock.h
+++ b/gst/gstsystemclock.h
@@ -40,6 +40,12 @@ G_BEGIN_DECLS
 typedef struct _GstSystemClock GstSystemClock;
 typedef struct _GstSystemClockClass GstSystemClockClass;
 
+/**
+ * GstSystemClock:
+ * @clock: The parent clock
+ *
+ * The default implementation of a #GstClock that uses the system time.
+ */
 struct _GstSystemClock {
   GstClock      clock;