Add more missing docs.
authorStefan Kost <ensonic@users.sourceforge.net>
Mon, 13 Aug 2007 13:33:07 +0000 (13:33 +0000)
committerStefan Kost <ensonic@users.sourceforge.net>
Mon, 13 Aug 2007 13:33:07 +0000 (13:33 +0000)
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.

ChangeLog
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

index 026e3b04de4140fa7ef2518b69369532ff3ea725..86f3534fb5cdbdcf94f0999ac5b244b2ce71f065 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -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:
index b84d0448b9cf67cfbd912d77933bec8da55b7720..1089ed90113b9c8f5b7276d86d485353da89dd58 100644 (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)
index f40ad9c0702de15c0a6850e4dfb3b98095a4dbe0..0bd901856f5db54bb0518edccf5bf1fd351ef1db 100644 (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) \
index 3df8f979a859e97ce95b5de38c9c5f2566f0019f..3f630b819eaf38a1ec12c45340264f79c475e6d3 100644 (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
index 68897abd664a5540cfdd9eab005c4147385ae7ed..c3db5797541e92052ce6aea6a3e06f603798062c 100644 (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;
 };
 
 /**
index 9bf55c8235d80724ab0cc5d1ff2a08c05f1b7855..18bb8cc777e20288b18aa001c59ff53d9915deec 100644 (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
index a07a78a97fb2b733f90f789adbaacd75ad5ac858..d132e66d4810bcca31a4e2900a1918e51dbbb511 100644 (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;
 };
 
index 432abff890f4e29771fec6ae98daa86fed897009..a2b3cc760faf9282962344c716a63741a22ee803 100644 (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;
 
index 889a5a48956b156c45c7836485b714c47ca86ec0..9c3a322a5cd0a17864e98a60ef2dfa14202f435a 100644 (file)
@@ -49,7 +49,7 @@ typedef struct _GstFdSrcClass GstFdSrcClass;
 /**
  * GstFdSrc:
  *
- * Opaque #GstFdSrc data structure
+ * Opaque #GstFdSrc data structure.
  */
 struct _GstFdSrc {
   GstPushSrc element;