Documentation updates

Original commit message from CVS:
Documentation updates

diff --git a/docs/gst/gstreamer-sections.txt b/docs/gst/gstreamer-sections.txt
index 8b790bc..e68939f 100644 (file)
--- a/docs/gst/gstreamer-sections.txt
+++ b/docs/gst/gstreamer-sections.txt
@@ -37,26 +37,37 @@ gst_main_quit
 <SECTION>
 <FILE>gstinfo</FILE>
 <TITLE>gstinfo</TITLE>
-GST_DEBUG_ENABLED
-GST_DEBUG_PREFIX
-DEBUG
-DEBUG_NOPREFIX
-DEBUG_ENTER
-DEBUG_SET_STRING
-DEBUG_ENTER_STRING
-DEBUG_LEAVE
-DEBUG_LEAVE_STRING
-GST_DEBUG_PAD_NAME
+gst_get_category_name
+gst_info_get_categories
+gst_info_set_categories
+gst_info_enable_category
+gst_info_disable_category
+gst_default_info_handler
+GST_INFO_ENABLED
+GST_INFO
+GST_INFO_ELEMENT
+gst_debug_get_categories
+gst_debug_set_categories
+gst_debug_enable_category
+gst_debug_disable_category
+GST_DEBUG_SET_STRING
+GST_DEBUG_ENTER
+GST_DEBUG_ENTER_STRING
+GST_DEBUG_LEAVE
+GST_DEBUG_LEAVE_STRING
+GST_DEBUG_NOPREFIX
+GST_DEBUG
+GST_DEBUG_ENABLE_CATEGORIES
 GST_DEBUG_FUNCPTR
+GST_DEBUG_PREFIX
+GST_DEBUG_ENABLED
 GST_DEBUG_FUNCPTR_NAME
+GST_DEBUG_PAD_NAME
+GST_ERROR
+GST_ERROR_OBJECT
+gst_default_error_handler
 GstInfoHandler
-gst_default_info_handler
-INFO
-INFO_ELEMENT
 GstErrorHandler
-gst_default_error_handler
-ERROR
-ERROR_OBJECT
 </SECTION>
 
 <SECTION>
@@ -183,6 +194,7 @@ gst_element_get_pad
 gst_element_get_pad_list
 gst_element_get_padtemplate_list
 gst_element_add_ghost_pad
+gst_element_remove_ghost_pad
 gst_element_connect
 gst_element_set_state
 gst_element_error
@@ -292,6 +304,7 @@ GstPadChainFunction
 GstPadGetFunction
 GstPadGetRegionFunction
 GstPadQoSFunction
+GstPadEOSFunction
 
 GstPadPushFunction
 GstPadPullFunction
@@ -307,6 +320,7 @@ gst_pad_set_chain_function
 gst_pad_set_get_function
 gst_pad_set_getregion_function
 gst_pad_set_qos_function
+gst_pad_set_eos_function
 gst_pad_set_caps_list
 gst_pad_get_caps_list
 gst_pad_get_caps_by_name
@@ -326,6 +340,8 @@ gst_pad_pull
 gst_pad_pull_region
 gst_pad_pullregion
 gst_pad_handle_qos
+gst_pad_set_eos
+gst_pad_eos
 gst_pad_save_thyself
 gst_pad_load_and_connect
 

diff --git a/docs/gst/tmpl/gstelement.sgml b/docs/gst/tmpl/gstelement.sgml
index f9aadd3..aed2653 100644 (file)
--- a/docs/gst/tmpl/gstelement.sgml
+++ b/docs/gst/tmpl/gstelement.sgml
@@ -298,6 +298,15 @@ circumstances.
 @pad: 
 
 
+<!-- ##### FUNCTION gst_element_remove_ghost_pad ##### -->
+<para>
+
+</para>
+
+@element: 
+@pad: 
+
+
 <!-- ##### FUNCTION gst_element_connect ##### -->
 <para>
 

diff --git a/docs/gst/tmpl/gstinfo.sgml b/docs/gst/tmpl/gstinfo.sgml
index 3b7e534..15ac814 100644 (file)
--- a/docs/gst/tmpl/gstinfo.sgml
+++ b/docs/gst/tmpl/gstinfo.sgml
@@ -15,47 +15,48 @@ to your application.
 
 </para>
 
-<!-- ##### MACRO GST_DEBUG_ENABLED ##### -->
+<!-- ##### FUNCTION gst_get_category_name ##### -->
 <para>
 
 </para>
 
+@category: 
+@Returns: 
 
 
-<!-- ##### MACRO GST_DEBUG_PREFIX ##### -->
+<!-- ##### FUNCTION gst_info_get_categories ##### -->
 <para>
 
 </para>
 
