mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2025-02-17 03:35:21 +00:00
Code Issues 1 Projects Releases Wiki Activity

Add more missing docs.

Browse source 
Original commit message from CVS:
* libs/gst/check/gstbufferstraw.c:
* libs/gst/check/gstcheck.h:
* libs/gst/controller/gstcontroller.c:
* libs/gst/controller/gstcontrolsource.h:
* libs/gst/controller/gstlfocontrolsource.h:
* plugins/elements/gstcapsfilter.h:
* plugins/elements/gstfdsink.h:
* plugins/elements/gstfdsrc.h:
Add more missing docs.
This commit is contained in:
Stefan Kost 2007-08-13 13:33:07 +00:00
parent 1baafa6ee6
commit 7c2e8138b6
9 changed files with 54 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
ChangeLog
View file

@ -1,3 +1,15 @@
2007-08-13 Stefan Kost <ensonic@users.sf.net>
* libs/gst/check/gstbufferstraw.c:
* libs/gst/check/gstcheck.h:
* libs/gst/controller/gstcontroller.c:
* libs/gst/controller/gstcontrolsource.h:
* libs/gst/controller/gstlfocontrolsource.h:
* plugins/elements/gstcapsfilter.h:
* plugins/elements/gstfdsink.h:
* plugins/elements/gstfdsrc.h:
Add more missing docs.
2007-08-12 Wim Taymans <wim.taymans@gmail.com>
* gst/gststructure.c:

2
libs/gst/check/gstbufferstraw.c
View file

@ -106,6 +106,8 @@ gst_buffer_straw_start_pipeline (GstElement * bin, GstPad * pad)
*
* You must have previously called gst_buffer_straw_start_pipeline() on
* @pipeline and @pad.
*
* Returns: the captured #GstBuffer.
*/
GstBuffer *
gst_buffer_straw_get_buffer (GstElement * bin, GstPad * pad)

12
libs/gst/check/gstcheck.h
View file

@ -83,8 +83,16 @@ gst_check_message_error (msg, GST_MESSAGE_ERROR, \
GST_ ## domain ## _ERROR, GST_ ## domain ## _ERROR_ ## code)
#define assert_message_error(m, d, c) fail_unless_message_error(m, d, c)
/***
* wrappers for START_TEST and END_TEST
/**
* GST_START_TEST:
* @__testname: test function name
*
* wrapper for checks START_TEST
*/
/**
* GST_END_TEST:
*
* wrapper for checks END_TEST
*/
#if CHECK_MAJOR_VERSION >= 0 && CHECK_MINOR_VERSION >= 9 && CHECK_MICRO_VERSION >= 4
#define GST_START_TEST(__testname) \

13
libs/gst/controller/gstcontroller.c
View file

@ -993,6 +993,7 @@ gst_controlled_property_set_interpolation_mode (GstControlledProperty * self,
*
* Returns: FALSE if the values couldn't be set (ex : properties not handled by controller), TRUE otherwise
*/
#ifndef GST_REMOVE_DEPRECATED
gboolean
gst_controller_set (GstController * self, gchar * property_name,
GstClockTime timestamp, GValue * value)
@ -1021,6 +1022,7 @@ out:
return res;
}
#endif
/**
* gst_controller_set_from_list:
@ -1035,7 +1037,7 @@ out:
*
* Returns: %FALSE if the values couldn't be set (ex : properties not handled by controller), %TRUE otherwise
*/
#ifndef GST_REMOVE_DEPRECATED
gboolean
gst_controller_set_from_list (GstController * self, gchar * property_name,
GSList * timedvalues)
@ -1065,6 +1067,7 @@ out:
return res;
}
#endif
/**
* gst_controller_unset:
@ -1080,6 +1083,7 @@ out:
*
* Returns: %FALSE if the values couldn't be unset (ex : properties not handled by controller), %TRUE otherwise
*/
#ifndef GST_REMOVE_DEPRECATED
gboolean
gst_controller_unset (GstController * self, gchar * property_name,
GstClockTime timestamp)
@ -1106,6 +1110,7 @@ out:
return res;
}
#endif
/**
* gst_controller_unset_all:
@ -1121,6 +1126,7 @@ out:
* by controller), %TRUE otherwise
* Since: 0.10.5
*/
#ifndef GST_REMOVE_DEPRECATED
gboolean
gst_controller_unset_all (GstController * self, gchar * property_name)
{
@ -1143,6 +1149,7 @@ out:
return TRUE;
}
#endif
/**
* gst_controller_get_all:
@ -1159,6 +1166,7 @@ out:
*
* Returns: a copy of the list, or %NULL if the property isn't handled by the controller
*/
#ifndef GST_REMOVE_DEPRECATED
const GList *
gst_controller_get_all (GstController * self, gchar * property_name)
{
@ -1183,6 +1191,7 @@ out:
return res;
}
#endif
/**
* gst_controller_set_interpolation_mode:
@ -1200,6 +1209,7 @@ out:
*
* Returns: %TRUE if the property is handled by the controller, %FALSE otherwise
*/
#ifndef GST_REMOVE_DEPRECATED
gboolean
gst_controller_set_interpolation_mode (GstController * self,
gchar * property_name, GstInterpolateMode mode)
@ -1218,3 +1228,4 @@ gst_controller_set_interpolation_mode (GstController * self,
return res;
}
#endif

