libs/gst/base/gstpushsrc.c: Add some more docs here and there.

Original commit message from CVS:
* libs/gst/base/gstpushsrc.c: (gst_push_src_check_get_range):
Add some more docs here and there.

diff --git a/ChangeLog b/ChangeLog
index f23222cf2be930d1c00b0f28bfb2a89dacdfd584..537c1d4b776ea7020d3aa211035540aa6ff87146 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+2006-07-05  Wim Taymans  <wim@fluendo.com>
+
+       * libs/gst/base/gstpushsrc.c: (gst_push_src_check_get_range):
+       Add some more docs here and there.
+
 2006-07-05  Wim Taymans  <wim@fluendo.com>
 
        * libs/gst/base/gstbasesink.c: (gst_base_sink_preroll_object),

diff --git a/libs/gst/base/gstpushsrc.c b/libs/gst/base/gstpushsrc.c
index 6f640ef402ac8afa787ab0d5eceabd35ffbbacab..4201e3ae22fcbfe011de9a5bdee8117ae0c0d72b 100644 (file)
--- a/libs/gst/base/gstpushsrc.c
+++ b/libs/gst/base/gstpushsrc.c
@@ -34,14 +34,18 @@
  *
  * Classes extending this base class will usually be scheduled
  * in a push based mode. If the peer accepts to operate without
- * offsets and withing the limits of the allowed block size, this
- * class can operate in getrange based mode automatically.
+ * offsets and within the limits of the allowed block size, this
+ * class can operate in getrange based mode automatically. To make
+ * this possible, the subclass should override the ::check_get_range
+ * method.
  *
  * The subclass should extend the methods from the baseclass in
- * addition to the create method.
+ * addition to the ::create method.
  *
  * Seeking, flushing, scheduling and sync is all handled by this
  * base class.
+ *
+ * Last reviewed on 2006-07-04 (0.10.9)
  */
 
 #ifdef HAVE_CONFIG_H
@@ -94,6 +98,8 @@ gst_push_src_init (GstPushSrc * pushsrc, GstPushSrcClass * klass)
 static gboolean
 gst_push_src_check_get_range (GstBaseSrc * src)
 {
+  /* a pushsrc can by default never operate in pull mode override
+   * if you want something different. */
   return FALSE;
 }