more docs

Original commit message from CVS:
* docs/gst/gstreamer-sections.txt:
* gst/gstelementfactory.c:
* gst/gstevent.c:
* gst/gsttaglist.c:
more docs

ChangeLog

@@ -1,3 +1,11 @@
+2005-10-08  Stefan Kost  <ensonic@users.sf.net>
+
+	* docs/gst/gstreamer-sections.txt:
+	* gst/gstelementfactory.c:
+	* gst/gstevent.c:
+	* gst/gsttaglist.c:
+          more docs
+
 2005-10-08  Wim Taymans  <wim@fluendo.com>
 
 	* gst/gstbin.c: (is_eos), (update_degree), (gst_bin_change_state),

docs/gst/gstreamer-sections.txt

@@ -582,10 +582,10 @@ GST_RESOURCE_ERROR
 GST_STREAM_ERROR
 GST_ERROR_SYSTEM
 gst_error_get_message
-gst_stream_error_quark
 gst_core_error_quark
-gst_resource_error_quark
 gst_library_error_quark
+gst_resource_error_quark
+gst_stream_error_quark
 <SUBSECTION Standard>
 GST_TYPE_G_ERROR
 GST_TYPE_CORE_ERROR
@@ -621,26 +621,28 @@ GST_EVDIR_BOTH
 GST_EVDIR_DS
 GST_EVDIR_US
 
-gst_event_type_get_name
-gst_event_type_to_quark
-gst_event_ref
-gst_event_unref
 gst_event_copy
-gst_event_new_custom
 gst_event_get_structure
+gst_event_new_buffersize
+gst_event_new_custom
+gst_event_new_eos
+gst_event_new_filler
 gst_event_new_flush_start
 gst_event_new_flush_stop
-gst_event_new_eos
-gst_event_new_newsegment
-gst_event_parse_newsegment
-gst_event_new_tag
-gst_event_parse_tag
-gst_event_new_filler
-gst_event_new_qos
-gst_event_parse_qos
-gst_event_new_seek
-gst_event_parse_seek
 gst_event_new_navigation
+gst_event_new_newsegment
+gst_event_new_qos
+gst_event_new_seek
+gst_event_new_tag
+gst_event_parse_buffersize
+gst_event_parse_newsegment
+gst_event_parse_qos
+gst_event_parse_seek
+gst_event_parse_tag
+gst_event_ref
+gst_event_type_get_name
+gst_event_type_to_quark
+gst_event_unref
 
 gst_message_type_to_quark
 gst_message_type_get_name
@@ -985,16 +987,22 @@ gst_message_copy
 gst_message_get_structure
 gst_message_make_writable
 gst_message_new_application
-gst_message_new_element
+gst_message_new_clock_provide
+gst_message_new_clock_lost
 gst_message_new_custom
+gst_message_new_element
 gst_message_new_eos
 gst_message_new_error
+gst_message_new_new_clock
 gst_message_new_segment_done
 gst_message_new_segment_start
 gst_message_new_state_changed
 gst_message_new_tag
 gst_message_new_warning
+gst_message_parse_clock_lost
+gst_message_parse_clock_provide
 gst_message_parse_error
+gst_message_parse_new_clock
 gst_message_parse_segment_done
 gst_message_parse_segment_start
 gst_message_parse_state_changed

gst/gstelementfactory.c

@@ -487,7 +487,7 @@ gst_element_factory_get_longname (GstElementFactory * factory)
 }
 
 /**
- * gst_element_factory_get_class:
+ * gst_element_factory_get_klass:
  * @factory: a #GstElementFactory
  * 
  * Gets the class for this factory.

gst/gstevent.c

@@ -85,6 +85,14 @@ static GstEventQuarks event_quarks[] = {
   {0, NULL, 0}
 };
 
+/**
+ * gst_event_type_get_name:
+ * @type: the event type
+ *
+ * Get a printable name for the given event type. Do not modify or free.
+ *
+ * Returns: a reference to the static name of the event. 
+ */
 const gchar *
 gst_event_type_get_name (GstEventType type)
 {
@@ -97,6 +105,14 @@ gst_event_type_get_name (GstEventType type)
   return "unknown";
 }
 
