More docs coverage and some ChangeLog surgery (add missing names)

Original commit message from CVS:
* gst/gstchildproxy.h:
* libs/gst/base/gstbasesink.h:
* libs/gst/base/gstbasesrc.h:
* libs/gst/base/gstbasetransform.h:
More docs coverage and some ChangeLog surgery (add missing names)

diff --git a/ChangeLog b/ChangeLog
index c939e62..350f5c2 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,11 @@
+2007-02-15  Stefan Kost  <ensonic@users.sf.net>
+
+       * gst/gstchildproxy.h:
+       * libs/gst/base/gstbasesink.h:
+       * libs/gst/base/gstbasesrc.h:
+       * libs/gst/base/gstbasetransform.h:
+       More docs coverage and some ChangeLog surgery (add missing names)
+
 2007-02-15  Wim Taymans  <wim@fluendo.com>
 
        * docs/design/part-TODO.txt:
@@ -1262,7 +1270,7 @@
 
 2006-11-20  Wim Taymans  <wim@fluendo.com>
 
-       Patch by: Sebastian Droege <slomo at ubuntu dot com>
+       Patch by: Sebastian Dröge <slomo at ubuntu dot com>
 
        * libs/gst/check/gstcheck.h:
        Fix compilation and running against 0.9.4. Fixes #377332.
@@ -8811,7 +8819,7 @@
 
 === release 0.10.0 ===
 
-2005-12-05   <thomas (at) apestaart (dot) org>
+2005-12-05  Thomas Vander Stichele  <thomas (at) apestaart (dot) org>
 
        * configure.ac:
          releasing 0.10.0, "Maroilles"
@@ -8963,7 +8971,7 @@
 
 === release 0.9.7 ===
 
-2005-12-01   <thomas (at) apestaart (dot) org>
+2005-12-01  Thomas Vander Stichele <thomas (at) apestaart (dot) org>
 
        * configure.ac:
          releasing 0.9.7, "My Dog Has No Nose"

diff --git a/gst/gstchildproxy.h b/gst/gstchildproxy.h
index 2fcb7ff..0f92b00 100644 (file)
--- a/gst/gstchildproxy.h
+++ b/gst/gstchildproxy.h
@@ -56,10 +56,12 @@ struct _GstChildProxyInterface
   /* methods */
   GstObject *(*get_child_by_index) (GstChildProxy * parent, guint index);
   guint (*get_children_count) (GstChildProxy * parent);
+  /*< private > */
   /* signals */
   void (*child_added) (GstChildProxy * parent, GstObject * child);
   void (*child_removed) (GstChildProxy * parent, GstObject * child);
 
+  /*< private > */
   gpointer _gst_reserved[GST_PADDING];
 };
 

diff --git a/libs/gst/base/gstbasesink.h b/libs/gst/base/gstbasesink.h
index 589ed30..417c5a0 100644 (file)
--- a/libs/gst/base/gstbasesink.h
+++ b/libs/gst/base/gstbasesink.h
@@ -104,6 +104,7 @@ struct _GstBaseSink {
 
 /**
  * GstBaseSinkClass:
+ * @parent_class: Element parent class
  * @get_caps: Called to get sink pad caps from the subclass
  * @set_caps: Notify subclass of changed caps
  * @buffer_alloc: Subclasses can override to perform custom buffer allocations
@@ -130,7 +131,7 @@ struct _GstBaseSink {
  *     ideas about what should be the default values for the caps you support.
  *
  * Subclasses can override any of the available virtual methods or not, as
- * needed. At the minimum, the render method should be overridden to
+ * needed. At the minimum, the @render method should be overridden to
  * output/present buffers.
  */
 struct _GstBaseSinkClass {

diff --git a/libs/gst/base/gstbasesrc.h b/libs/gst/base/gstbasesrc.h
index 76a5dff..fc9ed50 100644 (file)
--- a/libs/gst/base/gstbasesrc.h
+++ b/libs/gst/base/gstbasesrc.h
@@ -144,6 +144,10 @@ struct _GstBaseSrc {
  *   undesirable. 
  * @fixate: Called during negotation if caps need fixating. Implement instead of
  *   setting a fixate function on the source pad.
+ *
+ * Subclasses can override any of the available virtual methods or not, as
+ * needed. At the minimum, the @create method should be overridden to produce
+ * buffers.
  */
 struct _GstBaseSrcClass {
   GstElementClass parent_class;

diff --git a/libs/gst/base/gstbasetransform.h b/libs/gst/base/gstbasetransform.h
index 9d9b156..8a846d3 100644 (file)
--- a/libs/gst/base/gstbasetransform.h
+++ b/libs/gst/base/gstbasetransform.h
@@ -152,6 +152,11 @@ struct _GstBaseTransform {
  *                         analysis can return a subbuffer or even just
  *                         increment the reference to the input buffer (if in
  *                         passthrough mode)
+ *
+ * Subclasses can override any of the available virtual methods or not, as
+ * needed. At minimum either @transform or @transform_ip need to be overridden.
+ * If the element can overwrite the input data with the results (data is of the
+ * same type and quantity) it should provide @transform_ip.
  */
 struct _GstBaseTransformClass {
   GstElementClass parent_class;