From 339012e03386e570eafdff38d1cd4c9358c95b43 Mon Sep 17 00:00:00 2001 From: Thomas Vander Stichele Date: Wed, 7 Jan 2004 16:32:24 +0000 Subject: [PATCH] fix up docs remove props commit automatic moving and removing of documentation Original commit message from CVS: fix up docs remove props commit automatic moving and removing of documentation --- ChangeLog | 19 ++ docs/gst/gstreamer-docs.sgml | 2 - docs/gst/gstreamer-sections.txt | 3 +- docs/gst/tmpl/gst.sgml | 22 ++ docs/gst/tmpl/gstbin.sgml | 56 ++-- docs/gst/tmpl/gstbuffer.sgml | 11 - docs/gst/tmpl/gstcaps.sgml | 409 +--------------------------- docs/gst/tmpl/gstclock.sgml | 20 +- docs/gst/tmpl/gstelement.sgml | 104 +++---- docs/gst/tmpl/gstindex.sgml | 26 +- docs/gst/tmpl/gstobject.sgml | 82 +++--- docs/gst/tmpl/gstpad.sgml | 63 +---- docs/gst/tmpl/gstpadtemplate.sgml | 53 +--- docs/gst/tmpl/gstreamer-unused.sgml | 38 +-- docs/gst/tmpl/gstthread.sgml | 18 +- docs/gst/tmpl/gstxml.sgml | 22 ++ 16 files changed, 272 insertions(+), 676 deletions(-) diff --git a/ChangeLog b/ChangeLog index 4dd9d433df..1c3aa6ef96 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,22 @@ +2004-01-07 Thomas Vander Stichele + + * docs/gst/gstreamer-docs.sgml: remove props + * docs/gst/gstreamer-sections.txt: remove props + * docs/gst/tmpl/gst.sgml: + * docs/gst/tmpl/gstbin.sgml: + * docs/gst/tmpl/gstbuffer.sgml: + * docs/gst/tmpl/gstcaps.sgml: + * docs/gst/tmpl/gstclock.sgml: + * docs/gst/tmpl/gstelement.sgml: + * docs/gst/tmpl/gstindex.sgml: + * docs/gst/tmpl/gstobject.sgml: + * docs/gst/tmpl/gstpad.sgml: + * docs/gst/tmpl/gstpadtemplate.sgml: + * docs/gst/tmpl/gstreamer-unused.sgml: + * docs/gst/tmpl/gstthread.sgml: + * docs/gst/tmpl/gstxml.sgml: + sync with code reorganization + 2004-01-07 Jan Schmidt * gst/gstelement.c: (gst_element_get_compatible_pad_filtered): diff --git a/docs/gst/gstreamer-docs.sgml b/docs/gst/gstreamer-docs.sgml index 6b667c5c39..7f2bb8873e 100644 --- a/docs/gst/gstreamer-docs.sgml +++ b/docs/gst/gstreamer-docs.sgml @@ -31,7 +31,6 @@ - @@ -102,7 +101,6 @@ with some more specialized elements. &GstPlugin; &GstPluginFeature; &GstProbe; - &GstProps; &GstQuery; diff --git a/docs/gst/gstreamer-sections.txt b/docs/gst/gstreamer-sections.txt index b187dcc635..c269c26d8f 100644 --- a/docs/gst/gstreamer-sections.txt +++ b/docs/gst/gstreamer-sections.txt @@ -55,9 +55,10 @@ gst_mem_chunk_free gst Gst gst_init +gst_init_get_popt_table gst_init_with_popt_table gst_init_check -gst_init_get_popt_table +gst_init_check_with_popt_table gst_version gst_main gst_main_quit diff --git a/docs/gst/tmpl/gst.sgml b/docs/gst/tmpl/gst.sgml index 6a518c69e6..46383192d7 100644 --- a/docs/gst/tmpl/gst.sgml +++ b/docs/gst/tmpl/gst.sgml @@ -90,6 +90,14 @@ pipeline and Microsoft's DirectShow for some background. @argv: + + + + + +@Returns: + + @@ -99,6 +107,7 @@ pipeline and Microsoft's DirectShow for some background. @argv: @popt_options: +@Param3: @Returns: @@ -112,6 +121,19 @@ pipeline and Microsoft's DirectShow for some background. @Returns: + + + + + +@argc: +@argv: +@popt_options: +@Returns: + +@Param3: + + diff --git a/docs/gst/tmpl/gstbin.sgml b/docs/gst/tmpl/gstbin.sgml index 8a0038e0b9..68c62da4bc 100644 --- a/docs/gst/tmpl/gstbin.sgml +++ b/docs/gst/tmpl/gstbin.sgml @@ -72,34 +72,6 @@ The GstBin object - - - - - -@gstbin: the object which received the signal. -@arg1: the element that was added to the bin - - - - - - -@gstbin: the object which received the signal. -@arg1: the element that was removed from the bin - - - -This signal is emitted when a bin iterates, either automatically or -due to a #gst_bin_iterate() call. The return value is used to -determine if the object method handler processed any data. -In most normal cases, a user-provided signal handler should return -FALSE. - - -@gstbin: the object which received the signal. -@Returns: TRUE if the state of the bin was advanced. - The signature of the callback for the post and pre iterate function as set with @@ -252,3 +224,31 @@ gst_bin_set_pre_iterate_function() and gst_bin_set_post_iterate_function(). @clock: + + + + + +@gstbin: the object which received the signal. +@arg1: the element that was added to the bin + + + + + + +@gstbin: the object which received the signal. +@arg1: the element that was removed from the bin + + + +This signal is emitted when a bin iterates, either automatically or +due to a #gst_bin_iterate() call. The return value is used to +determine if the object method handler processed any data. +In most normal cases, a user-provided signal handler should return +FALSE. + + +@gstbin: the object which received the signal. +@Returns: TRUE if the state of the bin was advanced. + diff --git a/docs/gst/tmpl/gstbuffer.sgml b/docs/gst/tmpl/gstbuffer.sgml index 38ced90965..58df097f49 100644 --- a/docs/gst/tmpl/gstbuffer.sgml +++ b/docs/gst/tmpl/gstbuffer.sgml @@ -294,17 +294,6 @@ A convenience function to set the data and size on a buffer @size: The size to set on the buffer - - - - - -@pool: -@offset: -@size: -@Returns: - - diff --git a/docs/gst/tmpl/gstcaps.sgml b/docs/gst/tmpl/gstcaps.sgml index 8cb1606a5d..d84d3d6e83 100644 --- a/docs/gst/tmpl/gstcaps.sgml +++ b/docs/gst/tmpl/gstcaps.sgml @@ -118,183 +118,14 @@ The GType of the caps boxed type, for use in GValues. - - -A convenience macro to create a new GstCaps structure. - - -@name: the name of the caps structure -@type: the mime type of the caps structure -@...: the properties of this caps stucture. - - - - -A convenience macro to create a GstCaps factory. - - -@factoryname: the name of the factory -@...: the caps to create with this factory, usualy specified -with GST_CAPS_NEW() - - - - -A convenience macro to get a GstCaps from the given capsfactory. - - -@fact: the factory to use. - - The gstcaps structure -@name: the name of the capability, for the application -@id: the typeid of the capability +@type: @flags: -@refcount: a refcounter for this caps structure -@properties: the properties of the capability -@next: a pointer to the next caps. - - - -Flags for this caps. - - -@GST_CAPS_UNUSED: -@GST_CAPS_FLOATING: the caps is not owned by anyone - - - -Get the flags of the caps - - -@caps: The caps to get the flags of - - - - -Test is a flag is set - - -@caps: The caps to test -@flag: The flag to check - - - - -Set a flag on the caps - - -@caps: The caps to modify -@flag: The flag to set - - - - -Unset a flag on the caps - - -@caps: The caps to modify -@flag: The flag to unset - - - - -Test if a caps is floating - - -@caps: The caps to test - - - - -Check if the GstCaps is chained. - - -@caps: the caps to query - - - - -Check if the GstCaps has fixed properties, ie. it has no ranges or lists. - - -@caps: the caps to query - - - - -Get a pointer to the next chained caps - - -@caps: The caps to query - - - - -Get the properties of the caps - - -@caps: The caps to query - - - - -Get the refcount of the caps. - - -@caps: The caps to query - - - - -The name used for tracing - - - - - - - - - -@name: -@mime: -@props: -@Returns: - - - - - - - -@name: -@id: -@props: -@Returns: - - - - - - - -@caps: -@Returns: - - - - - - - -@caps: -@Returns: - +@structs: @@ -314,133 +145,28 @@ The name used for tracing @Returns: - - - - - -@caps: -@Returns: - - - - - - - -@caps: -@Varargs: -@Returns: - - +@caps1: +@caps2: + @caps: @capstoadd: @Returns: - - - - - -@caps: -@capstoadd: -@Returns: - - - - - - - -@caps: -@Returns: - - -@oldcaps: +@caps: @newcaps: - - - - - - - + @oldcaps: -@newcaps: - - - - - - - -@caps: - - - - - - - -@caps: -@name: - - - - - - - -@caps: -@Returns: - - - - - - - -@caps: -@mime: - - - - - - - -@caps: -@Returns: - - - - - - - -@caps: -@props: -@Returns: - - - - - - - -@caps: -@Returns: @@ -448,40 +174,12 @@ The name used for tracing +@caps1: +@caps2: +@Returns: + @fromcaps: @tocaps: -@Returns: - - - - -Check if the GstCaps has a property with the given name - - -@caps: the caps to query -@name: the name of the property -@Returns: - - - - -Check if the GstCaps has a fixed property with the given name - - -@caps: the caps to query -@name: the name of the property -@Returns: - - - - -Check if the GstCaps has a property with the given type - - -@caps: the caps to query -@name: the name of the property -@type: -@Returns: @@ -493,24 +191,6 @@ Check if the GstCaps has a property with the given type @Returns: - - -Set a property of a caps structure. - - -@caps: the caps structure to modify -@...: the new value of the property - - - - -Get key/value pairs from the given GstCaps. - - -@caps: the caps to get the values from -@...: a pointer to the variable that can hold the result followed by more key/value pairs. - - @@ -521,66 +201,6 @@ Get key/value pairs from the given GstCaps. @Returns: - - -Get the value of the named property as a boolean. - - -@caps: the caps to query -@name: the name of the property to get -@res: a pointer to a gboolean to store the result - - - - - - - -@caps: -@name: -@Returns: - - - - -Get the value of the named property as a fourcc. - - -@caps: the caps to query -@name: the name of the property to get -@res: a pointer to a guint32 to store the fourcc value - - - - -Get the value of the named property as an int. - - -@caps: the caps to query -@name: the name of the property to get -@res: a pointer to a gint to store the value - - - - -Get the value of the named property as a string. - - -@caps: the caps to query -@name: the name of the property to get -@res: a pointer to a gchar* to store the string - - - - -Get the value of the named property as a float. - - -@caps: the caps to query -@name: the name of the property to get -@res: a pointer to a gfloat to store the result - - @@ -600,12 +220,13 @@ Get the value of the named property as a float. @Returns: - + -@caps: -@label: +@caps1: +@caps2: +@Returns: diff --git a/docs/gst/tmpl/gstclock.sgml b/docs/gst/tmpl/gstclock.sgml index ae2cf0de72..da3b748162 100644 --- a/docs/gst/tmpl/gstclock.sgml +++ b/docs/gst/tmpl/gstclock.sgml @@ -235,16 +235,6 @@ The GstClock object - - -Maximum allowed diff for clock sync requests against the real time. - - - - -Boolean property to activate stat generation on the clock. - - @@ -412,3 +402,13 @@ Boolean property to activate stat generation on the clock. @id: + + +Maximum allowed diff for clock sync requests against the real time. + + + + +Boolean property to activate stat generation on the clock. + + diff --git a/docs/gst/tmpl/gstelement.sgml b/docs/gst/tmpl/gstelement.sgml index 4ce8a7bea1..e978c80481 100644 --- a/docs/gst/tmpl/gstelement.sgml +++ b/docs/gst/tmpl/gstelement.sgml @@ -71,58 +71,6 @@ The element object - - -Signal emited when the element goes to PAUSED due to an end-of-stream -condition. - - -@gstelement: the object which received the signal. - - - -Is triggered whenever an error occured. - - - -@gstelement: the object which received the signal. -@arg1: the error message -@arg2: - - - - - - -@gstelement: the object which received the signal. -@arg1: -@arg2: - - - -Is triggered whenever a new pad is added to an element. - - -@gstelement: the object which received the signal. -@arg1: the new pad that was added - - - -Is triggered whenever a pad has been removed from the element. - - -@gstelement: the object which received the signal. -@arg1: The pad that was removed. - - - -Is triggered whenever the state of an element changes. - - -@gstelement: the object which received the signal. -@arg1: the new state of the object -@arg2: - Gets the name of the element. @@ -1015,3 +963,55 @@ Helper macro to create query type functions @...: list of query types. + + +Signal emited when the element goes to PAUSED due to an end-of-stream +condition. + + +@gstelement: the object which received the signal. + + + +Is triggered whenever an error occured. + + + +@gstelement: the object which received the signal. +@arg1: the error message +@arg2: + + + + + + +@gstelement: the object which received the signal. +@arg1: +@arg2: + + + +Is triggered whenever a new pad is added to an element. + + +@gstelement: the object which received the signal. +@arg1: the new pad that was added + + + +Is triggered whenever a pad has been removed from the element. + + +@gstelement: the object which received the signal. +@arg1: The pad that was removed. + + + +Is triggered whenever the state of an element changes. + + +@gstelement: the object which received the signal. +@arg1: the new state of the object +@arg2: + diff --git a/docs/gst/tmpl/gstindex.sgml b/docs/gst/tmpl/gstindex.sgml index cdc3cfa10e..d828fa3114 100644 --- a/docs/gst/tmpl/gstindex.sgml +++ b/docs/gst/tmpl/gstindex.sgml @@ -209,19 +209,6 @@ The GstIndex object - - -Is emited when a new entry is added to the index. - - -@gstindex: the object which received the signal. -@arg1: The entry added to the index. - - - - - - @@ -414,3 +401,16 @@ Is emited when a new entry is added to the index. @id: + + +Is emited when a new entry is added to the index. + + +@gstindex: the object which received the signal. +@arg1: The entry added to the index. + + + + + + diff --git a/docs/gst/tmpl/gstobject.sgml b/docs/gst/tmpl/gstobject.sgml index cf69ab93ee..52616a2215 100644 --- a/docs/gst/tmpl/gstobject.sgml +++ b/docs/gst/tmpl/gstobject.sgml @@ -40,47 +40,6 @@ The GstObject - - -The deep notify signal is used to be notified of property changes. -it is typically attached to the toplevel bin to receive notifications -from all the elements contained in that bin. - - -@gstobject: the object which received the signal. -@arg1: the object that originated the signal -@arg2: the property that changed - - - -Is trigered whenever a new object is saved to XML. You can connect to -this signal to insert custom XML tags into the core XML. - - -@gstobject: the object which received the signal. -@arg1: the xmlNodePtr of the parent node - - - -Is emitted when the parent of an object is set. - - -@gstobject: the object which received the signal. -@arg1: the new parent - - - -Is emitted when the parent of an object is unset. - - -@gstobject: the object which received the signal. -@arg1: the old parent - - - -The name of the object - - This macro returns the entire set of flags for the object. @@ -331,3 +290,44 @@ Check if the object has been destroyed. @Returns: + + +The deep notify signal is used to be notified of property changes. +it is typically attached to the toplevel bin to receive notifications +from all the elements contained in that bin. + + +@gstobject: the object which received the signal. +@arg1: the object that originated the signal +@arg2: the property that changed + + + +Is trigered whenever a new object is saved to XML. You can connect to +this signal to insert custom XML tags into the core XML. + + +@gstobject: the object which received the signal. +@arg1: the xmlNodePtr of the parent node + + + +Is emitted when the parent of an object is set. + + +@gstobject: the object which received the signal. +@arg1: the new parent + + + +Is emitted when the parent of an object is unset. + + +@gstobject: the object which received the signal. +@arg1: the old parent + + + +The name of the object + + diff --git a/docs/gst/tmpl/gstpad.sgml b/docs/gst/tmpl/gstpad.sgml index 82c34f49c7..c8a07db0a0 100644 --- a/docs/gst/tmpl/gstpad.sgml +++ b/docs/gst/tmpl/gstpad.sgml @@ -205,16 +205,6 @@ A function that will be called when pulling a buffer. @Returns: the #GstBuffer pulled. - - -A function that will be called when a buffer pool is requested -from this pad. - - -@pad: the #GstPad to which the buffer pool is associated. -@Returns: the #GstBufferPool associated with this pad. - - Returns the capabilities of the specified pad. By default this function @@ -222,8 +212,9 @@ will return the pad template capabilities, but can optionally be overridden. @pad: the #GstPad to get the capabilities of. -@caps: the peer's #GstCaps, can be used to filter the capabilities. @Returns: the #GstCaps of the pad. + +@caps: the peer's #GstCaps, can be used to filter the capabilities. @@ -448,15 +439,6 @@ Flags for the pad. @get: - - - - - -@pad: -@bufpool: - - @@ -696,15 +678,6 @@ Flags for the pad. @Returns: - - - - - -@pad: -@Returns: - - @@ -751,15 +724,6 @@ Flags for the pad. @Returns: - - - - - -@pad: -@Returns: - - @@ -1072,9 +1036,10 @@ The realpad object @pad: @caps: -@filter: +@appfixatefunc: @appfilter: @getcapsfunc: +@fixatefunc: @direction: @linkfunc: @unlinkfunc: @@ -1093,8 +1058,10 @@ The realpad object @formatsfunc: @querytypefunc: @intlinkfunc: -@bufferpoolfunc: +@bufferallocfunc: @probedisp: +@link: +@explicit_caps: @_gst_reserved: @@ -1129,14 +1096,6 @@ Get the chain function of the real pad. @pad: the real pad to query. - - -Get the filter from the pad - - -@pad: the pad to query - - Get the application filter for this pad @@ -1153,14 +1112,6 @@ Get get getfunction of the real pad. @pad: the real pad to query. - - -Get the bufferpoolfunction from the real pad. - - -@pad: the real pad to query. - - Get the eventhandler function from the real pad. diff --git a/docs/gst/tmpl/gstpadtemplate.sgml b/docs/gst/tmpl/gstpadtemplate.sgml index 0396557ef7..a2736922d0 100644 --- a/docs/gst/tmpl/gstpadtemplate.sgml +++ b/docs/gst/tmpl/gstpadtemplate.sgml @@ -87,15 +87,6 @@ The padtemplate object. - - -This signal is fired when an element creates a pad from this -template. - - -@gstpadtemplate: the object which received the signal. -@arg1: The pad that was created. - Flags for the padtemplate @@ -136,38 +127,6 @@ Get the presence of the padtemplate. @templ: the template to query - - -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. -@...: the capabilities of this padtemplate usually created with GST_CAPS_NEW() - - - - -Create a factory for a padtemplate. This can be used if you only want one instance -of the padtemplate. Use GST_PAD_TEMPLATE_GET() to get the unique padtemplate. - - -@name: th name of the factory -@padname: the nametemplate of the pads -@dir: the direction of the pads. -@pres: the presence of the pads. -@...: the capabilities of this padtemplate, usually created with GST_CAPS_NEW() - - - - -Get the padtemplate of the factory created with GST_PAD_TEMPLATE_FACTORY() - - -@fact: the factory name to get the padtemplate from. - - Check if the properties of the padtemplate are fixed @@ -185,8 +144,9 @@ Check if the properties of the padtemplate are fixed @direction: @presence: @caps: -@Varargs: @Returns: + +@Varargs: @@ -208,3 +168,12 @@ Check if the properties of the padtemplate are fixed @Returns: + + +This signal is fired when an element creates a pad from this +template. + + +@gstpadtemplate: the object which received the signal. +@arg1: The pad that was created. + diff --git a/docs/gst/tmpl/gstreamer-unused.sgml b/docs/gst/tmpl/gstreamer-unused.sgml index 40457002d4..91b170757d 100644 --- a/docs/gst/tmpl/gstreamer-unused.sgml +++ b/docs/gst/tmpl/gstreamer-unused.sgml @@ -2119,7 +2119,7 @@ candidate. -@klass: +@klass: @@ -4286,6 +4286,7 @@ A type that can be used to indicate a filename. + @@ -4759,6 +4760,16 @@ Get the size of the file. @arg1: @arg2: + + + + + +@gstelement: the object which received the signal. +@arg1: +@arg2: +@arg3: + @@ -5952,15 +5963,6 @@ Query the element for the current mime type - - - - - -@gstxml: the object which received the signal. -@arg1: -@arg2: - @@ -8012,6 +8014,15 @@ safely be modified. @resolver: @user_data: + + + + + +@caps: +@string: +@label: + @@ -8907,13 +8918,6 @@ of an element he doesn't need anymore. @format: @args...: - - - - - -@Returns: - diff --git a/docs/gst/tmpl/gstthread.sgml b/docs/gst/tmpl/gstthread.sgml index 38a7691b0a..6d7021906d 100644 --- a/docs/gst/tmpl/gstthread.sgml +++ b/docs/gst/tmpl/gstthread.sgml @@ -34,6 +34,15 @@ The GstThread object + + + + + +@name: +@Returns: + + @@ -46,12 +55,3 @@ The GstThread object The thread priority - - - - - -@name: -@Returns: - - diff --git a/docs/gst/tmpl/gstxml.sgml b/docs/gst/tmpl/gstxml.sgml index ea4e4bd24a..08450b21b9 100644 --- a/docs/gst/tmpl/gstxml.sgml +++ b/docs/gst/tmpl/gstxml.sgml @@ -105,3 +105,25 @@ All GstElements can be serialized to an XML presentation and subsequently loaded @Returns: + + + + + +@: +@: +@: + +@gstxml: the object which received the signal. +@arg1: +@arg2: + + + + + + +@gstxml: the object which received the signal. +@arg1: +@arg2: +