fix docs
authorThomas Vander Stichele <thomas@apestaart.org>
Fri, 23 Sep 2005 16:35:43 +0000 (16:35 +0000)
committerThomas Vander Stichele <thomas@apestaart.org>
Fri, 23 Sep 2005 16:35:43 +0000 (16:35 +0000)
Original commit message from CVS:
fix docs

common
docs/gst/gstreamer-sections.txt
docs/libs/gstreamer-libs-sections.txt
gst/gstclock.h
gst/gstelement.h
gst/gstinfo.h
gst/gststructure.c
gst/gststructure.h
gst/gstvalue.c

diff --git a/common b/common
index 345fd98..793f85c 160000 (submodule)
--- a/common
+++ b/common
@@ -1 +1 @@
-Subproject commit 345fd9851051274dd758a19bbe33dbb561b4d303
+Subproject commit 793f85c1c14de9c1053b8db7df44bfbba1f0a156
index cdfbca3..e7bafa6 100644 (file)
@@ -1505,6 +1505,10 @@ gst_query_set_seeking
 gst_query_type_iterate_definitions
 gst_query_unref
 
+gst_query_set_segment
+gst_query_new_segment
+gst_query_parse_segment
+
 <SUBSECTION Standard>
 GstQueryClass
 GST_QUERY
index 4eb1f79..480cc79 100644 (file)
@@ -47,7 +47,6 @@ gst_dp_validate_packet
 <TITLE>GstController</TITLE>
 <INCLUDE>gst/controller/gstcontroller.h</INCLUDE>
 GstController
-GstValueArray
 GstInterpolateMode
 gst_controller_init
 gst_controller_new
index 6ac1a03..f943eb7 100644 (file)
@@ -42,6 +42,9 @@ G_BEGIN_DECLS
  * A datatype to hold a time, measured in nanoseconds.
  */
 typedef guint64        GstClockTime;
+
+#define GST_TYPE_CLOCK_TIME G_TYPE_UINT64
+
 /**
  * GstClockTimeDiff:
  *
index f9ca261..9fc355f 100644 (file)
@@ -379,7 +379,6 @@ GType                       gst_element_get_type            (void);
 /**
  * gst_element_get_name:
  * @elem: a #GstElement to set the name of.
- * @name: the new name of the element.
  *
  * Gets the name of the element.
  */
@@ -390,8 +389,6 @@ GType                       gst_element_get_type            (void);
  * @elem: a #GstElement to set the name of.
  *
  * Sets the name of the element, getting rid of the old name if there was one.
- *
- * Returns: the name of the element.
  */
 #define                        gst_element_set_name(elem,name) gst_object_set_name(GST_OBJECT(elem),name)
 
@@ -400,15 +397,13 @@ GType                     gst_element_get_type            (void);
  * @elem: a #GstElement to get the parent of.
  *
  * Gets the parent of an element.
- *
- * Returns: the #GstObject parent of the element.
  */
 #define                        gst_element_get_parent(elem)    gst_object_get_parent(GST_OBJECT(elem))
 
 /**
  * gst_element_set_parent:
  * @elem: a #GstElement to set the parent of.
- * @name: the new parent #GstObject of the element.
+ * @parent: the new parent #GstObject of the element.
  *
  * Sets the parent of an element.
  */
index 1b31d8c..6cfa1c5 100644 (file)
@@ -853,8 +853,6 @@ G_CONST_RETURN gchar *
  *
  * Register a pointer to a function with its name, so it can later be used by
  * GST_DEBUG_FUNCPTR_NAME().
- *
- * Returns: The ptr to the function
  */
 #define GST_DEBUG_FUNCPTR(ptr) \
   (_gst_debug_register_funcptr((GstDebugFuncPtr)(ptr), #ptr) , ptr)
@@ -867,8 +865,6 @@ G_CONST_RETURN gchar *
  * GST_DEBUG_FUNCPTR(). If not, it returns a description of the pointer.
  *
  * Make sure you free the string after use.
- *
- * Returns: The name of the function
  */
 #define GST_DEBUG_FUNCPTR_NAME(ptr) \
   _gst_debug_nameof_funcptr((GstDebugFuncPtr)ptr)
index 909f281..5d6e34c 100644 (file)
@@ -966,13 +966,13 @@ gst_structure_get_fourcc (const GstStructure * structure,
  */
 gboolean
 gst_structure_get_date (const GstStructure * structure, const gchar * fieldname,
-    GDate ** date_out)
+    GDate ** value)
 {
   GstStructureField *field;
 
   g_return_val_if_fail (structure != NULL, FALSE);
   g_return_val_if_fail (fieldname != NULL, FALSE);
-  g_return_val_if_fail (date_out != NULL, FALSE);
+  g_return_val_if_fail (value != NULL, FALSE);
 
   field = gst_structure_get_field (structure, fieldname);
 
@@ -981,7 +981,7 @@ gst_structure_get_date (const GstStructure * structure, const gchar * fieldname,
   if (!GST_VALUE_HOLDS_DATE (&field->value))
     return FALSE;
 
-  *date_out = g_value_dup_boxed (&field->value);
+  *value = g_value_dup_boxed (&field->value);
 
   return TRUE;
 }
index 787d6d1..7695a77 100644 (file)
@@ -132,7 +132,7 @@ gboolean                gst_structure_get_double           (const GstStructure
                                                            gdouble                 *value);
 gboolean                gst_structure_get_date             (const GstStructure      *structure,
                                                            const gchar             *fieldname,
-                                                            GDate                  **date_out);
+                                                            GDate                  **value);
 G_CONST_RETURN gchar *  gst_structure_get_string           (const GstStructure      *structure,
                                                            const gchar             *fieldname);
 
index bf56d55..ac8099d 100644 (file)
@@ -16,6 +16,7 @@
  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  * Boston, MA 02111-1307, USA.
  */
+
 /**
  * SECTION:gstvalue
  * @short_description: GValue implementations specific to GStreamer
@@ -2978,7 +2979,7 @@ gst_value_compare_fraction (const GValue * value1, const GValue * value2)
 /**
  * gst_value_set_date:
  * @value: a GValue initialized to GST_TYPE_DATE
- * @caps: the date to set the value to
+ * @date: the date to set the value to
  *
  * Sets the contents of @value to coorespond to @date.  The actual
  * #GDate structure is copied before it is used.