+/**
+ * gst_event_type_to_quark:
+ * @type: the event type
+ *
+ * Get the unique quark for the given event type.
+ *
+ * Returns: the quark associated with the event type
+ */
 GQuark
 gst_event_type_to_quark (GstEventType type)
 {

gst/gsttaglist.c

@@ -932,18 +932,343 @@ gst_tag_list_get_ ## name ## _index (const GstTagList *list,		\
 }
 
 #define COPY_FUNC /**/
+/**
+ * gst_tag_list_get_char:
+ * @list: a #GStTagList to get the tag from
+ * @tag: tag to read out
+ * @value: location for the result
+ *
+ * Copies the contents for the given tag into the value, merging multiple values
+ * into one if multiple values are associated with the tag.
+ *
+ * Returns: TRUE, if a value was copied, FALSE if the tag didn't exist in the
+ *	        given list.
+ */
+/**
+ * gst_tag_list_get_char_index:
+ * @list: a #GStTagList to get the tag from
+ * @tag: tag to read out
+ * @index: number of entry to read out
+ * @value: location for the result
+ *
+ * Gets the value that is at the given index for the given tag in the given
+ * list.
+ *
+ * Returns: TRUE, if a value was copied, FALSE if the tag didn't exist in the
+ *	        given list.
+ */
 TAG_MERGE_FUNCS (char, gchar)
+/**
+ * gst_tag_list_get_uchar:
+ * @list: a #GStTagList to get the tag from
+ * @tag: tag to read out
+ * @value: location for the result
+ *
+ * Copies the contents for the given tag into the value, merging multiple values
+ * into one if multiple values are associated with the tag.
+ *
+ * Returns: TRUE, if a value was copied, FALSE if the tag didn't exist in the
+ *	        given list.
+ */
+/**
+ * gst_tag_list_get_uchar_index:
+ * @list: a #GStTagList to get the tag from
+ * @tag: tag to read out
+ * @index: number of entry to read out
+ * @value: location for the result
+ *
+ * Gets the value that is at the given index for the given tag in the given
+ * list.
+ *
+ * Returns: TRUE, if a value was copied, FALSE if the tag didn't exist in the
+ *	        given list.
+ */
 TAG_MERGE_FUNCS (uchar, guchar)
+/**
+ * gst_tag_list_get_boolean:
+ * @list: a #GStTagList to get the tag from
+ * @tag: tag to read out
+ * @value: location for the result
+ *
+ * Copies the contents for the given tag into the value, merging multiple values
+ * into one if multiple values are associated with the tag.
+ *
+ * Returns: TRUE, if a value was copied, FALSE if the tag didn't exist in the
+ *	        given list.
+ */
+/**
+ * gst_tag_list_get_boolean_index:
+ * @list: a #GStTagList to get the tag from
+ * @tag: tag to read out
+ * @index: number of entry to read out
+ * @value: location for the result
+ *
+ * Gets the value that is at the given index for the given tag in the given
+ * list.
+ *
+ * Returns: TRUE, if a value was copied, FALSE if the tag didn't exist in the
+ *	        given list.
+ */
 TAG_MERGE_FUNCS (boolean, gboolean)
+/**
+ * gst_tag_list_get_int:
+ * @list: a #GStTagList to get the tag from
+ * @tag: tag to read out
+ * @value: location for the result
+ *
+ * Copies the contents for the given tag into the value, merging multiple values
+ * into one if multiple values are associated with the tag.
+ *
+ * Returns: TRUE, if a value was copied, FALSE if the tag didn't exist in the
+ *	        given list.
+ */
+/**
+ * gst_tag_list_get_int_index:
+ * @list: a #GStTagList to get the tag from
+ * @tag: tag to read out
+ * @index: number of entry to read out
+ * @value: location for the result
+ *
+ * Gets the value that is at the given index for the given tag in the given
+ * list.
+ *
+ * Returns: TRUE, if a value was copied, FALSE if the tag didn't exist in the
+ *	        given list.
+ */
 TAG_MERGE_FUNCS (int, gint)
