Fix unused args
authorWim Taymans <wim.taymans@gmail.com>
Sat, 14 Dec 2002 16:32:28 +0000 (16:32 +0000)
committerWim Taymans <wim.taymans@gmail.com>
Sat, 14 Dec 2002 16:32:28 +0000 (16:32 +0000)
Original commit message from CVS:
Fix unused args

docs/gst/tmpl/gstbuffer.sgml
docs/gst/tmpl/gstbufferpool.sgml
docs/gst/tmpl/gstcaps.sgml
docs/gst/tmpl/gstelement.sgml
docs/gst/tmpl/gstinfo.sgml
docs/gst/tmpl/gstobject.sgml
docs/gst/tmpl/gstpad.sgml
docs/gst/tmpl/gstpadtemplate.sgml
docs/gst/tmpl/gstparse.sgml
docs/gst/tmpl/gstplugin.sgml
docs/gst/tmpl/gstprops.sgml

index f296bc6..17a6908 100644 (file)
@@ -364,10 +364,8 @@ created buffer can be safely written to.
 If the refcount is 1, this function just returns the original buffer.
 </para>
 
-@buf: 
+@buf: a #GstBuffer to copy
 @Returns: the #GstBuffer that can safely be written to.
-<!-- # Unused Parameters # -->
-@buffer: a #GstBuffer to copy.
 
 
 <!-- ##### MACRO gst_buffer_free ##### -->
@@ -377,8 +375,7 @@ It is dangerous to use this function, you should use gst_buffer_unref() instead.
 </para>
 
 @buf: 
-<!-- # Unused Parameters # -->
-@buffer: a #GstBuffer to free.
+@buf: a #GstBuffer to free.
 
 
 <!-- ##### FUNCTION gst_buffer_create_sub ##### -->
index ab6a35f..f3c3780 100644 (file)
@@ -228,9 +228,6 @@ Free the given pool. This is dangerous, use gst_buffer_pool_unref() instead.
 @buffer_size: 
 @pool_size: 
 @Returns: 
-<!-- # Unused Parameters # -->
-@size: 
-@numbuffers: 
 
 
 <!-- ##### FUNCTION gst_buffer_pool_default_free ##### -->
index 6f41646..09b810b 100644 (file)
@@ -125,9 +125,7 @@ A convenience macro to create a new GstCaps structure.
 
 @name: the name of the caps structure
 @type: the mime type of the caps structure
-@...: 
-<!-- # Unused Parameters # -->
-@a...: the properties of this caps stucture.
+@...: the properties of this caps stucture.
 
 
 <!-- ##### MACRO GST_CAPS_FACTORY ##### -->
@@ -136,9 +134,7 @@ A convenience macro to create a GstCaps factory.
 </para>
 
 @factoryname: the name of the factory
-@...: 
-<!-- # Unused Parameters # -->
-@a...: the caps to create with this factory, usualy specified
+@...: the caps to create with this factory, usualy specified
 with GST_CAPS_NEW()
 
 
@@ -409,10 +405,7 @@ Set a property of a caps structure.
 </para>
 
 @caps: the caps structure to modify
-@...: 
-<!-- # Unused Parameters # -->
-@name: the name of the property to change
-@args...: the new value of the property
+@...: the new value of the property
 
 
 <!-- ##### MACRO gst_caps_get ##### -->
@@ -421,10 +414,7 @@ Get key/value pairs from the given GstCaps.
 </para>
 
 @caps: the caps to get the values from
-@...: 
-<!-- # Unused Parameters # -->
-@name: the name of the first key
-@args...: a pointer to the variable that can hold the result followed by more key/value pairs.
+@...: a pointer to the variable that can hold the result followed by more key/value pairs.
 
 
 <!-- ##### FUNCTION gst_caps_intersect ##### -->
index af0ab16..12b5388 100644 (file)
@@ -91,8 +91,6 @@ Gets the name of the element.
 
 
 <!-- connection -->
-<!-- # Unused Parameters # -->
-@element: a #GstElement to get the name of.
 
 
 <!-- ##### MACRO gst_element_set_name ##### -->
@@ -100,10 +98,8 @@ Gets the name of the element.
 Sets the name of the element, getting rid of the old name if there was one.
 </para>
 
-@elem: 
+@elem: a #GstElement to set the name of.
 @name: the new name of the element.
-<!-- # Unused Parameters # -->
-@element: a #GstElement to set the name of.
 
 
 <!-- ##### FUNCTION gst_element_get_factory ##### -->
@@ -234,8 +230,6 @@ Sets the name of the element, getting rid of the old name if there was one.
 
 @klass: 
 @templ: 
