From a71cbb326b9e08b332eb6f024a7be36e8d4e249e Mon Sep 17 00:00:00 2001 From: Wim Taymans Date: Fri, 28 Oct 2005 18:14:24 +0000 Subject: [PATCH] Doc updates. Original commit message from CVS: * docs/design/part-TODO.txt: * gst/gstiterator.c: * gst/gstsystemclock.c: * gst/gstsystemclock.h: Doc updates. --- ChangeLog | 8 ++++++++ docs/design/part-TODO.txt | 6 ++++++ gst/gstiterator.c | 2 ++ gst/gstsystemclock.c | 12 +++++++++++- gst/gstsystemclock.h | 6 ++++++ 5 files changed, 33 insertions(+), 1 deletion(-) diff --git a/ChangeLog b/ChangeLog index a174f39457..713feda3ac 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,11 @@ +2005-10-28 Wim Taymans + + * docs/design/part-TODO.txt: + * gst/gstiterator.c: + * gst/gstsystemclock.c: + * gst/gstsystemclock.h: + Doc updates. + 2005-10-28 Edward Hervey * docs/gst/gstreamer-docs.sgml: diff --git a/docs/design/part-TODO.txt b/docs/design/part-TODO.txt index fa82fb2793..77a77ba456 100644 --- 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 d3ea25294f..d2653d5773 100644 --- a/gst/gstiterator.c +++ b/gst/gstiterator.c @@ -56,6 +56,8 @@ * gst_iterator_free (it); * * + * + * Last reviewed on 2005-10-28 (0.9.4) */ #include "gst_private.h" diff --git a/gst/gstsystemclock.c b/gst/gstsystemclock.c index d814dbb3d0..eedead7fce 100644 --- 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 892b3f4909..b164c720d5 100644 --- 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;