-@format: 
-@args...: 
+@Returns: 
 
 
-<!-- ##### MACRO GST_DEBUG_PAD_NAME ##### -->
+<!-- ##### FUNCTION gst_info_set_categories ##### -->
 <para>
 
 </para>
 
-@pad: 
+@categories: 
 
 
-<!-- ##### MACRO GST_DEBUG_FUNCPTR ##### -->
+<!-- ##### FUNCTION gst_info_enable_category ##### -->
 <para>
 
 </para>
 
-@ptr: 
+@category: 
 
 
-<!-- ##### MACRO GST_DEBUG_FUNCPTR_NAME ##### -->
+<!-- ##### FUNCTION gst_info_disable_category ##### -->
 <para>
 
 </para>
 
-@ptr: 
+@category: 
 
 
-<!-- ##### USER_FUNCTION GstInfoHandler ##### -->
+<!-- ##### FUNCTION gst_default_info_handler ##### -->
 <para>
 
 </para>
@@ -69,35 +70,224 @@ to your application.
 @string: 
 
 
-<!-- ##### FUNCTION gst_default_info_handler ##### -->
+<!-- ##### MACRO GST_INFO_ENABLED ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO GST_INFO ##### -->
+<para>
+
+</para>
+
+@cat: 
+@format: 
+@args...: 
+
+
+<!-- ##### MACRO GST_INFO_ELEMENT ##### -->
+<para>
+
+</para>
+
+@cat: 
+@element: 
+@format: 
+@args...: 
+
+
+<!-- ##### FUNCTION gst_debug_get_categories ##### -->
+<para>
+
+</para>
+
+@Returns: 
+
+
+<!-- ##### FUNCTION gst_debug_set_categories ##### -->
+<para>
+
+</para>
+
+@categories: 
+
+
+<!-- ##### FUNCTION gst_debug_enable_category ##### -->
+<para>
+
+</para>
+
+@category: 
+
+
+<!-- ##### FUNCTION gst_debug_disable_category ##### -->
 <para>
 
 </para>
 
 @category: 
+
+
+<!-- ##### MACRO GST_DEBUG_SET_STRING ##### -->
+<para>
+
+</para>
+
+@format: 
+@args...: 
+
+
+<!-- ##### MACRO GST_DEBUG_ENTER ##### -->
+<para>
+
+</para>
+
+@format: 
+@args...: 
+
+
+<!-- ##### MACRO GST_DEBUG_ENTER_STRING ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO GST_DEBUG_LEAVE ##### -->
+<para>
+
+</para>
+
+@format: 
+@args...: 
+
+
+<!-- ##### MACRO GST_DEBUG_LEAVE_STRING ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO GST_DEBUG_NOPREFIX ##### -->
+<para>
+
+</para>
+
+@cat: 
+@format: 
+@args...: 
+
+
+<!-- ##### MACRO GST_DEBUG ##### -->
+<para>
+
+</para>
+
+@cat: 
+@format: 
+@args...: 
+
+
+<!-- ##### MACRO GST_DEBUG_ENABLE_CATEGORIES ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO GST_DEBUG_FUNCPTR ##### -->
+<para>
+
+</para>
+
+@ptr: 
+
+
+<!-- ##### MACRO GST_DEBUG_PREFIX ##### -->
+<para>
+
+</para>
+
+@format: 
+@args...: 
+
+
+<!-- ##### MACRO GST_DEBUG_ENABLED ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO GST_DEBUG_FUNCPTR_NAME ##### -->
+<para>
+
+</para>
+
+@ptr: 
+
+
+<!-- ##### MACRO GST_DEBUG_PAD_NAME ##### -->
+<para>
+
+</para>
+
+@pad: 
+
+
+<!-- ##### MACRO GST_ERROR ##### -->
+<para>
+
+</para>
+
+@element: 
+@format: 
+@args...: 
+
+
+<!-- ##### MACRO GST_ERROR_OBJECT ##### -->
+<para>
+
+</para>
+
+@element: 
+@object: 
+@format: 
+@args...: 
+
+
+<!-- ##### FUNCTION gst_default_error_handler ##### -->
+<para>
+
+</para>
+
 @file: 
 @function: 
 @line: 
 @debug_string: 
 @element: 
+@object: 
 @string: 
 
 
-<!-- ##### USER_FUNCTION GstErrorHandler ##### -->
+<!-- ##### USER_FUNCTION GstInfoHandler ##### -->
 <para>
 
 </para>
 
+@category: 
 @file: 
 @function: 
 @line: 
 @debug_string: 
 @element: 
-@object: 
 @string: 
 
 
-<!-- ##### FUNCTION gst_default_error_handler ##### -->
+<!-- ##### USER_FUNCTION GstErrorHandler ##### -->
 <para>
 
 </para>