+/**
+ * gst_tag_list_get_uint:
+ * @list: a #GStTagList to get the tag from
+ * @tag: tag to read out
+ * @value: location for the result
+ *
+ * Copies the contents for the given tag into the value, merging multiple values
+ * into one if multiple values are associated with the tag.
+ *
+ * Returns: TRUE, if a value was copied, FALSE if the tag didn't exist in the
+ *	        given list.
+ */
+/**
+ * gst_tag_list_get_uint_index:
+ * @list: a #GStTagList to get the tag from
+ * @tag: tag to read out
+ * @index: number of entry to read out
+ * @value: location for the result
+ *
+ * Gets the value that is at the given index for the given tag in the given
+ * list.
+ *
+ * Returns: TRUE, if a value was copied, FALSE if the tag didn't exist in the
+ *	        given list.
+ */
 TAG_MERGE_FUNCS (uint, guint)
+/**
+ * gst_tag_list_get_long:
+ * @list: a #GStTagList to get the tag from
+ * @tag: tag to read out
+ * @value: location for the result
+ *
+ * Copies the contents for the given tag into the value, merging multiple values
+ * into one if multiple values are associated with the tag.
+ *
+ * Returns: TRUE, if a value was copied, FALSE if the tag didn't exist in the
+ *	        given list.
+ */
+/**
+ * gst_tag_list_get_long_index:
+ * @list: a #GStTagList to get the tag from
+ * @tag: tag to read out
+ * @index: number of entry to read out
+ * @value: location for the result
+ *
+ * Gets the value that is at the given index for the given tag in the given
+ * list.
+ *
+ * Returns: TRUE, if a value was copied, FALSE if the tag didn't exist in the
+ *	        given list.
+ */
 TAG_MERGE_FUNCS (long, glong)
+/**
+ * gst_tag_list_get_ulong:
+ * @list: a #GStTagList to get the tag from
+ * @tag: tag to read out
+ * @value: location for the result
+ *
+ * Copies the contents for the given tag into the value, merging multiple values
+ * into one if multiple values are associated with the tag.
+ *
+ * Returns: TRUE, if a value was copied, FALSE if the tag didn't exist in the
+ *	        given list.
+ */
+/**
+ * gst_tag_list_get_ulong_index:
+ * @list: a #GStTagList to get the tag from
+ * @tag: tag to read out
+ * @index: number of entry to read out
+ * @value: location for the result
+ *
+ * Gets the value that is at the given index for the given tag in the given
+ * list.
+ *
+ * Returns: TRUE, if a value was copied, FALSE if the tag didn't exist in the
+ *	        given list.
+ */
 TAG_MERGE_FUNCS (ulong, gulong)
+/**
+ * gst_tag_list_get_int64:
+ * @list: a #GStTagList to get the tag from
+ * @tag: tag to read out
+ * @value: location for the result
+ *
+ * Copies the contents for the given tag into the value, merging multiple values
+ * into one if multiple values are associated with the tag.
+ *
+ * Returns: TRUE, if a value was copied, FALSE if the tag didn't exist in the
+ *	        given list.
+ */
+/**
+ * gst_tag_list_get_int64_index:
+ * @list: a #GStTagList to get the tag from
+ * @tag: tag to read out
+ * @index: number of entry to read out
+ * @value: location for the result
+ *
+ * Gets the value that is at the given index for the given tag in the given
+ * list.
+ *
+ * Returns: TRUE, if a value was copied, FALSE if the tag didn't exist in the
+ *	        given list.
+ */
 TAG_MERGE_FUNCS (int64, gint64)
+/**
+ * gst_tag_list_get_uint64:
+ * @list: a #GStTagList to get the tag from
+ * @tag: tag to read out
+ * @value: location for the result
+ *
+ * Copies the contents for the given tag into the value, merging multiple values
+ * into one if multiple values are associated with the tag.
+ *
+ * Returns: TRUE, if a value was copied, FALSE if the tag didn't exist in the
+ *	        given list.
+ */
+/**
+ * gst_tag_list_get_uint64_index:
+ * @list: a #GStTagList to get the tag from
+ * @tag: tag to read out
+ * @index: number of entry to read out
+ * @value: location for the result
+ *
+ * Gets the value that is at the given index for the given tag in the given
+ * list.
+ *
+ * Returns: TRUE, if a value was copied, FALSE if the tag didn't exist in the
+ *	        given list.
+ */
 TAG_MERGE_FUNCS (uint64, guint64)