-<!-- # Unused Parameters # -->
-@element: 
 
 
 <!-- ##### FUNCTION gst_element_connect ##### -->
@@ -302,9 +296,6 @@ Sets the name of the element, getting rid of the old name if there was one.
 
 @src: 
 @dest: 
-<!-- # Unused Parameters # -->
-@srcpadname: 
-@destpadname: 
 
 
 <!-- ##### FUNCTION gst_element_disconnect_many ##### -->
@@ -379,8 +370,6 @@ Sets the name of the element, getting rid of the old name if there was one.
 
 @element: 
 @Returns: 
-<!-- # Unused Parameters # -->
-@elem: 
 
 
 <!-- ##### FUNCTION gst_element_state_get_name ##### -->
@@ -561,10 +550,8 @@ circumstances.
 Gets the parent of an element.
 </para>
 
-@elem: 
+@elem: a #GstElement to get the parent of.
 @Returns: the #GstObject parent of the element.
-<!-- # Unused Parameters # -->
-@element: a #GstElement to get the parent of.
 
 
 <!-- ##### MACRO gst_element_set_parent ##### -->
@@ -572,10 +559,8 @@ Gets the parent of an element.
 Sets the parent of an element.
 </para>
 
-@elem: 
+@elem: a #GstElement to set the parent of.
 @parent:  the new #GstObject parent of the object.
-<!-- # Unused Parameters # -->
-@element: a #GstElement to set the parent of.
 
 
 <!-- ##### FUNCTION gst_element_get_managing_bin ##### -->
index ba6a291..a53e974 100644 (file)
@@ -100,10 +100,7 @@ Print out any information usable at run-time by application developers.
 </para>
 
 @cat: the GST_CAT_... category for the information
-@...: 
-<!-- # Unused Parameters # -->
-@format: printf-style format string
-@args...: printf arguments
+@...: printf arguments
 
 
 <!-- ##### MACRO GST_INFO_ELEMENT ##### -->
@@ -113,10 +110,7 @@ Print out information like #GST_INFO, but with an element pointer to clarify thi
 
 @cat: the GST_CAT_... category for the information
 @element: pointer to the #GstElement in question
-@...: 
-<!-- # Unused Parameters # -->
-@format: printf-style format string
-@args...: printf arguments
+@...: printf arguments
 
 
 <!-- ##### FUNCTION gst_debug_get_categories ##### -->
@@ -157,10 +151,7 @@ Called at the beginning of a function, it simply prints out a DEBUG string of "e
 in addition to the given string.
 </para>
 
-@...: 
-<!-- # Unused Parameters # -->
-@format: printf-style format string
-@args...: printf arguments
+@...: printf arguments
 
 
 <!-- ##### MACRO GST_DEBUG_LEAVE ##### -->
@@ -169,10 +160,7 @@ Called at the end of a function, it simply prints out a DEBUG string of "leaving
 in addition to the given string.
 </para>
 
-@...: 
-<!-- # Unused Parameters # -->
-@format: printf-stype format string
-@args...: printf arguments
+@...: printf arguments
 
 
 <!-- ##### MACRO GST_DEBUG ##### -->
@@ -181,10 +169,7 @@ Print out debugging information.
 </para>
 
 @cat: the GST_CAT_... the debug falls within
-@...: 
-<!-- # Unused Parameters # -->
-@format: printf-style format string
-@args...: printf arguments
+@...: printf arguments
 
 
 <!-- ##### MACRO GST_DEBUG_FUNCPTR ##### -->
@@ -234,10 +219,7 @@ Print out usefull debugging info of an element.
 
 @cat: The category of this debugging statement.
 @element: The element to debug.
-@...: 
-<!-- # Unused Parameters # -->
-@format: A printf-like string.
-@args...: The argument for the printf-like string.
+@...: printf arguments
 
 
 <!-- ##### MACRO GST_ERROR ##### -->
@@ -246,10 +228,7 @@ Print out an error condition and abort the application.
 </para>
 
 @element: the #GstElement in question
-@...: 
-<!-- # Unused Parameters # -->
-@format: printf-style format string
-@args...: printf arguments
+@...: printf arguments
 
 
 <!-- ##### MACRO GST_ERROR_OBJECT ##### -->
@@ -259,10 +238,7 @@ Print out an error condition and abort the application.
 
 @element: the #GstElement in question
 @object: pointer to a 'contributing' object
-@...: 
-<!-- # Unused Parameters # -->
-@format: printf-style format string
-@args...: printf arguments
+@...: printf arguments
 
 
 <!-- ##### USER_FUNCTION GstDebugHandler ##### -->
