From 7c51d6e0ca51139b29df52ff0ea08cbed5278b8a Mon Sep 17 00:00:00 2001 From: Erik Walthinsen Date: Sat, 6 Jan 2001 22:05:15 +0000 Subject: [PATCH] Cleaned up the docs a bit. Original commit message from CVS: Cleaned up the docs a bit. --- docs/gst/tmpl/cothreads.sgml | 4 +- docs/gst/tmpl/gstasyncdisksrc.sgml | 20 - docs/gst/tmpl/gstaudiosink.sgml | 29 - docs/gst/tmpl/gstaudiosrc.sgml | 25 - docs/gst/tmpl/gstautoplug.sgml | 8 +- docs/gst/tmpl/gstbin.sgml | 11 +- docs/gst/tmpl/gstbuffer.sgml | 20 +- docs/gst/tmpl/gstcaps.sgml | 2 +- docs/gst/tmpl/gstdisksrc.sgml | 20 - docs/gst/tmpl/gstelement.sgml | 66 +- docs/gst/tmpl/gstesdsink.sgml | 16 - docs/gst/tmpl/gstfakesink.sgml | 12 - docs/gst/tmpl/gstfakesrc.sgml | 32 - docs/gst/tmpl/gstfdsink.sgml | 5 - docs/gst/tmpl/gstfdsrc.sgml | 15 - docs/gst/tmpl/gsthttpsrc.sgml | 11 - docs/gst/tmpl/gstidentity.sgml | 5 - docs/gst/tmpl/gstmeta.sgml | 12 +- docs/gst/tmpl/gstobject.sgml | 8 - docs/gst/tmpl/gstpad.sgml | 39 +- docs/gst/tmpl/gstpipefilter.sgml | 5 - docs/gst/tmpl/gstpipeline.sgml | 10 +- docs/gst/tmpl/gstprops.sgml | 12 +- docs/gst/tmpl/gstqueue.sgml | 16 - docs/gst/tmpl/gstreamer-unused.sgml | 3665 +++++++++++++++------------ docs/gst/tmpl/gstsinesrc.sgml | 20 - docs/gst/tmpl/gstthread.sgml | 8 +- docs/gst/tmpl/gsttype.sgml | 4 +- docs/gst/tmpl/gsttypefind.sgml | 13 - gst/gstautoplug.c | 2 +- gst/gstbin.c | 10 +- gst/gstbuffer.c | 14 +- gst/gstbufferpool.c | 4 +- gst/gstcaps.c | 49 +- gst/gstelement.c | 7 +- gst/gstelementfactory.c | 12 +- gst/gstmeta.c | 8 +- gst/gstpad.c | 60 +- gst/gstpipeline.c | 4 +- gst/gstprops.c | 20 +- gst/gsttee.c | 6 +- gst/gstthread.c | 2 +- gst/gsttype.c | 14 +- gst/gstutils.c | 19 +- 44 files changed, 2184 insertions(+), 2160 deletions(-) delete mode 100644 docs/gst/tmpl/gstesdsink.sgml diff --git a/docs/gst/tmpl/cothreads.sgml b/docs/gst/tmpl/cothreads.sgml index 06197bc38a..4e5e52dbaf 100644 --- a/docs/gst/tmpl/cothreads.sgml +++ b/docs/gst/tmpl/cothreads.sgml @@ -23,7 +23,7 @@ of data out of their src element. -The default stack size of a cothread +The default stack size of a cothread. @@ -89,7 +89,7 @@ it. -Indicates the cothread is started +Indicates the cothread is started. diff --git a/docs/gst/tmpl/gstasyncdisksrc.sgml b/docs/gst/tmpl/gstasyncdisksrc.sgml index ca7479d480..b355753553 100644 --- a/docs/gst/tmpl/gstasyncdisksrc.sgml +++ b/docs/gst/tmpl/gstasyncdisksrc.sgml @@ -32,23 +32,3 @@ the offset. @GST_ASYNCDISKSRC_OPEN: @GST_ASYNCDISKSRC_FLAG_LAST: - - -Specify the location of the file to read. - - - - -Specify how many bytes to read at a time. - - - - -Specify the current offset in the file. - - - - - - - diff --git a/docs/gst/tmpl/gstaudiosink.sgml b/docs/gst/tmpl/gstaudiosink.sgml index 87e51aa4d3..8ec48a9cb6 100644 --- a/docs/gst/tmpl/gstaudiosink.sgml +++ b/docs/gst/tmpl/gstaudiosink.sgml @@ -14,32 +14,3 @@ Output to a sound card via OSS. - - -The buffer is sent to the sound card. - - -@gstaudiosink: the object which received the signal. - -@arg1: the audiosink. - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/gst/tmpl/gstaudiosrc.sgml b/docs/gst/tmpl/gstaudiosrc.sgml index 721a58f3e7..68dabaab9b 100644 --- a/docs/gst/tmpl/gstaudiosrc.sgml +++ b/docs/gst/tmpl/gstaudiosrc.sgml @@ -14,28 +14,3 @@ Create buffers from an OSS sound card. - - -The number of bytes per read. - - - - -Get the current number of bytes read. - - - - -The audio format as defined in soundcard.h - - - - -The number of channels (mono, stereo, ...) - - - - -The frequency. - - diff --git a/docs/gst/tmpl/gstautoplug.sgml b/docs/gst/tmpl/gstautoplug.sgml index 6eff251d89..2ea069b281 100644 --- a/docs/gst/tmpl/gstautoplug.sgml +++ b/docs/gst/tmpl/gstautoplug.sgml @@ -2,7 +2,7 @@ GstAutoplug -Provide automatic element selection +Provide automatic element selection. @@ -17,14 +17,14 @@ to convert a certain GstCaps to another one. -The max cost of a certain connection +The maximum cost of a certain connection. -Calculate the cost between two elements +Calculate the cost between two elements. @src: the source element @@ -35,7 +35,7 @@ Calculate the cost between two elements -Get a list of all elements. These elements will be used in autoplugging +Get a list of all elements. These elements will be used in autoplugging. @data: user data diff --git a/docs/gst/tmpl/gstbin.sgml b/docs/gst/tmpl/gstbin.sgml index 98f827e650..28cdceeef8 100644 --- a/docs/gst/tmpl/gstbin.sgml +++ b/docs/gst/tmpl/gstbin.sgml @@ -19,7 +19,7 @@ allowing for deep nesting of predefined sub-pipelines. -Flags for a bin +Flags for a bin. @GST_BIN_FLAG_MANAGER: @@ -121,12 +121,3 @@ Flags for a bin @bin: - - -is signaled whenever a new GstElement is added to the GstBin - - - -@gstbin: the object which received the signal. -@arg1: the element that was added - diff --git a/docs/gst/tmpl/gstbuffer.sgml b/docs/gst/tmpl/gstbuffer.sgml index e86ad7bd9a..5b670acb07 100644 --- a/docs/gst/tmpl/gstbuffer.sgml +++ b/docs/gst/tmpl/gstbuffer.sgml @@ -21,7 +21,7 @@ pointers to arbitrary metadata. -get the flags from this buffer +Get the flags from this buffer. @buf: GstBuffer to retrieve the flags from @@ -29,7 +29,7 @@ get the flags from this buffer -gives the status of a given flag +Gives the status of a given flag. @buf: GstBuffer to query @@ -38,7 +38,7 @@ gives the status of a given flag -set a flag in a buffer +Set a flag in a buffer. @buf: GstBuffer to query @@ -47,7 +47,7 @@ set a flag in a buffer -clear a flag in a buffer +Clear a flag in a buffer. @buf: GstBuffer to modify @@ -64,7 +64,7 @@ Retrieves the type id of the data in the buffer. -retrieves a pointer to the data element of this buffer +Retrieves a pointer to the data element of this buffer @buf: GstBuffer @@ -72,7 +72,7 @@ retrieves a pointer to the data element of this buffer -get the size of the data in this buffer +Get the size of the data in this buffer. @buf: GstBuffer @@ -80,7 +80,7 @@ get the size of the data in this buffer - +Get the offset in the source file of this buffer. @buf: GstBuffer @@ -96,7 +96,7 @@ get the size of the data in this buffer -get the timestamp for this buffer +Get the timestamp for this buffer. @buf: GstBuffer @@ -124,7 +124,7 @@ FALSE if it can't get it immediately. -this macro releases a lock on the object. +This macro releases a lock on the object. @@ -134,6 +134,8 @@ this macro releases a lock on the object. +FIXME this is strange. + diff --git a/docs/gst/tmpl/gstcaps.sgml b/docs/gst/tmpl/gstcaps.sgml index 2394e02bbf..0ba8ee300a 100644 --- a/docs/gst/tmpl/gstcaps.sgml +++ b/docs/gst/tmpl/gstcaps.sgml @@ -20,7 +20,7 @@ a mime-type and a set of properties. -@name: +@name: the name of the capability, for the application @id: the typeid of the capability @properties: the properties of the capability diff --git a/docs/gst/tmpl/gstdisksrc.sgml b/docs/gst/tmpl/gstdisksrc.sgml index 67c4fd6366..d8516af222 100644 --- a/docs/gst/tmpl/gstdisksrc.sgml +++ b/docs/gst/tmpl/gstdisksrc.sgml @@ -33,23 +33,3 @@ with seeking capabilities use a GstAsynDiskSrc instead. @GST_DISKSRC_OPEN: @GST_DISKSRC_FLAG_LAST: - - -Specify the location of the file to read. - - - - -Specify how many bytes to read at a time. - - - - -Get the current offset in the file. - - - - - - - diff --git a/docs/gst/tmpl/gstelement.sgml b/docs/gst/tmpl/gstelement.sgml index 3f251ebe29..b45cfb048a 100644 --- a/docs/gst/tmpl/gstelement.sgml +++ b/docs/gst/tmpl/gstelement.sgml @@ -55,7 +55,7 @@ can return after a state change. -This macro returns the entire state of the element. +This macro returns the current state of the element. @obj: Element to return state for. @@ -71,58 +71,57 @@ This macro returns the currently pending state of the element. -Returns the state transition this object is going through +Returns the state transition this object is going through. -@obj: the Element to return the tate transition for +@obj: the Element to return the state transition for -The Element is going from the NULL state to the READY state +The Element is going from the NULL state to the READY state. -The Element is going from the READY state to the PLAYING state +The Element is going from the READY state to the PLAYING state. -The Element is going from the PLAYING state to the PAUSED state +The Element is going from the PLAYING state to the PAUSED state. -The Element is going from the PAUSED state to the PLAYING state +The Element is going from the PAUSED state to the PLAYING state. -The Element is going from the PLAYING state to the READY state +The Element is going from the PLAYING state to the READY state. -The Element is going from the READY state to the NULL state +The Element is going from the READY state to the NULL state. -This enum defines the standard flags that an element -may have. +This enum defines the standard flags that an element may have. @GST_ELEMENT_COMPLEX: @@ -136,7 +135,7 @@ may have. -Queries whether the Element should be placed in a thread +Queries whether the Element should be placed in a thread. @obj: The element to query @@ -144,7 +143,7 @@ Queries whether the Element should be placed in a thread -Queries whether the cothread holding this element needs to be stopped +Queries whether the cothread holding this element needs to be stopped. @obj: The element to query @@ -512,44 +511,3 @@ circumstances. @Returns: - - -Is trigered whenever the state of an element changes - - -@gstelement: the object which received the signal. -@arg1: the new state of the object - - - -Is trigered whenever a new pad is added to an element - - -@gstelement: the object which received the signal. -@arg1: the new pad that was added - - - - -Is trigered whenever a new ghost pad is added to an element - - -@gstelement: the object which received the signal. -@arg1: the new ghost pad that was added - - - -Is trigered whenever an error occured - - - -@gstelement: the object which received the signal. -@arg1: the error message - - - - - - -@gstelement: the object which received the signal. - diff --git a/docs/gst/tmpl/gstesdsink.sgml b/docs/gst/tmpl/gstesdsink.sgml deleted file mode 100644 index f665c9ae7c..0000000000 --- a/docs/gst/tmpl/gstesdsink.sgml +++ /dev/null @@ -1,16 +0,0 @@ - -GstEsdSink - - - - - - - - - - - - - - diff --git a/docs/gst/tmpl/gstfakesink.sgml b/docs/gst/tmpl/gstfakesink.sgml index 9d405d62f4..361a67d1a7 100644 --- a/docs/gst/tmpl/gstfakesink.sgml +++ b/docs/gst/tmpl/gstfakesink.sgml @@ -16,15 +16,3 @@ with the buffer. (fakesink) - - - - - -@gstfakesink: the object which received the signal. - - - - - - diff --git a/docs/gst/tmpl/gstfakesrc.sgml b/docs/gst/tmpl/gstfakesrc.sgml index 490bd541cd..dfc2d57101 100644 --- a/docs/gst/tmpl/gstfakesrc.sgml +++ b/docs/gst/tmpl/gstfakesrc.sgml @@ -14,35 +14,3 @@ The GstFakeSrc generates empty buffers. (fakesrc) - - - - - -@gstfakesrc: the object which received the signal. - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/gst/tmpl/gstfdsink.sgml b/docs/gst/tmpl/gstfdsink.sgml index a9f7327643..ec3e297b20 100644 --- a/docs/gst/tmpl/gstfdsink.sgml +++ b/docs/gst/tmpl/gstfdsink.sgml @@ -14,8 +14,3 @@ Write data to a file descriptor. - - -The filedescriptor to write to. - - diff --git a/docs/gst/tmpl/gstfdsrc.sgml b/docs/gst/tmpl/gstfdsrc.sgml index 882a451986..dd2c183b71 100644 --- a/docs/gst/tmpl/gstfdsrc.sgml +++ b/docs/gst/tmpl/gstfdsrc.sgml @@ -14,18 +14,3 @@ Read buffers from a file descriptor. - - -The filedescriptor to read from. Pass the argument as a char* (???) - - - - -The number of bytes per read. - - - - -Get the current offset in the file. - - diff --git a/docs/gst/tmpl/gsthttpsrc.sgml b/docs/gst/tmpl/gsthttpsrc.sgml index f1c74b859a..2ba4a00e8d 100644 --- a/docs/gst/tmpl/gsthttpsrc.sgml +++ b/docs/gst/tmpl/gsthttpsrc.sgml @@ -14,14 +14,3 @@ Reads data from a URL. - - -Specify the location of the file. The location must be a fully qualified URL. - - - - -Specify how many bytes to read at a time. - - - diff --git a/docs/gst/tmpl/gstidentity.sgml b/docs/gst/tmpl/gstidentity.sgml index 0ec323dfd4..e5a1a65bde 100644 --- a/docs/gst/tmpl/gstidentity.sgml +++ b/docs/gst/tmpl/gstidentity.sgml @@ -14,8 +14,3 @@ Pass data without modification. - - - - - diff --git a/docs/gst/tmpl/gstmeta.sgml b/docs/gst/tmpl/gstmeta.sgml index 3c5a3330b2..6d0a6c5f17 100644 --- a/docs/gst/tmpl/gstmeta.sgml +++ b/docs/gst/tmpl/gstmeta.sgml @@ -109,7 +109,7 @@ it, is there? -Retrieve the flags of the given meta information +Retrieve the flags of the given meta information. @meta: the meta information @@ -117,7 +117,7 @@ Retrieve the flags of the given meta information -Check if a given flag is set +Check if a given flag is set. @meta: the meta data to test @@ -126,7 +126,7 @@ Check if a given flag is set -Set a flag in the meta data +Set a flag in the meta data. @meta: the meta data @@ -135,7 +135,7 @@ Set a flag in the meta data -Clear a flag in the meta data +Clear a flag in the meta data. @meta: the meta data @@ -144,7 +144,7 @@ Clear a flag in the meta data -Flags indicating properties about the meta data +Flags indicating properties about the meta data. @GST_META_FREEABLE: the meta data can be freed @@ -170,7 +170,7 @@ Flags indicating properties about the meta data -Create new meta data +Create new meta data. @type: the type of the meta data to create diff --git a/docs/gst/tmpl/gstobject.sgml b/docs/gst/tmpl/gstobject.sgml index 27f67cfa4e..ee6cdd88ad 100644 --- a/docs/gst/tmpl/gstobject.sgml +++ b/docs/gst/tmpl/gstobject.sgml @@ -174,11 +174,3 @@ This macro releases a lock on the object. @Returns: - - - - - -@gstobject: the object which received the signal. -@arg1: the new parent - diff --git a/docs/gst/tmpl/gstpad.sgml b/docs/gst/tmpl/gstpad.sgml index c8d7b6cc79..db102070c6 100644 --- a/docs/gst/tmpl/gstpad.sgml +++ b/docs/gst/tmpl/gstpad.sgml @@ -18,7 +18,7 @@ connections. -is this pad connected +Is this pad connected. @pad: the pad to check @@ -26,7 +26,7 @@ is this pad connected -can this pad be used to pull a buffer +Can this pad be used to pull a buffer. @pad: the pad to check @@ -53,7 +53,7 @@ The function that will be called when pulling a buffer. @pad: the pad to get a buffer from -@Returns: a GstBuffer +@Returns: a #GstBuffer @@ -64,12 +64,12 @@ The function that will be called when pulling a region buffer. @pad: the pad to get a buffer from @offset: the offset of the region to get @size: the size of the region to get -@Returns: a GstBuffer +@Returns: a #GstBuffer -the function that will be called when a QoS message is sent. +The function that will be called when a QoS message is sent. @pad: the pad that sent the QoS message @@ -78,11 +78,11 @@ the function that will be called when a QoS message is sent. - +The function that will be called in an EOS case. -@pad: -@Returns: +@pad: the pad that needs to be set to EOS state +@Returns: TRUE if EOS was successful, FALSE otherwise @@ -117,7 +117,7 @@ The function that will be called when pulling a region buffer. -The direction this pad is +The direction this pad is. @GST_PAD_UNKNOWN: direction is unknown @@ -126,7 +126,7 @@ The direction this pad is -Flags for the pad +Flags for the pad. @GST_PAD_DISABLED: the pad is disabled @@ -145,7 +145,7 @@ Flags for the pad -Destroy the pad +Destroy the pad. @pad: the pad to destroy @@ -449,20 +449,20 @@ Destroy the pad -Defines an entry for a padfactory +Defines an entry for a padfactory. -The padfactory +The padfactory. Indicate that this pad will become available depending -on the media type. Use this in the factory definition +on the media type. Use this in the factory definition. @@ -470,7 +470,7 @@ on the media type. Use this in the factory definition Indicate that this pad will always be available. -Use this in the factory definition +Use this in the factory definition. @@ -491,7 +491,7 @@ Indicates a srcpad for the padfactory. -Starts the declaration of a the capabilities for this padtemplate +Starts the declaration of a the capabilities for this padtemplate. @a...: a capability factory @@ -499,7 +499,7 @@ Starts the declaration of a the capabilities for this padtemplate -Indicates when this pad will become available +Indicates when this pad will become available. @GST_PAD_ALWAYS: the pad is always available @@ -556,8 +556,3 @@ Indicates when this pad will become available @Returns: - - -Indicates this pad is active - - diff --git a/docs/gst/tmpl/gstpipefilter.sgml b/docs/gst/tmpl/gstpipefilter.sgml index 55f1469e74..968c3132aa 100644 --- a/docs/gst/tmpl/gstpipefilter.sgml +++ b/docs/gst/tmpl/gstpipefilter.sgml @@ -15,8 +15,3 @@ buffers from its output. - - -Sets the command to be executed. - - diff --git a/docs/gst/tmpl/gstpipeline.sgml b/docs/gst/tmpl/gstpipeline.sgml index 17bcd0be8a..da53a47805 100644 --- a/docs/gst/tmpl/gstpipeline.sgml +++ b/docs/gst/tmpl/gstpipeline.sgml @@ -12,9 +12,11 @@ including threading, as well as provide simple interfaces to common functions, like 'Play'. -the pipeline also has the capability to autoplug. This feature + +The pipeline also has the capability to autoplug. This feature allows you to only define the input/output plugins and let the -pipeline figure out what plugins to use. +pipeline figure out what plugins to use. + @@ -65,10 +67,10 @@ pipeline figure out what plugins to use. -destroys the pipeline +Destroys the pipeline. -@pipeline: GstPipeline to destroy +@pipeline: #GstPipeline to destroy diff --git a/docs/gst/tmpl/gstprops.sgml b/docs/gst/tmpl/gstprops.sgml index b3072e8b93..39a17388b3 100644 --- a/docs/gst/tmpl/gstprops.sgml +++ b/docs/gst/tmpl/gstprops.sgml @@ -36,7 +36,7 @@ GstCaps -Create a list of properties +Create a list of properties. @a...: the list of GstProps @@ -44,7 +44,7 @@ Create a list of properties -Create an integer property +Create an integer property. @a: the integer property @@ -52,7 +52,7 @@ Create an integer property -Create an integer range property +Create an integer range property. @a: the min value for the range @@ -61,7 +61,7 @@ Create an integer range property -Construct a fourcc property out of four bytes +Construct a fourcc property out of four bytes. @a: first byte @@ -72,7 +72,7 @@ Construct a fourcc property out of four bytes -Create a fourcc property out of an integer value +Create a fourcc property out of an integer value. @a: the integer value @@ -80,7 +80,7 @@ Create a fourcc property out of an integer value -Create a boolean property +Create a boolean property. @a: the boolean property diff --git a/docs/gst/tmpl/gstqueue.sgml b/docs/gst/tmpl/gstqueue.sgml index e3ae1dfdaa..0363d626a7 100644 --- a/docs/gst/tmpl/gstqueue.sgml +++ b/docs/gst/tmpl/gstqueue.sgml @@ -21,19 +21,3 @@ The default queue length is set to 10. - - -Get the number of buffers in the queue. - - - - -Specify the maximum number of buffers in the queue before the queue -blocks. - - - - - - - diff --git a/docs/gst/tmpl/gstreamer-unused.sgml b/docs/gst/tmpl/gstreamer-unused.sgml index c7336384bf..806cc68574 100644 --- a/docs/gst/tmpl/gstreamer-unused.sgml +++ b/docs/gst/tmpl/gstreamer-unused.sgml @@ -1,440 +1,3 @@ - - - - - -@obj: - - - - - - - - - - - - - - - - - - -@format: -@args...: - - - - - - -@id: -@sink: - - - - - - -@src: - - - - - - -@Returns: - - - - - - -@obj: - - - - - - -@obj: - - - -An eos signal is triggered whenever the GstSrc has reached the end of -the stream. - - - -@gstsrc: the object which received the signal. -@arg1: the object which received the signal - - - - - - -@name: -@Returns: - - - - - - - - - - - - -@obj: - - - - - - - - - - - - - - - - - - - - - - - - -@obj: - - - - - - -@obj: - - - - - - -@name: -@Returns: - - - - - - -@obj: - - - - - - - - - - - - -@format: -@args...: - - - - - - -@obj: - - - - - - -@obj: - - - - - - - - - - - - - - - - -@klass: - - - - - - -@klass: - - - - - - -@obj: - - - - - - - - - - - - -@Returns: - - - - - - - - - - - - -@obj: - - - - - - -@Returns: - - - - - - - - - - - - -@klass: - - - - - - -@Returns: - - - -Use this macro to show debugging info. This is only usefull when developing new -plugin elements. -If you #define DEBUG_ENABLED before including gst/gst.h, this macro will produce -g_print messages. - - -@format: the format specification as in g_print -@args...: arguments - - - - - - - - - - - - - - - - - - -@obj: - - - -The sink is the end of the filter graph. A typical sink would be an audio -or a video card. - - - - - - - - - -@name: -@Returns: - - - - - - -@Returns: - - - - - - - - - - - - - - - - - - -@name: -@Returns: - - - - - - - - - - - - -@obj: - - - - - - -@connection: - - - -This macro checks to see if the GST_SRC_ASYNC flag is set. - - -@obj: GstSrc to check for flag in. - - - - - - - - - - - - - - - - - - -@klass: - - - - - - -@arg: - - -GstEsdSink - - - - - - - - - - - - - -@obj: - - - - - - - - - - - - -@name: -@Returns: - - - -A connection is a bas class for a generic connection between -elements. A connection is typically a bas class for queues. - - - - - - - - - -@Returns: - - - - - - - - - - - - - @@ -443,336 +6,71 @@ elements. A connection is typically a bas class for queues. @pad: @buf: - + - +Query the element for the current mime type -@id: -@src: - + @Returns: - + -@pad: -@buf: - + -@cat: -@format: -@args...: - + + + + + + + -@id: @Returns: - - - - - - - - - - - - - - - - - - - - - - - -@klass: - - - - - - -@klass: - - - - - - - - + @obj: - + + + + + +@meta: + + @obj: - + - - - - - -@obj: - - -GstColorSpace - - - - - - - - - - - - - -@obj: - - - - - - - - - - - - -@obj: - - - - - - - - - - - - -@id: -@Returns: - - -Take data in and spit data out - - - - -Filters take data in and spit data out. They are the main Element in a filter graph. -Filters have zero or more inputs and zero or more outputs. Filters are connected -together to form filter graphs. A GstFilter is the base class and is not very usefull -on its own. - - - - - - - - -@name: -@Returns: - - - - - - -@name: -@Returns: - - - - - - - - - - - - -@name: -@Returns: - - - - - - -@format: -@args...: - - - - - - -@obj: - - - - - - -@obj: - - - - - - -@src: - - - - - - -@name: -@Returns: - - - - - - - - - - - - -@obj: - - -GstGetbits - - - - - - - -@klass: - - - - - - -@element: -@format: -@args...: - - - - - - -@obj: - - - - - - -@src: -@offset: -@size: - - - - - - -@src: - - - - - - -@klass: - - - - - - -@obj: - - - - - - -@name: -@Returns: - - - - - - -@name: -@Returns: - - - - - - -@klass: - - - -A GstSrc is the start of a filter graph. It typically is a file or an -audio source. It provides data for the next element in the graph. - - - - @@ -781,156 +79,73 @@ audio source. It provides data for the next element in the graph. @pad: @buf: - + - +This macro usets the given flags. -@obj: +@src: +@flag: Flag to set, must be a single bit in guint32. +@obj: GstSrc to unset flag in. - + +Is trigered whenever a new ghost pad is added to an element -@esdsink: -@channels: +@gstelement: the object which received the signal. +@arg1: the new ghost pad that was added - - - - - -@klass: - - - - - - -@klass: - - - - - - - - -GstSrc - - - - - - - -@obj: - - - - - - -@obj: - - - - - - -@Returns: - - - - - - -@obj: - - - - - - -@Returns: - - + The frequency. - + + +Specify the location of the file. The location must be a fully qualified URL. + + + + +@pad: +@buf: - + +@pad: +@buf: - - - - - -@obj: - - - -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. - - - - - - - - - -This macro returns the entire set of flags for the object. - - -@obj: GstSrc to return flags for. - - + @Returns: - - - - - - - + @klass: - -The start point of a filter graph - - - + -@klass: +@elementfactory: +@id: @@ -945,194 +160,180 @@ The start point of a filter graph - + @obj: - + + +The number of channels. + + + + - + + +Use this macro to show debugging info. This is only usefull when developing new +plugin elements. +If you #define DEBUG_ENABLED before including gst/gst.h, this macro will produce +g_print messages. + + +@format: the format specification as in g_print +@args...: arguments + + +GstEsdSink + + + + + + + + + +@type: @parent: @Returns: - + + +Is trigered whenever the state of an element changes + + +@gstelement: the object which received the signal. +@arg1: the new state of the object + + - - - - - + + + + + + + +@src: + + + + + + +@obj: + + + + + + + + + + + + +@obj: + + + + + + + + + + + + +@esdsink: @format: -@args...: - + + +An eos signal is triggered whenever the GstSrc has reached the end of +the stream. + + + +@gstsrc: the object which received the signal. +@arg1: the object which received the signal + + -@klass: - - - - - -@klass: - - + @obj: - - - - - -@Returns: - - - - - - - - - - - - -@obj: - - -GstConnection - - - - - - - - - + +@Returns: - - -This macro sets the given state on the element. - - -@obj: Element to set state of. -@flag: State to set, can be any number of bits in guint32. - - - - - - - - - - - - -@klass: - - - - - - -@GST_CAPS_ALWAYS: -@GST_CAPS_MAYBE: - - + @obj: - -Generic connection between elements. - - - + +Specify how many bytes to read at a time. - + +@Returns: - - - - - -@esdsink: - - + @obj: - - - - - -@obj: - - - - - - -@obj: - - - - - - - @@ -1140,38 +341,7 @@ Generic connection between elements. @obj: - - - - - -@obj: - - -plugin - - - - - - - - - - - - - -@pad: -@buf: - - - - - - - - + @@ -1179,55 +349,6 @@ plugin @name: @Returns: - - - - - -@obj: - - - - - - -@obj: - - - - - - - - - - - - - - - -This macro usets the given flags. - - -@src: -@flag: Flag to set, must be a single bit in guint32. -@obj: GstSrc to unset flag in. - - - - - - -@audiosink: - - - - - - -@obj: - @@ -1236,13 +357,338 @@ This macro usets the given flags. @pad: @Returns: - + +GstSrc + + + + + + + + + @obj: + + + + + + + + + + + + + + + + + +@obj: + + + + + + + + + + + + +@name: +@Returns: + + + + + + + + + + + + +@klass: + + + + + + + + + + + + +@klass: + + + + + + +@obj: + + + + + + +@arg: + + + + + + +@obj: + + + + + + + + +GstConnection + + + + +Specify how many bytes to read at a time. + + + + + + + + + + + + + + +@obj: + + + +The frequency. + + + + + +Specify how many bytes to read at a time. + + + + + + + + + + + + + + + + + + + + +@name: +@Returns: + + + + + + + + + + + + + + + + + + + + +@Returns: + + + +The volume as a double 0.0 is silent, 1.0 is loudest. + + + + + + + + + + + + + + +@connection: + + + +subclass use this to start their flag enumeration + + + + +GstElement + + + + + + + +@obj: + + + + + + +@id: +@Returns: + + + + + + +@buf: + + + + + + +@audiosink: +@channels: + + +Generic connection between elements. + + + + + + + + + + + + + + + + + + + + + + + + + +@obj: + + + + + + +@element: +@format: +@args...: + + + + + + +@obj: + + + + + + +@obj: + + + +The sink is the end of the filter graph. A typical sink would be an audio +or a video card. + + + + + + + + + +@esdsink: +@channels: + + + + + + + + + + + + +@Returns: + + + + + + +@obj: + + + + + + + @@ -1250,34 +696,75 @@ This macro usets the given flags. @obj: - - -A flag indicating that SSE instructions are supported. - - - - - - - - -@pad: -@id: - - + - + + + + + + + + +Query whether this object has multiple input pads. + + + +@obj: Element to query for multiple input pads. + + + + + + +@name: +@fd: +@Returns: + + + + + + +@format: +@args...: + + + + + + + + + + + + + + + + + + + + @obj: - + + + + + + + @@ -1289,49 +776,107 @@ A flag indicating that SSE instructions are supported. - - - - - -The end point of a filter graph - - - - - - - -@Returns: - - - - - - -@klass: - - + - + @obj: - + + + + + +@pad: +@pull: + + + + + + + + @Returns: - + + + + + +@obj: + + + + + + + + + + + + + + + + + + +@src: + + + +The signal to indicate the mime type was detected. + + +@gsttypefind: the object which received the signal. +@arg1: The mime type that was detected + + + + + + + + + + + + + + + +Get the current offset in the file. + + + + + + + + +@format: +@args...: + + + + + + + + @@ -1345,6 +890,217 @@ The end point of a filter graph @Returns: + + +Specify the current offset in the file. + + + + + + + + +@name: +@Returns: + + + + + + +@klass: + + + + + + +@obj: + + + + + + + + + + + + + + + + + + +@klass: + + + + + + + + + + + + +@name: +@Returns: + + + + + + +@klass: + + + + + + +@Returns: + + + + + + +@obj: + + + + + + + + + + + + + + + + + + +@klass: + + + + + + + + + + + + + + + + +@Returns: + + + + + + + + + + + + + + + + + + +@obj: + + + +Is trigered whenever a new pad is added to an element + + +@gstelement: the object which received the signal. +@arg1: the new pad that was added + + + +Filters take data in and spit data out. They are the main Element in a filter graph. +Filters have zero or more inputs and zero or more outputs. Filters are connected +together to form filter graphs. A GstFilter is the base class and is not very usefull +on its own. + + + + + + + + +@obj: + + + + + + +@obj: + + + + + + +@obj: + + + + + + +@klass: + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@obj: + @@ -1353,242 +1109,81 @@ The end point of a filter graph @pad: @caps: - + + + + + +@klass: + + @obj: - - -This macro checks to see if the given state is set. - - -@obj: Element to check for state. -@flag: State to check for, must be a single bit in guint32. - - + -@type: -@parent: + + + + + + + + + + + + +@name: @Returns: - + @obj: - + +@name: @Returns: - + + + + + + + @obj: - + - - - - - -@obj: - - - - - - -@Returns: - - - -This macro sets the given flags. - - -@src: -@flag: Flag to set, can by any number of bits in guint32. -@obj: GstSrc to set flag in. - - - -Query a GstSrc for the ASYNC flag - - -@obj: The GstSrc to query - - - - - - - - - - - -@argc: -@argv: -@Returns: - - - - - - - - - - - - - - - - - - - - -GstSink - - - - - - - -@sinkid: -@srcid: -@Returns: - - - - - - - - - - - - - - - - - - -@Returns: - - - - - - - - - - - - -@connection: - - - - - - - - - - - - - - - - - - -@obj: - - - - - - -@buf: - - - -Query the element for the current mime type - - - - - - - - - - - - - - - - - - -@Returns: - - - - - - -@element: -@state: -@Returns: - - - - - - -@klass: - - - - - - - - + @@ -1601,37 +1196,63 @@ Query the element for the current mime type @klass: - + - + -@GST_PROPS_END_ID_NUM: -@GST_PROPS_LIST_ID_NUM: -@GST_PROPS_INT_ID_NUM: -@GST_PROPS_INT_RANGE_ID_NUM: -@GST_PROPS_FOURCC_ID_NUM: -@GST_PROPS_BOOL_ID_NUM: +@obj: - + + + + + +@src: + + + + + + +@id: +@sink: + + + + + + +@obj: + + - + - +This macro returns the entire set of flags for the object. + + +@obj: GstSrc to return flags for. + + +GstGetbits + + + + +The filedescriptor to write to. -@esdsink: -@frequency: @@ -1639,43 +1260,14 @@ Get the size of the current file. - - -subclass use this to start their flag enumeration - - - - + -@element: -@object: -@format: -@args...: +@klass: - - -Flags for the GstSrc element - - -@GST_SRC_ASYNC: Indicates that this src is asynchronous -@GST_SRC_FLAG_LAST: subclasses can use this to number their flags - - - - - - - - - - - - - - + @@ -1683,52 +1275,16 @@ Flags for the GstSrc element @name: @Returns: - - - - - -@audiosink: -@channels: - - - - - - - - - - - - -@thread: - - - - - - -@obj: - - - - - - - - - - - - -@obj: - - + +The start point of a filter graph + + + +@src: @@ -1737,92 +1293,23 @@ Flags for the GstSrc element @obj: - - - - - -@elementfactory: -@id: - - + +@sinkid: +@srcid: @Returns: - - - - - - - - - - - -@pad: -@Returns: - - - - - - - - - - - - -@pad: -@buf: - - - - - - - - - - - - -@pad: -@buf: - - - - - - -@klass: - - + @obj: - - - - - -@obj: - - - - - - -@klass: - - + @@ -1841,6 +1328,233 @@ Flags for the GstSrc element @src: + + + + + +@obj: + + + + + + + + + + + + + + + + + + +@id: +@Returns: + + + + + + +@esdsink: +@frequency: + + + +The number of bytes per read. + + + + + +The filedescriptor to read from. Pass the argument as a char* (???) + + + + + + + + +@klass: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@Returns: + + + + + + +@obj: + + + + + + +@Returns: + + + + + + +@obj: + + + + + + +@klass: + + + + + + +@obj: + + + +The audio format as defined in soundcard.h + + + + + + + + +@obj: + + + + + + +@klass: + + + + + + + + + + + + +@audiosink: + + + + + + +@elementfactory: +@id: + + + + + + +@obj: + + + +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. + + + + + + +@obj: + + + + + + +@klass: + + + + + + +@pad: +@id: + + + + + + + + + +The fequency. + + + + + + + + +@Returns: + + + +The format ad defined in soundcard.h + + + @@ -1849,7 +1563,13 @@ Flags for the GstSrc element @audiosink: @frequency: - + + + + + + + @@ -1862,6 +1582,134 @@ Flags for the GstSrc element @elementfactory: + + +The number of bytes per read. + + + + + + + + +@obj: + + + + + +@argc: +@argv: +@Returns: + + + + + + +@obj: + + + +The buffer is sent to the sound card. + + +@gstaudiosink: the object which received the signal. +@arg1: the audiosink. + + + +Specify the location of the file to read. + + + + + + + + +@obj: + + + + + + +@gstelement: the object which received the signal. + + + + + + +@Returns: + + + + + + +@element: +@object: +@format: +@args...: + + + +TRUE if the thread should be created. + + + + + + + + + +@obj: + + + + + + +@obj: + + + + + + + + + + + + +@obj: + + + + + + +@obj: + + + + + + +@pad: +@buf: + + + + + + + @@ -1869,160 +1717,79 @@ Flags for the GstSrc element @Returns: - - - - - -@meta: - - - - - - -@Returns: - - - - - - -@Returns: - - - - - - -@obj: - - - - - - -@Returns: - - - - - - -@obj: - - - - - - - - - - - - - - - - - - -@obj: - - - - - - -@obj: - - - - - - -@obj: - - - - - - - - -GstElement - - - - - - - -@obj: - - - - - - - - - - - - - - - - - - - - - - - - -@pad: -@pull: - - - - - - - - - - - - -@esdsink: -@format: - - - -Query whether this object has multiple input pads. - - - -@obj: Element to query for multiple input pads. - - + @klass: - + + +A connection is a bas class for a generic connection between +elements. A connection is typically a bas class for queues. + + + + + + + + + +@buf: + + + +Query a GstSrc for the ASYNC flag + + +@obj: The GstSrc to query + + + + + + +@obj: + + + +This macro sets the given state on the element. + + +@obj: Element to set state of. +@flag: State to set, can be any number of bits in guint32. + + + + + + +@pad: +@buf: + + - + + + + + +@Returns: + + + + + + +@gstfakesink: the object which received the signal. + + @@ -2035,124 +1802,56 @@ Query whether this object has multiple input pads. @obj: - + + + + + + - + + + + @src: +@offset: +@size: - + -@klass: - - - - - - -@obj: - - - - - - -@obj: - - - - - - -@obj: - - - - - - -@obj: - - - - - - - - - - - - -@name: -@fd: @Returns: - -GstFilter - - - + -@elementfactory: -@id: - + -@buf: +@obj: - + -@pad: -@Returns: - - - - - - -@audiosink: @format: +@args...: - - - - - -@klass: - - - - - - -@obj: - - - - - - -@Returns: - - + @@ -2169,20 +1868,147 @@ GstFilter @format: @args...: - + + + + + +@klass: + + + + + + +@name: +@Returns: + + + + + + +@klass: + + + + + + + + + + + + +@id: +@src: + + + + + + + + + + + + +@Returns: + + @obj: - + + + + + + + @obj: + +Take data in and spit data out + + + + +This macro checks to see if the GST_SRC_ASYNC flag is set. + + +@obj: GstSrc to check for flag in. + + + + + + + + + + + + +@klass: + + + + + + + + + +A flag indicating that SSE instructions are supported. + + + + + + + + +@esdsink: + + + + + + +@obj: + + + + + + +@connection: + + + +is signaled whenever a new GstElement is added to the GstBin + + + +@gstbin: the object which received the signal. +@arg1: the element that was added + + + + + + + @@ -2191,12 +2017,523 @@ GstFilter @name: @Returns: - + + + + + + +@Returns: + + + + + + +@obj: + + + + + + + + + + + + +@obj: + + + + + + + + +GstFilter + + + + + + + +@obj: + + + + + + +@obj: + + + + + + +@Returns: + + + + + + +@gstfakesrc: the object which received the signal. + + + + + + +@GST_PROPS_END_ID_NUM: +@GST_PROPS_LIST_ID_NUM: +@GST_PROPS_INT_ID_NUM: +@GST_PROPS_INT_RANGE_ID_NUM: +@GST_PROPS_FOURCC_ID_NUM: +@GST_PROPS_BOOL_ID_NUM: + + + + + + +@pad: +@Returns: + + + + + + +@pad: +@Returns: + + + + + + +@thread: + + + + + + +@GST_CAPS_ALWAYS: +@GST_CAPS_MAYBE: + + + +Get the current offset in the file. + + + + + +Sets the command to be executed. + + + + + + + + + + + +Flags for the GstSrc element + + +@GST_SRC_ASYNC: Indicates that this src is asynchronous +@GST_SRC_FLAG_LAST: subclasses can use this to number their flags + + + +Specify the maximum number of buffers in the queue before the queue +blocks. + + + + + +Get the number of buffers in the queue. + + + + + + + + +@obj: + + +GstColorSpace + + + + + + + + + + + + + +@element: +@state: +@Returns: + + + + + + + + + + + + + + + + + + +@obj: + + + + + + + + + +Specify the location of the file to read. + + + + + + + + +@klass: + + + + + + +@Returns: + + + + + + +@Returns: + + + + + + +@klass: + + + + + + + + + + + + +@klass: + + + + + + + + + + + + +@parent: +@Returns: + + + + + + +@name: +@Returns: + + + + + + + + + + + + +@format: +@args...: + + + + + + +@audiosink: +@format: + + + + + + +@obj: + + +The end point of a filter graph + + + + + + + +@cat: +@format: +@args...: + + + + + + +@obj: + + + + + + +@name: +@Returns: + + + +Get the current number of bytes read. + + + + + +The number of channels (mono, stereo, ...) + + + + + + + + + + + + + + + + +plugin + + + + +This macro checks to see if the given state is set. + + +@obj: Element to check for state. +@flag: State to check for, must be a single bit in guint32. + + + + + + +@gstobject: the object which received the signal. +@arg1: the new parent + + + + + + +@obj: + + + + + + + + + + + + + + + + + + +@name: +@Returns: + + + + + + +@obj: + + + + + + + + + + + + + + + + + + +@obj: + + + +Is trigered whenever an error occured + + + +@gstelement: the object which received the signal. +@arg1: the error message + + + + + + + + + +This macro sets the given flags. + + +@src: +@flag: Flag to set, can by any number of bits in guint32. +@obj: GstSrc to set flag in. + + + + + + +@klass: + + + + + + +@obj: + + + + + + +@klass: + + + + + + + + + +Indicates this pad is active + + + + + + + + +@Returns: + + + + + + +@name: +@Returns: + + + +A GstSrc is the start of a filter graph. It typically is a file or an +audio source. It provides data for the next element in the graph. + + + + + + + + + + + +GstSink + + A flag indicating that MMX instructions are supported. diff --git a/docs/gst/tmpl/gstsinesrc.sgml b/docs/gst/tmpl/gstsinesrc.sgml index 7768424330..687c03392d 100644 --- a/docs/gst/tmpl/gstsinesrc.sgml +++ b/docs/gst/tmpl/gstsinesrc.sgml @@ -14,23 +14,3 @@ Create a sine wave of a given frequency and volume. - - -The volume as a double 0.0 is silent, 1.0 is loudest. - - - - -The format ad defined in soundcard.h - - - - -The number of channels. - - - - -The fequency. - - diff --git a/docs/gst/tmpl/gstthread.sgml b/docs/gst/tmpl/gstthread.sgml index 1a0aed88c8..af1f8fa51b 100644 --- a/docs/gst/tmpl/gstthread.sgml +++ b/docs/gst/tmpl/gstthread.sgml @@ -20,7 +20,7 @@ to be dealt with in the separate thread. -thread flags +Thread flags: @GST_THREAD_CREATE: The thread is being created. @@ -43,9 +43,3 @@ thread flags @Returns: - - -TRUE if the thread should be created. - - - diff --git a/docs/gst/tmpl/gsttype.sgml b/docs/gst/tmpl/gsttype.sgml index b1a5cd9ff9..472d244f44 100644 --- a/docs/gst/tmpl/gsttype.sgml +++ b/docs/gst/tmpl/gsttype.sgml @@ -65,7 +65,7 @@ performed by a plugin. -A type +A type. @id: @@ -75,7 +75,7 @@ A type -The struct with the typefactory information +The struct with the typefactory information. @mime: diff --git a/docs/gst/tmpl/gsttypefind.sgml b/docs/gst/tmpl/gsttypefind.sgml index ace6c21877..4fb5972710 100644 --- a/docs/gst/tmpl/gsttypefind.sgml +++ b/docs/gst/tmpl/gsttypefind.sgml @@ -15,16 +15,3 @@ the detected mime type of the stream. It is used in autoplugging. - - -The signal to indicate the mime type was detected. - - -@gsttypefind: the object which received the signal. -@arg1: The mime type that was detected - - - - - - diff --git a/gst/gstautoplug.c b/gst/gstautoplug.c index c3a676f15f..10bd17939d 100644 --- a/gst/gstautoplug.c +++ b/gst/gstautoplug.c @@ -200,7 +200,7 @@ gst_autoplug_caps_list (GList *srccaps, GList *sinkcaps) * @srcpad: the source pad * @sinkpad: the sink pad * - * Perform autoplugging between the two given pads + * Perform autoplugging between the two given pads. * * Returns: a list of elementfactories that can connect * the two pads diff --git a/gst/gstbin.c b/gst/gstbin.c index 9c8b0e7de9..b20062a477 100644 --- a/gst/gstbin.c +++ b/gst/gstbin.c @@ -385,7 +385,7 @@ gst_bin_real_destroy (GtkObject *object) * @bin: #Gstbin to search * @name: the element name to search for * - * get the element with the given name from this bin + * Get the element with the given name from this bin. * * Returns: the element with the given name */ @@ -422,7 +422,7 @@ gst_bin_get_by_name (GstBin *bin, * gst_bin_get_list: * @bin: #Gstbin to get the list from * - * get the list of elements in this bin + * Get the list of elements in this bin. * * Returns: a GList of elements */ @@ -503,7 +503,7 @@ gst_bin_use_cothreads (GstBin *bin, * gst_bin_iterate: * @bin: #Gstbin to iterate * - * iterates over the elements in this bin + * Iterates over the elements in this bin. */ void gst_bin_iterate (GstBin *bin) @@ -524,7 +524,7 @@ gst_bin_iterate (GstBin *bin) * gst_bin_create_plan: * @bin: #GstBin to create the plan for * - * let the bin figure out how to handle the plugins in it. + * Let the bin figure out how to handle its children. */ void gst_bin_create_plan (GstBin *bin) @@ -541,7 +541,7 @@ gst_bin_create_plan (GstBin *bin) * gst_bin_schedule: * @bin: #GstBin to schedule * - * let the bin figure out how to handle the plugins in it. + * Let the bin figure out how to handle its children. */ void gst_bin_schedule (GstBin *bin) diff --git a/gst/gstbuffer.c b/gst/gstbuffer.c index 7091f35432..465986a7ff 100644 --- a/gst/gstbuffer.c +++ b/gst/gstbuffer.c @@ -244,7 +244,7 @@ void gst_buffer_destroy (GstBuffer *buffer) * gst_buffer_ref: * @buffer: the GstBuffer to reference * - * increment the refcount of this buffer + * Increment the refcount of this buffer. */ void gst_buffer_ref (GstBuffer *buffer) @@ -269,7 +269,7 @@ gst_buffer_ref (GstBuffer *buffer) * @buffer: the GstBuffer to reference * @count: a number * - * increment the refcount of this buffer with count + * Increment the refcount of this buffer by the given number. */ void gst_buffer_ref_by_count (GstBuffer *buffer, int count) @@ -292,7 +292,7 @@ gst_buffer_ref_by_count (GstBuffer *buffer, int count) * gst_buffer_unref: * @buffer: the GstBuffer to unref * - * decrement the refcount of this buffer. If the refcount is + * Decrement the refcount of this buffer. If the refcount is * zero, the buffer will be destroyed. */ void @@ -333,7 +333,7 @@ gst_buffer_unref (GstBuffer *buffer) * @buffer: the GstBuffer to add the metadata to * @meta: the metadata to add to this buffer * - * add the meta data to the buffer + * Add the meta data to the buffer. */ void gst_buffer_add_meta (GstBuffer *buffer, GstMeta *meta) @@ -349,7 +349,7 @@ gst_buffer_add_meta (GstBuffer *buffer, GstMeta *meta) * gst_buffer_get_metas: * @buffer: the GstBuffer to get the metadata from * - * get the metadatas from the buffer + * Get the metadatas from the buffer. * * Returns: a GSList of metadata */ @@ -365,7 +365,7 @@ gst_buffer_get_metas (GstBuffer *buffer) * gst_buffer_get_first_meta: * @buffer: the GstBuffer to get the metadata from * - * get the first metadata from the buffer + * Get the first metadata from the buffer. * * Returns: the first metadata from the buffer */ @@ -384,7 +384,7 @@ gst_buffer_get_first_meta (GstBuffer *buffer) * @buffer: the GstBuffer to remove the metadata from * @meta: the metadata to remove * - * remove the given metadata from the buffer + * Remove the given metadata from the buffer. */ void gst_buffer_remove_meta (GstBuffer *buffer, GstMeta *meta) diff --git a/gst/gstbufferpool.c b/gst/gstbufferpool.c index 923e4169b9..828baeafe4 100644 --- a/gst/gstbufferpool.c +++ b/gst/gstbufferpool.c @@ -91,7 +91,7 @@ gst_buffer_pool_set_destroy_function (GstBufferPool *pool, * gst_buffer_pool_destroy: * @pool: the pool to destroy * - * frees the memory for this bufferpool + * Frees the memory for this bufferpool. */ void gst_buffer_pool_destroy (GstBufferPool *pool) @@ -105,7 +105,7 @@ gst_buffer_pool_destroy (GstBufferPool *pool) * gst_buffer_pool_new_buffer: * @pool: the pool to create the buffer from * - * uses the given pool to create a new buffer. + * Uses the given pool to create a new buffer. * * Returns: The new buffer */ diff --git a/gst/gstcaps.c b/gst/gstcaps.c index 17f5cfee81..62c933f75d 100644 --- a/gst/gstcaps.c +++ b/gst/gstcaps.c @@ -57,7 +57,7 @@ get_type_for_mime (const gchar *mime) * @name: the name of this capability * @mime: the mime type to attach to the capability * - * create a new capability with the given mime type + * Create a new capability with the given mime type. * * Returns: a new capability */ @@ -82,8 +82,7 @@ gst_caps_new (const gchar *name, const gchar *mime) * @mime: the mime type to attach to the capability * @props: the properties for this capability * - * create a new capability with the given mime type - * and the given properties + * Create a new capability with the given mime type and the given properties. * * Returns: a new capability */ @@ -104,7 +103,7 @@ gst_caps_new_with_props (const gchar *name, const gchar *mime, GstProps *props) * * Register the factory. * - * Returns: The registered capability + * Returns: the registered capability */ GstCaps* gst_caps_register (GstCapsFactory *factory) @@ -119,9 +118,9 @@ gst_caps_register (GstCapsFactory *factory) * @factory: the factory to register * @counter: count how many entries were consumed * - * Register the factory. + * Register the factory. * - * Returns: The registered capability + * Returns: the registered capability */ GstCaps* gst_caps_register_count (GstCapsFactory *factory, guint *counter) @@ -160,9 +159,9 @@ gst_caps_register_count (GstCapsFactory *factory, guint *counter) * gst_caps_get_name: * @caps: the caps to get the name from * - * get the name of a GstCaps structure + * Get the name of a GstCaps structure. * - * Returns: The name of the caps + * Returns: the name of the caps */ const gchar* gst_caps_get_name (GstCaps *caps) @@ -177,7 +176,7 @@ gst_caps_get_name (GstCaps *caps) * @caps: the caps to set the name to * @name: the name to set * - * set the name of a caps + * Set the name of a caps. */ void gst_caps_set_name (GstCaps *caps, const gchar *name) @@ -194,9 +193,9 @@ gst_caps_set_name (GstCaps *caps, const gchar *name) * gst_caps_get_mime: * @caps: the caps to get the mime type from * - * get the mime type of the caps as a string + * Get the mime type of the caps as a string. * - * Returns: The mime type of the caps + * Returns: the mime type of the caps */ const gchar* gst_caps_get_mime (GstCaps *caps) @@ -218,7 +217,7 @@ gst_caps_get_mime (GstCaps *caps) * @caps: the caps to set the mime type to * @mime: the mime type to attach to the caps * - * set the mime type of the caps as a string + * Set the mime type of the caps as a string. */ void gst_caps_set_mime (GstCaps *caps, const gchar *mime) @@ -233,9 +232,9 @@ gst_caps_set_mime (GstCaps *caps, const gchar *mime) * gst_caps_get_type_id: * @caps: the caps to get the type id from * - * get the type id of the caps + * Get the type id of the caps. * - * Returns: The type id of the caps + * Returns: the type id of the caps */ guint16 gst_caps_get_type_id (GstCaps *caps) @@ -250,7 +249,7 @@ gst_caps_get_type_id (GstCaps *caps) * @caps: the caps to set the type id to * @typeid: the type id to set * - * set the type id of the caps + * Set the type id of the caps. */ void gst_caps_set_type_id (GstCaps *caps, guint16 typeid) @@ -265,9 +264,9 @@ gst_caps_set_type_id (GstCaps *caps, guint16 typeid) * @caps: the caps to attach the properties to * @props: the properties to attach * - * set the properties to the given caps + * Set the properties to the given caps. * - * Returns: The new caps structure + * Returns: the new caps structure */ GstCaps* gst_caps_set_props (GstCaps *caps, GstProps *props) @@ -285,9 +284,9 @@ gst_caps_set_props (GstCaps *caps, GstProps *props) * gst_caps_get_props: * @caps: the caps to get the properties from * - * get the properties of the given caps + * Get the properties of the given caps. * - * Returns: The properties of the caps + * Returns: the properties of the caps */ GstProps* gst_caps_get_props (GstCaps *caps) @@ -302,9 +301,9 @@ gst_caps_get_props (GstCaps *caps) * @fromcaps: a capabilty * @tocaps: a capabilty * - * Checks whether two capabilities are compatible + * Checks whether two capabilities are compatible. * - * Returns: true if compatible, false otherwise + * Returns: TRUE if compatible, FALSE otherwise */ gboolean gst_caps_check_compatibility (GstCaps *fromcaps, GstCaps *tocaps) @@ -338,9 +337,9 @@ gst_caps_check_compatibility (GstCaps *fromcaps, GstCaps *tocaps) * @fromcaps: a capabilty * @tocaps: a capabilty * - * Checks whether two capability lists are compatible + * Checks whether two capability lists are compatible. * - * Returns: true if compatible, false otherwise + * Returns: TRUE if compatible, FALSE otherwise */ gboolean gst_caps_list_check_compatibility (GList *fromcaps, GList *tocaps) @@ -367,7 +366,7 @@ gst_caps_list_check_compatibility (GList *fromcaps, GList *tocaps) * @caps: a capabilty to save * @parent: the parent XML node pointer * - * save the capability into an XML representation + * Save the capability into an XML representation. * * Returns: a new XML node pointer */ @@ -393,7 +392,7 @@ gst_caps_save_thyself (GstCaps *caps, xmlNodePtr parent) * gst_caps_load_thyself: * @parent: the parent XML node pointer * - * load a new caps from the XML representation + * Load a new caps from the XML representation. * * Returns: a new capability */ diff --git a/gst/gstelement.c b/gst/gstelement.c index 8ece79473b..d6fb7fe25c 100644 --- a/gst/gstelement.c +++ b/gst/gstelement.c @@ -595,7 +595,7 @@ static gchar *_gst_element_type_names[] = { * @element: GstElement to save * @parent: the xml parent node * - * saves the element + * Saves the element as part of the given XML structure * * Returns: the new xml node */ @@ -707,7 +707,7 @@ gst_element_save_thyself (GstElement *element, * @elements: a hashtable to store the elements in. This is used * to resolve inter element dependecies during the loading. * - * load the element based on the XML description + * Load the element from the XML description * * Returns: the new element */ @@ -907,8 +907,7 @@ gst_element_set_loop_function(GstElement *element, * gst_element_signal_eos: * @element: element to trigger the eos signal of * - * singals the eos signal to indicate that the end of the stream - * is reached. + * Throws the eos signal to indicate that the end of the stream is reached. */ void gst_element_signal_eos (GstElement *element) diff --git a/gst/gstelementfactory.c b/gst/gstelementfactory.c index 78c8af7399..2a78492a5b 100644 --- a/gst/gstelementfactory.c +++ b/gst/gstelementfactory.c @@ -224,7 +224,7 @@ gst_elementfactory_add_padtemplate (GstElementFactory *factory, * @factory: factory to query * @caps: the caps list to check * - * Checks if the factory can source the given capability list + * Checks if the factory can source the given capability list. * * Returns: true if it can src the capabilities */ @@ -257,7 +257,7 @@ gst_elementfactory_can_src_caps_list (GstElementFactory *factory, * @factory: factory to query * @caps: the caps list to check * - * Checks if the factory can sink the given capability list + * Checks if the factory can sink the given capability list. * * Returns: true if it can sink the capabilities */ @@ -290,7 +290,7 @@ gst_elementfactory_can_sink_caps_list (GstElementFactory *factory, * @factory: factory to query * @caps: the caps to check * - * Checks if the factory can src the given capability + * Checks if the factory can src the given capability. * * Returns: true if it can sink the capability */ @@ -315,7 +315,7 @@ gst_elementfactory_can_src_caps (GstElementFactory *factory, * @factory: factory to query * @caps: the caps to check * - * Checks if the factory can sink the given capability + * Checks if the factory can sink the given capability. * * Returns: true if it can sink the capability */ @@ -340,7 +340,7 @@ gst_elementfactory_can_sink_caps (GstElementFactory *factory, * @factory: factory to save * @parent: the parent xmlNodePtr * - * Saves the factory into an XML tree + * Saves the factory into an XML tree. * * Returns: the new xmlNodePtr */ @@ -379,7 +379,7 @@ gst_elementfactory_save_thyself (GstElementFactory *factory, * gst_elementfactory_load_thyself: * @parent: the parent xmlNodePtr * - * Creates a new factory from an xmlNodePtr + * Creates a new factory from an xmlNodePtr. * * Returns: the new factory */ diff --git a/gst/gstmeta.c b/gst/gstmeta.c index 42484e9f70..fc0e988fd5 100644 --- a/gst/gstmeta.c +++ b/gst/gstmeta.c @@ -30,7 +30,7 @@ * gst_meta_new_size: * @size: the size of the new meta data * - * Create a new metadata object with a given size + * Create a new metadata object with a given size. * * Returns: new meta object */ @@ -49,7 +49,7 @@ gst_meta_new_size (gint size) * gst_meta_ref: * @meta: the meta object to ref * - * increases the refcount of a meta object + * Increases the refcount of a meta object. */ void gst_meta_ref (GstMeta *meta) @@ -69,7 +69,7 @@ gst_meta_ref (GstMeta *meta) * gst_meta_unref: * @meta: the meta object to unref * - * decreases the refcount of a meta object. if the refcount is zero, the + * Decreases the refcount of a meta object. If the refcount is zero, the * meta object is freed. */ void @@ -97,7 +97,7 @@ gst_meta_unref (GstMeta *meta) * gst_meta_cow: * @meta: the meta object prepare for write * - * prepares a meta object for writing. A copy of the meta + * Prepares a meta object for writing. A copy of the meta * object is returned if needed. * * Returns: the meta object or a copy. diff --git a/gst/gstpad.c b/gst/gstpad.c index b3c7a63a41..bf01562c13 100644 --- a/gst/gstpad.c +++ b/gst/gstpad.c @@ -220,7 +220,7 @@ gst_pad_new_from_template (GstPadTemplate *temp, * gst_pad_get_direction: * @pad: the Pad to get the direction from * - * get the direction of the pad + * Get the direction of the pad. * * Returns: the direction of the pad */ @@ -238,7 +238,7 @@ gst_pad_get_direction (GstPad *pad) * @pad: the pad to set the name of * @name: the name of the pad * - * set the name of a pad + * Set the name of a pad. */ void gst_pad_set_name (GstPad *pad, @@ -257,7 +257,7 @@ gst_pad_set_name (GstPad *pad, * gst_pad_get_name: * @pad: the pad to get the name of * - * get the name of a pad + * Get the name of a pad. * * Returns: the name of the pad, don't free. */ @@ -275,7 +275,7 @@ gst_pad_get_name (GstPad *pad) * @pad: the pad to set the chain function for * @chain: the chain function * - * Set the given chain function for the pad + * Set the given chain function for the pad. */ void gst_pad_set_chain_function (GstPad *pad, GstPadChainFunction chain) @@ -291,7 +291,7 @@ void gst_pad_set_chain_function (GstPad *pad, * @pad: the pad to set the get function for * @get: the get function * - * Set the given get function for the pad + * Set the given get function for the pad. */ void gst_pad_set_get_function (GstPad *pad, @@ -312,7 +312,7 @@ gst_pad_set_get_function (GstPad *pad, * @pad: the pad to set the getregion function for * @getregion: the getregion function * - * Set the given getregion function for the pad + * Set the given getregion function for the pad. */ void gst_pad_set_getregion_function (GstPad *pad, @@ -331,7 +331,7 @@ gst_pad_set_getregion_function (GstPad *pad, * @pad: the pad to set the qos function for * @qos: the qos function * - * Set the given qos function for the pad + * Set the given qos function for the pad. */ void gst_pad_set_qos_function (GstPad *pad, @@ -348,7 +348,7 @@ gst_pad_set_qos_function (GstPad *pad, * @pad: the pad to set the eos function for * @eos: the eos function * - * Set the given EOS function for the pad + * Set the given EOS function for the pad. */ void gst_pad_set_eos_function (GstPad *pad, @@ -377,7 +377,7 @@ gst_pad_push_func(GstPad *pad, GstBuffer *buf) * gst_pad_chain: * @pad: the pad to chain * - * call the chain function of the given pad + * Call the chain function of the given pad. */ void gst_pad_chain (GstPad *pad) @@ -397,7 +397,7 @@ gst_pad_chain (GstPad *pad) * @pad: the pad to handle the QoS message * @qos_message: the QoS message to handle * - * pass the qos message downstream + * Pass the qos message downstream. */ void gst_pad_handle_qos(GstPad *pad, @@ -434,7 +434,7 @@ gst_pad_handle_qos(GstPad *pad, * @srcpad: the source pad to disconnect * @sinkpad: the sink pad to disconnect * - * disconnects the source pad from the sink pad + * Disconnects the source pad from the sink pad. */ void gst_pad_disconnect (GstPad *srcpad, @@ -464,7 +464,7 @@ gst_pad_disconnect (GstPad *srcpad, * @srcpad: the source pad to connect * @sinkpad: the sink pad to connect * - * connects the source pad to the sink pad + * Connects the source pad to the sink pad. */ void gst_pad_connect (GstPad *srcpad, @@ -521,7 +521,7 @@ gst_pad_connect (GstPad *srcpad, * @pad: the pad to set the parent * @parent: the object to set the parent to * - * sets the parent object of a pad. + * Sets the parent object of a pad. */ void gst_pad_set_parent (GstPad *pad, @@ -544,7 +544,7 @@ gst_pad_set_parent (GstPad *pad, * @pad: the pad to set the ghost parent * @parent: the object to set the ghost parent to * - * add a ghost parent object to a pad. + * Add a ghost parent object to a pad. */ void gst_pad_add_ghost_parent (GstPad *pad, @@ -564,7 +564,7 @@ gst_pad_add_ghost_parent (GstPad *pad, * @pad: the pad to remove the ghost parent * @parent: the object to remove the ghost parent from * - * remove a ghost parent object from a pad. + * Remove a ghost parent object from a pad. */ void gst_pad_remove_ghost_parent (GstPad *pad, @@ -582,7 +582,7 @@ gst_pad_remove_ghost_parent (GstPad *pad, * gst_pad_get_parent: * @pad: the pad to get the parent from * - * get the parent object of this pad + * Get the parent object of this pad. * * Returns: the parent object */ @@ -599,9 +599,9 @@ gst_pad_get_parent (GstPad *pad) * gst_pad_get_ghost_parents: * @pad: the pad to get the ghost parents from * - * get the ghost parents of this pad + * Get the ghost parents of this pad. * - * Returns: a list of ghost parent objects + * Returns: a GList of ghost parent objects */ GList* gst_pad_get_ghost_parents (GstPad *pad) @@ -617,7 +617,7 @@ gst_pad_get_ghost_parents (GstPad *pad) * @pad: the pad to set the caps to * @caps: the capslist to attach to this pad * - * set the capabilities of this pad + * Set the capabilities of this pad. */ void gst_pad_set_caps_list (GstPad *pad, @@ -633,7 +633,7 @@ gst_pad_set_caps_list (GstPad *pad, * gst_pad_get_caps_list: * @pad: the pad to get the capabilities from * - * get the capabilities of this pad + * Get the capabilities of this pad. * * Returns: a list of capabilities of this pad */ @@ -651,7 +651,7 @@ gst_pad_get_caps_list (GstPad *pad) * @pad: the pad to get the capabilities from * @name: the name of the capability to get * - * get the capabilities with the given name from this pad + * Get the capabilities with the given name from this pad. * * Returns: a capability or NULL if not found */ @@ -682,9 +682,9 @@ gst_pad_get_caps_by_name (GstPad *pad, gchar *name) * @srcpad: the srcpad to check * @sinkpad: the sinkpad to check against * - * check if two pads have compatible capabilities + * Check if two pads have compatible capabilities. * - * Returns: TRUE if they are compatible ot the capabilities + * Returns: TRUE if they are compatible or the capabilities * could not be checked */ gboolean @@ -714,7 +714,7 @@ gst_pad_check_compatibility (GstPad *srcpad, GstPad *sinkpad) * gst_pad_get_peer: * @pad: the pad to get the peer from * - * Get the peer pad of this pad + * Get the peer pad of this pad. * * Returns: the peer pad */ @@ -828,7 +828,7 @@ gst_pad_save_thyself (GstPad *pad, * @bin: the bin * @parent: the parent XML node to save the description in * - * Saves the ghost pad into an xml representation + * Saves the ghost pad into an xml representation. * * Returns: the xml representation of the pad */ @@ -897,7 +897,7 @@ GstBuffer *gst_pad_pullregion(GstPad *pad,gulong offset,gulong size) { * gst_padtemplate_new: * @factory: the padfactory to use * - * creates a new padtemplate from the factory + * Creates a new padtemplate from the factory. * * Returns: the new padtemplate */ @@ -941,7 +941,7 @@ gst_padtemplate_new (GstPadFactory *factory) * @presence: the presence of the pad * @caps: a list of capabilities for the template * - * creates a new padtemplate from the given arguments + * Creates a new padtemplate from the given arguments. * * Returns: the new padtemplate */ @@ -968,7 +968,7 @@ gst_padtemplate_create (gchar *name_template, * @pad: the padtemplate to save * @parent: the parent XML tree * - * saves the padtemplate into XML + * Saves the padtemplate into XML. * * Returns: the new XML tree */ @@ -999,7 +999,7 @@ gst_padtemplate_save_thyself (GstPadTemplate *pad, xmlNodePtr parent) * gst_padtemplate_load_thyself: * @parent: the source XML tree * - * loads a padtemplate from the XML tree + * Loads a padtemplate from the XML tree. * * Returns: the new padtemplate */ @@ -1083,7 +1083,7 @@ gst_pad_eos_func(GstPad *pad) * gst_pad_set_eos: * @pad: the pad to set to eos * - * sets the given pad to the eos state + * Sets the given pad to the EOS state. * * Returns: TRUE if it succeeded */ diff --git a/gst/gstpipeline.c b/gst/gstpipeline.c index 93dbe40439..5f180a1abb 100644 --- a/gst/gstpipeline.c +++ b/gst/gstpipeline.c @@ -279,7 +279,7 @@ gst_pipeline_add_src (GstPipeline *pipeline, GstElement *src) * @sink: the sink to add to the pipeline * * Adds a sink element to the pipeline. This element - * will be used as a sink for autoplugging + * will be used as a sink for autoplugging. */ void gst_pipeline_add_sink (GstPipeline *pipeline, GstElement *sink) @@ -523,7 +523,7 @@ gst_pipeline_change_state (GstElement *element) /** * gst_pipeline_iterate: - * @pipeline: GstPipeline to iterate + * @pipeline: #GstPipeline to iterate * * Cause the pipeline's contents to be run through one full 'iteration'. */ diff --git a/gst/gstprops.c b/gst/gstprops.c index c30d9f5018..754c78d11d 100644 --- a/gst/gstprops.c +++ b/gst/gstprops.c @@ -103,7 +103,7 @@ props_compare_func (gconstpointer a, * * Register the factory. * - * Returns: The new property created from the factory + * Returns: the new property created from the factory */ GstProps * gst_props_register (GstPropsFactory factory) @@ -120,7 +120,7 @@ gst_props_register (GstPropsFactory factory) * * Register the factory. * - * Returns: The new property created from the factory + * Returns: the new property created from the factory */ GstProps * gst_props_register_count (GstPropsFactory factory, guint *counter) @@ -200,9 +200,9 @@ end: * @entry: the property entries for the property * @...: the property entries for the property * - * Create a new property from the list of entries + * Create a new property from the list of entries. * - * Returns: The new property created from the list of entries + * Returns: the new property created from the list of entries */ GstProps * gst_props_new (GstPropsFactoryEntry entry, ...) @@ -277,9 +277,9 @@ gst_props_new (GstPropsFactoryEntry entry, ...) * @props: the property to merge into * @tomerge: the property to merge * - * Merge the properties of tomerge into props + * Merge the properties of tomerge into props. * - * Returns: The new merged property + * Returns: the new merged property */ GstProps* gst_props_merge (GstProps *props, GstProps *tomerge) @@ -405,9 +405,9 @@ gst_props_entry_check_compatibility (GstPropsEntry *entry1, GstPropsEntry *entry * @fromprops: a property * @toprops: a property * - * Checks whether two capabilities are compatible + * Checks whether two capabilities are compatible. * - * Returns: true if compatible, false otherwise + * Returns: TRUE if compatible, FALSE otherwise */ gboolean gst_props_check_compatibility (GstProps *fromprops, GstProps *toprops) @@ -505,7 +505,7 @@ gst_props_save_thyself_func (GstPropsEntry *entry, xmlNodePtr parent) * @props: a property to save * @parent: the parent XML tree * - * saves the property into an XML representation + * Saves the property into an XML representation. * * Returns: the new XML tree */ @@ -574,7 +574,7 @@ gst_props_load_thyself_func (xmlNodePtr field) * gst_props_load_thyself: * @parent: the XML tree to load from * - * creates a new property out of an XML tree + * Creates a new property out of an XML tree. * * Returns: the new property */ diff --git a/gst/gsttee.c b/gst/gsttee.c index 13edfb1b51..44b7cc561a 100644 --- a/gst/gsttee.c +++ b/gst/gsttee.c @@ -96,7 +96,7 @@ static void gst_tee_init(GstTee *tee) { * gst_tee_new: * @name: the name of the new tee * - * create a new tee element + * Create a new tee element. * * Returns: the new tee element */ @@ -110,7 +110,7 @@ GstElement *gst_tee_new(gchar *name) { * gst_tee_new_pad: * @tee: the tee to create the new pad on * - * create a new pad on a given tee + * Create a new pad on a given tee. * * Returns: the name of the new pad */ @@ -134,7 +134,7 @@ gchar *gst_tee_new_pad(GstTee *tee) { * @pad: the pad to follow * @buf: the buffer to pass * - * chain a buffer on a pad + * Chain a buffer on a pad. */ void gst_tee_chain(GstPad *pad,GstBuffer *buf) { GstTee *tee; diff --git a/gst/gstthread.c b/gst/gstthread.c index 53172c9b0d..1fe53cca73 100644 --- a/gst/gstthread.c +++ b/gst/gstthread.c @@ -192,7 +192,7 @@ gst_thread_get_arg (GtkObject *object, * gst_thread_new: * @name: the name of the thread * - * Create a new thrad with the given name + * Create a new thread with the given name. * * Returns: The new thread */ diff --git a/gst/gsttype.c b/gst/gsttype.c index ad6279fb72..c7367ec2eb 100644 --- a/gst/gsttype.c +++ b/gst/gsttype.c @@ -56,7 +56,7 @@ _gst_type_initialize (void) * gst_type_register: * @factory: the type factory to register * - * register a new type factory to the system + * Register a new type factory to the system. * * Returns: the new type id */ @@ -138,7 +138,7 @@ guint16 gst_type_find_by_mime_func (const gchar *mime) * gst_type_find_by_mime: * @mime: the mime type to find * - * find the type id of a given mime type + * Find the type id of a given mime type. * * Returns: the type id */ @@ -152,7 +152,7 @@ gst_type_find_by_mime (const gchar *mime) * gst_type_find_by_ext: * @ext: the extension to find * - * find the type id of a given extention + * Find the type id of a given extention. * * Returns: the type id */ @@ -168,7 +168,7 @@ gst_type_find_by_ext (const gchar *ext) * gst_type_find_by_id: * @id: the type id to lookup * - * find the type of a given type id + * Find the type of a given type id. * * Returns: the type */ @@ -191,7 +191,7 @@ gst_type_find_by_id (guint16 id) /** * gst_type_get_list: * - * return a list of all registered types + * Return a list of all registered types. * * Returns: a list of GstTypes */ @@ -206,7 +206,7 @@ gst_type_get_list (void) * @factory: the type factory to save * @parent: the parent node to save into * - * save a typefactory into an XML representation + * Save a typefactory into an XML representation. * * Returns: the new xmlNodePtr */ @@ -258,7 +258,7 @@ gst_type_typefind_dummy (GstBuffer *buffer, gpointer priv) * gst_typefactory_load_thyself: * @parent: the parent node to load from * - * load a typefactory from an XML representation + * Load a typefactory from an XML representation. * * Returns: the new typefactory */ diff --git a/gst/gstutils.c b/gst/gstutils.c index baaae4c7b1..9ea074a7b0 100644 --- a/gst/gstutils.c +++ b/gst/gstutils.c @@ -28,7 +28,7 @@ * @object: the object to query * @argname: the name of the argument * - * retrieves a property of an object as an integer + * Retrieves a property of an object as an integer. * * Returns: the property of the object */ @@ -45,7 +45,7 @@ gint gst_util_get_int_arg(GtkObject *object,guchar *argname) { * @object: the object to query * @argname: the name of the argument * - * retrieves a property of an object as a boolean + * Retrieves a property of an object as a boolean. * * Returns: the property of the object */ @@ -62,7 +62,7 @@ gint gst_util_get_bool_arg(GtkObject *object,guchar *argname) { * @object: the object to query * @argname: the name of the argument * - * retrieves a property of an object as a long + * Retrieves a property of an object as a long. * * Returns: the property of the object */ @@ -79,7 +79,7 @@ glong gst_util_get_long_arg(GtkObject *object,guchar *argname) { * @object: the object to query * @argname: the name of the argument * - * retrieves a property of an object as a float + * Retrieves a property of an object as a float. * * Returns: the property of the object */ @@ -96,7 +96,7 @@ gfloat gst_util_get_float_arg(GtkObject *object,guchar *argname) { * @object: the object to query * @argname: the name of the argument * - * retrieves a property of an object as a double + * Retrieves a property of an object as a double. * * Returns: the property of the object */ @@ -113,7 +113,7 @@ gdouble gst_util_get_double_arg(GtkObject *object,guchar *argname) { * @object: the object to query * @argname: the name of the argument * - * retrieves a property of an object as a string + * Retrieves a property of an object as a string. * * Returns: the property of the object */ @@ -130,7 +130,7 @@ guchar *gst_util_get_string_arg(GtkObject *object,guchar *argname) { * @object: the object to query * @argname: the name of the argument * - * retrieves a property of an object as a pointer + * Retrieves a property of an object as a pointer. * * Returns: the property of the object */ @@ -147,7 +147,7 @@ gpointer gst_util_get_pointer_arg(GtkObject *object,guchar *argname) { * @object: the object to query * @argname: the name of the argument * - * retrieves a property of an object as a widget + * Retrieves a property of an object as a widget. * * Returns: the property of the object */ @@ -164,8 +164,7 @@ GtkWidget *gst_util_get_widget_arg(GtkObject *object,guchar *argname) { * @mem: a pointer to the memory to dump * @size: the size of the memory block to dump * - * dumps the memory block into a hex representation. usefull - * for debugging. + * Dumps the memory block into a hex representation. Useful for debugging. */ void gst_util_dump_mem(guchar *mem, guint size) { guint i, j;