+/**
+ * gst_tag_list_get_float:
+ * @list: a #GStTagList to get the tag from
+ * @tag: tag to read out
+ * @value: location for the result
+ *
+ * Copies the contents for the given tag into the value, merging multiple values
+ * into one if multiple values are associated with the tag.
+ *
+ * Returns: TRUE, if a value was copied, FALSE if the tag didn't exist in the
+ *	        given list.
+ */
+/**
+ * gst_tag_list_get_float_index:
+ * @list: a #GStTagList to get the tag from
+ * @tag: tag to read out
+ * @index: number of entry to read out
+ * @value: location for the result
+ *
+ * Gets the value that is at the given index for the given tag in the given
+ * list.
+ *
+ * Returns: TRUE, if a value was copied, FALSE if the tag didn't exist in the
+ *	        given list.
+ */
 TAG_MERGE_FUNCS (float, gfloat)
+/**
+ * gst_tag_list_get_double:
+ * @list: a #GStTagList to get the tag from
+ * @tag: tag to read out
+ * @value: location for the result
+ *
+ * Copies the contents for the given tag into the value, merging multiple values
+ * into one if multiple values are associated with the tag.
+ *
+ * Returns: TRUE, if a value was copied, FALSE if the tag didn't exist in the
+ *	        given list.
+ */
+/**
+ * gst_tag_list_get_double_index:
+ * @list: a #GStTagList to get the tag from
+ * @tag: tag to read out
+ * @index: number of entry to read out
+ * @value: location for the result
+ *
+ * Gets the value that is at the given index for the given tag in the given
+ * list.
+ *
+ * Returns: TRUE, if a value was copied, FALSE if the tag didn't exist in the
+ *	        given list.
+ */
 TAG_MERGE_FUNCS (double, gdouble)
+/**
+ * gst_tag_list_get_pointer:
+ * @list: a #GStTagList to get the tag from
+ * @tag: tag to read out
+ * @value: location for the result
+ *
+ * Copies the contents for the given tag into the value, merging multiple values
+ * into one if multiple values are associated with the tag.
+ *
+ * Returns: TRUE, if a value was copied, FALSE if the tag didn't exist in the
+ *	        given list.
+ */
+/**
+ * gst_tag_list_get_pointer_index:
+ * @list: a #GStTagList to get the tag from
+ * @tag: tag to read out
+ * @index: number of entry to read out
+ * @value: location for the result
+ *
+ * Gets the value that is at the given index for the given tag in the given
+ * list.
+ *
+ * Returns: TRUE, if a value was copied, FALSE if the tag didn't exist in the
+ *	        given list.
+ */
 TAG_MERGE_FUNCS (pointer, gpointer)
 #undef COPY_FUNC
 #define COPY_FUNC g_strdup
+/**
+ * gst_tag_list_get_string:
+ * @list: a #GStTagList to get the tag from
+ * @tag: tag to read out
+ * @value: location for the result
+ *
+ * Copies the contents for the given tag into the value, merging multiple values
+ * into one if multiple values are associated with the tag.
+ *
+ * Returns: TRUE, if a value was copied, FALSE if the tag didn't exist in the
+ *	        given list.
+ */
+/**
+ * gst_tag_list_get_string_index:
+ * @list: a #GStTagList to get the tag from
+ * @tag: tag to read out
+ * @index: number of entry to read out
+ * @value: location for the result
+ *
+ * Gets the value that is at the given index for the given tag in the given
+ * list.
+ *
+ * Returns: TRUE, if a value was copied, FALSE if the tag didn't exist in the
+ *	        given list.
+ */
 TAG_MERGE_FUNCS (string, gchar *)