6
libs/gst/controller/gstcontrolsource.h
View file

@ -48,13 +48,15 @@ typedef struct _GstValueArray GstValueArray;
/**
* GstTimedValue:
* @timestamp: timestamp of the value change
* @value: the corresponding value
*
* Structure for saving a timestamp and a value.
*/
struct _GstTimedValue
{
GstClockTime timestamp; /* timestamp of the value change */
GValue value; /* the corresponding value */
GstClockTime timestamp;
GValue value;
};
/**

2
libs/gst/controller/gstlfocontrolsource.h
View file

@ -51,7 +51,7 @@ typedef struct _GstLFOControlSourceClass GstLFOControlSourceClass;
typedef struct _GstLFOControlSourcePrivate GstLFOControlSourcePrivate;
/**
* GstLFOWaveForm:
* GstLFOWaveform:
* @GST_LFO_WAVEFORM_SINE: sine waveform
* @GST_LFO_WAVEFORM_SQUARE: square waveform
* @GST_LFO_WAVEFORM_SAW: saw waveform

11
plugins/elements/gstcapsfilter.h
View file

@ -44,15 +44,18 @@ G_BEGIN_DECLS
typedef struct _GstCapsFilter GstCapsFilter;
typedef struct _GstCapsFilterClass GstCapsFilterClass;
struct _GstCapsFilter
{
/**
* GstCapsFilter:
*
* The opaque #GstCapsFilter data structure.
*/
struct _GstCapsFilter {
GstBaseTransform trans;
GstCaps *filter_caps;
};
struct _GstCapsFilterClass
{
struct _GstCapsFilterClass {
GstBaseTransformClass trans_class;
};

5
plugins/elements/gstfdsink.h
View file

@ -44,6 +44,11 @@ G_BEGIN_DECLS
typedef struct _GstFdSink GstFdSink;
typedef struct _GstFdSinkClass GstFdSinkClass;
/**
* GstFdSink:
*
* The opaque #GstFdSink data structure.
*/
struct _GstFdSink {
GstBaseSink parent;

2
plugins/elements/gstfdsrc.h
View file

@ -49,7 +49,7 @@ typedef struct _GstFdSrcClass GstFdSrcClass;
/**
* GstFdSrc:
*
* Opaque #GstFdSrc data structure
* Opaque #GstFdSrc data structure.
*/
struct _GstFdSrc {
GstPushSrc element;