libs/gst/base/: Fix doc typos and unify caps a bit.

Original commit message from CVS:
* libs/gst/base/gstbasesink.h:
* libs/gst/base/gstbasesrc.h:
* libs/gst/base/gstbasetransform.h:
* libs/gst/base/gstcollectpads.h:
Fix doc typos and unify caps a bit.
This commit is contained in:
Stefan Kost 2008-04-25 13:22:32 +00:00
parent 323cdbe71d
commit f368d089df
5 changed files with 16 additions and 8 deletions

View file

@ -1,3 +1,11 @@
2008-04-25 Stefan Kost <ensonic@users.sf.net>
* libs/gst/base/gstbasesink.h:
* libs/gst/base/gstbasesrc.h:
* libs/gst/base/gstbasetransform.h:
* libs/gst/base/gstcollectpads.h:
Fix doc typos and unify caps a bit.
2008-04-25 Stefan Kost <ensonic@users.sf.net> 2008-04-25 Stefan Kost <ensonic@users.sf.net>
* tools/gst-launch.1.in: * tools/gst-launch.1.in:

View file

@ -91,7 +91,7 @@ struct _GstBaseSink {
/*< private >*/ /*< private >*/
union { union {
struct { struct {
/* segment used for clipping incomming buffers */ /* segment used for clipping incoming buffers */
GstSegment *clip_segment; GstSegment *clip_segment;
/* max amount of time a buffer can be late, -1 no limit. */ /* max amount of time a buffer can be late, -1 no limit. */
gint64 max_lateness; gint64 max_lateness;

View file

@ -150,7 +150,7 @@ struct _GstBaseSrc {
* cycles. The default implementation will open and close the resource * cycles. The default implementation will open and close the resource
* to find out whether get_range is supported, and that is usually * to find out whether get_range is supported, and that is usually
* undesirable. * undesirable.
* @fixate: Called during negotation if caps need fixating. Implement instead of * @fixate: Called during negotiation if caps need fixating. Implement instead of
* setting a fixate function on the source pad. * setting a fixate function on the source pad.
* *
* Subclasses can override any of the available virtual methods or not, as * Subclasses can override any of the available virtual methods or not, as
@ -213,7 +213,7 @@ struct _GstBaseSrcClass {
* undesirable. */ * undesirable. */
gboolean (*check_get_range) (GstBaseSrc *src); gboolean (*check_get_range) (GstBaseSrc *src);
/* called if, in negotation, caps need fixating */ /* called if, in negotiation, caps need fixating */
void (*fixate) (GstBaseSrc *src, GstCaps *caps); void (*fixate) (GstBaseSrc *src, GstCaps *caps);
/* Clear any pending unlock request, as we succeeded in unlocking */ /* Clear any pending unlock request, as we succeeded in unlocking */

View file

@ -37,13 +37,13 @@ G_BEGIN_DECLS
/** /**
* GST_BASE_TRANSFORM_SINK_NAME: * GST_BASE_TRANSFORM_SINK_NAME:
* *
* the name of the templates for the sink pad * The name of the templates for the sink pad.
*/ */
#define GST_BASE_TRANSFORM_SINK_NAME "sink" #define GST_BASE_TRANSFORM_SINK_NAME "sink"
/** /**
* GST_BASE_TRANSFORM_SRC_NAME: * GST_BASE_TRANSFORM_SRC_NAME:
* *
* the name of the templates for the source pad * The name of the templates for the source pad.
*/ */
#define GST_BASE_TRANSFORM_SRC_NAME "src" #define GST_BASE_TRANSFORM_SRC_NAME "src"
@ -144,12 +144,12 @@ struct _GstBaseTransform {
/** /**
* GstBaseTransformClass: * GstBaseTransformClass:
* @transform_caps: Optional. given the pad in this direction and the given * @transform_caps: Optional. Given the pad in this direction and the given
* caps, what caps are allowed on the other pad in this * caps, what caps are allowed on the other pad in this
* element ? * element ?
* @fixate_caps: Optional. Given the pad in this direction and the given * @fixate_caps: Optional. Given the pad in this direction and the given
* caps, fixate the caps on the other pad. * caps, fixate the caps on the other pad.
* @transform_size: Optional. given the size of a buffer in the given direction * @transform_size: Optional. Given the size of a buffer in the given direction
* with the given caps, calculate the size in bytes of a buffer * with the given caps, calculate the size in bytes of a buffer
* on the other pad with the given other caps. * on the other pad with the given other caps.
* The default implementation uses get_unit_size and keeps * The default implementation uses get_unit_size and keeps

View file

@ -83,7 +83,7 @@ struct _GstCollectData
/** /**
* GstCollectPadsFunction: * GstCollectPadsFunction:
* @pads: the #GstCollectPads that trigered the callback * @pads: the #GstCollectPads that triggered the callback
* @user_data: user data passed to gst_collect_pads_set_function() * @user_data: user data passed to gst_collect_pads_set_function()
* *
* A function that will be called when all pads have received data. * A function that will be called when all pads have received data.