diff --git a/docs/gst/tmpl/gstpad.sgml b/docs/gst/tmpl/gstpad.sgml
index 3da1deb..ea558d5 100644 (file)
--- a/docs/gst/tmpl/gstpad.sgml
+++ b/docs/gst/tmpl/gstpad.sgml
@@ -76,6 +76,15 @@ the function that will be called when a QoS message is sent.
 @qos_message: the message
 
 
+<!-- ##### USER_FUNCTION GstPadEOSFunction ##### -->
+<para>
+
+</para>
+
+@pad: 
+@Returns: 
+
+
 <!-- ##### USER_FUNCTION GstPadPushFunction ##### -->
 <para>
 
@@ -197,6 +206,15 @@ Destroy the pad
 @qos: 
 
 
+<!-- ##### FUNCTION gst_pad_set_eos_function ##### -->
+<para>
+
+</para>
+
+@pad: 
+@eos: 
+
+
 <!-- ##### FUNCTION gst_pad_set_caps_list ##### -->
 <para>
 
@@ -373,6 +391,23 @@ Destroy the pad
 @qos_message: 
 
 
+<!-- ##### FUNCTION gst_pad_set_eos ##### -->
+<para>
+
+</para>
+
+@pad: 
+@Returns: 
+
+
+<!-- ##### MACRO gst_pad_eos ##### -->
+<para>
+
+</para>
+
+@pad: 
+
+
 <!-- ##### FUNCTION gst_pad_save_thyself ##### -->
 <para>
 

diff --git a/docs/gst/tmpl/gstreamer-unused.sgml b/docs/gst/tmpl/gstreamer-unused.sgml
index 908b65a..5434c6d 100644 (file)
--- a/docs/gst/tmpl/gstreamer-unused.sgml
+++ b/docs/gst/tmpl/gstreamer-unused.sgml
@@ -878,18 +878,18 @@ This macro unsets the given state on the element.
 @obj: Element to unset state of.
 @flag: State to unset, can be any number of bits in guint32.
 
-<!-- ##### STRUCT GstDiskSrc ##### -->
+<!-- ##### MACRO GST_SRC_FLAGS ##### -->
 <para>
-
+This macro returns the entire set of flags for the object.
 </para>
 
+@obj: GstSrc to return flags for.
 
-<!-- ##### MACRO GST_SRC_FLAGS ##### -->
+<!-- ##### STRUCT GstDiskSrc ##### -->
 <para>
-This macro returns the entire set of flags for the object.
+
 </para>
 
-@obj: GstSrc to return flags for.
 
 <!-- ##### FUNCTION gst_sink_get_type ##### -->
 <para>
@@ -1738,19 +1738,19 @@ Flags for the GstSrc element
 
 @Returns: 
 
-<!-- ##### TYPEDEF GstPropsListFactory[] ##### -->
+<!-- ##### FUNCTION gst_pad_get_type_id ##### -->
 <para>
 
 </para>
 
+@pad: 
+@Returns: 
 
-<!-- ##### FUNCTION gst_pad_get_type_id ##### -->
+<!-- ##### TYPEDEF GstPropsListFactory[] ##### -->
 <para>
 
 </para>
 
-@pad: 
-@Returns: 
 
 <!-- ##### SECTION ./tmpl/gstsink.sgml:See_Also ##### -->
 <para>

diff --git a/gst/gstelement.c b/gst/gstelement.c
index 4197e6c..f2948de 100644 (file)
--- a/gst/gstelement.c
+++ b/gst/gstelement.c
@@ -201,6 +201,14 @@ gst_element_add_ghost_pad (GstElement *element, GstPad *pad)
   gtk_signal_emit (GTK_OBJECT (element), gst_element_signals[NEW_GHOST_PAD], pad);
 }
 
+/**
+ * gst_element_remove_ghost_pad:
+ * @element: element to remove the ghost pad from
+ * @pad: ghost pad to remove
+ *
+ * removes a ghost pad from an element
+ * 
+ */
 void
 gst_element_remove_ghost_pad (GstElement *element, GstPad *pad)
 {

diff --git a/gst/gstpad.c b/gst/gstpad.c
index 8efb2f4..87e5e71 100644 (file)
--- a/gst/gstpad.c
+++ b/gst/gstpad.c
@@ -347,7 +347,7 @@ gst_pad_set_qos_function (GstPad *pad,
 /**
  * gst_pad_set_eos_function:
  * @pad: the pad to set the eos function for
- * @qos: the eos function
+ * @eos: the eos function
  *
  * Set the given EOS function for the pad
  */
@@ -1080,6 +1080,14 @@ gst_pad_eos_func(GstPad *pad)
   return TRUE;
 }
 
+/**
+ * gst_pad_set_eos:
+ * @pad: the pad to set to eos
+ *
+ * sets the given pad to the  eos state
+ *
+ * Returns: TRUE if it succeeded
+ */
 gboolean
 gst_pad_set_eos(GstPad *pad) 
 {