index 0eb20f9..a701b6f 100644 (file)
@@ -245,8 +245,6 @@ Check if the object has been destroyed.
 
 @object: 
 @self: 
-<!-- # Unused Parameters # -->
-@parent: 
 
 
 <!-- ##### FUNCTION gst_object_get_path_string ##### -->
index 0f607dc..698a74c 100644 (file)
@@ -421,8 +421,6 @@ Destroy the pad.
 @templ: 
 @name: 
 @Returns: 
-<!-- # Unused Parameters # -->
-@temp: 
 
 
 <!-- ##### FUNCTION gst_pad_get_direction ##### -->
@@ -637,8 +635,6 @@ Destroy the pad.
 @sinkpad: 
 @filtercaps: 
 @Returns: 
-<!-- # Unused Parameters # -->
-@pad: 
 
 
 <!-- ##### FUNCTION gst_pad_try_reconnect_filtered ##### -->
@@ -650,8 +646,6 @@ Destroy the pad.
 @sinkpad: 
 @filtercaps: 
 @Returns: 
-<!-- # Unused Parameters # -->
-@pad: 
 
 
 <!-- ##### FUNCTION gst_pad_disconnect ##### -->
@@ -691,8 +685,6 @@ Destroy the pad.
 
 @pad: 
 @buf: 
-<!-- # Unused Parameters # -->
-@buffer: 
 
 
 <!-- ##### FUNCTION gst_pad_pull ##### -->
@@ -720,9 +712,6 @@ Destroy the pad.
 
 @self: 
 @parent: 
-<!-- # Unused Parameters # -->
-@element: 
-@elements: 
 
 
 <!-- ##### FUNCTION gst_pad_proxy_connect ##### -->
@@ -957,8 +946,6 @@ Destroy the pad.
 
 @pad: 
 @formats: 
-<!-- # Unused Parameters # -->
-@format: 
 
 
 <!-- ##### FUNCTION gst_pad_get_internal_connections ##### -->
@@ -1046,8 +1033,6 @@ Destroy the pad.
 
 @pad: 
 @type_func: 
-<!-- # Unused Parameters # -->
-@type_function: 
 
 
 <!-- ##### MACRO gst_pad_add_probe ##### -->
index 4e1429c..ad690b3 100644 (file)
@@ -127,9 +127,7 @@ Create a new padtemplate.
 @padname: the nametemplate for the pads that will be created with this template
 @dir: the direction of the pads.
 @pres: the presence of the pads.
-@...: 
-<!-- # Unused Parameters # -->
-@a...: the capabilities of this padtemplate usually created with GST_CAPS_NEW()
+@...: the capabilities of this padtemplate usually created with GST_CAPS_NEW()
 
 
 <!-- ##### MACRO GST_PAD_TEMPLATE_FACTORY ##### -->
@@ -142,9 +140,7 @@ of the padtemplate. Use GST_PAD_TEMPLATE_GET() to get the unique padtemplate.
 @padname: the nametemplate of the pads
 @dir: the direction of the pads.
 @pres: the presence of the pads.
-@...: 
-<!-- # Unused Parameters # -->
-@a...: the capabilities of this padtemplate, usually created with GST_CAPS_NEW()
+@...: the capabilities of this padtemplate, usually created with GST_CAPS_NEW()
 
 
 <!-- ##### MACRO GST_PAD_TEMPLATE_GET ##### -->
index e7e2510..dce121b 100644 (file)
@@ -77,9 +77,6 @@ Get the error quark passed in the GError messages.
 @pipeline_description: 
 @error: 
 @Returns: 
-<!-- # Unused Parameters # -->
-@cmdline: 
-@parent: 
 
 
 <!-- ##### FUNCTION gst_parse_launchv ##### -->
index 4c5fe06..bd8e9ba 100644 (file)
@@ -134,10 +134,6 @@ A macro used to define a statically linked plugin.
 
 @filename: 
 @Returns: 
-<!-- # Unused Parameters # -->
-@name: 
-@major: 
-@minor: 
 
 
 <!-- ##### FUNCTION gst_plugin_set_name ##### -->
index 3454c61..4358f3a 100644 (file)
@@ -299,9 +299,6 @@ An entry hols one key/value pair.
 @name: 
 @Varargs: 
 @Returns: 
-<!-- # Unused Parameters # -->
-@entry: 
-@value: 
 
 
 <!-- ##### FUNCTION gst_props_get ##### -->
@@ -431,8 +428,6 @@ An entry hols one key/value pair.
 @entry: 
 @Varargs: 
 @Returns: 
-<!-- # Unused Parameters # -->
-@props: 
 
 
 <!-- ##### FUNCTION gst_props_entry_get_boolean ##### -->