various doc fixes

Original commit message from CVS:
various doc fixes
parent c486f7a1
2005-09-11 Thomas Vander Stichele <thomas at apestaart dot org>
* docs/gst/gstreamer-sections.txt:
* docs/gst/gstreamer.types:
* docs/gst/tmpl/gstpad.sgml:
* docs/gst/tmpl/gsttypes.sgml:
* gst/base/gstadapter.h:
* gst/base/gstbasesink.h:
* gst/base/gstbasesrc.h:
* gst/gstbin.h:
* gst/gstbuffer.h:
* gst/gstbus.h:
* gst/gstcaps.h:
* gst/gstclock.h:
* gst/gstelement.h:
* gst/gstevent.h:
* gst/gstmessage.h:
* gst/gstpad.h:
* gst/gststructure.c:
* gst/registries/gstlibxmlregistry.h:
various documentation fixes
2005-09-11 Thomas Vander Stichele <thomas at apestaart dot org> 2005-09-11 Thomas Vander Stichele <thomas at apestaart dot org>
* docs/gst/gstreamer-sections.txt: * docs/gst/gstreamer-sections.txt:
......
...@@ -412,10 +412,8 @@ GST_PLUGIN_EXPORT ...@@ -412,10 +412,8 @@ GST_PLUGIN_EXPORT
GstElement GstElement
GstElementClass GstElementClass
GstElementFlags GstElementFlags
GST_NUM_STATES
GST_STATE GST_STATE
GST_STATE_PENDING GST_STATE_PENDING
GST_STATE_TRANSITION
GST_STATE_CHANGE_NULL_TO_READY GST_STATE_CHANGE_NULL_TO_READY
GST_STATE_CHANGE_READY_TO_PAUSED GST_STATE_CHANGE_READY_TO_PAUSED
GST_STATE_CHANGE_PAUSED_TO_PLAYING GST_STATE_CHANGE_PAUSED_TO_PLAYING
...@@ -1958,17 +1956,20 @@ gst_type_find_factory_get_type ...@@ -1958,17 +1956,20 @@ gst_type_find_factory_get_type
<FILE>gsttypes</FILE> <FILE>gsttypes</FILE>
<TITLE>GstTypes</TITLE> <TITLE>GstTypes</TITLE>
GstState GstState
GstStateChange
GstStateChangeReturn GstStateChangeReturn
GstRank GstRank
<SUBSECTION Standard> <SUBSECTION Standard>
GST_TYPE_ELEMENT_STATE GST_TYPE_STATE
GST_TYPE_ELEMENT_STATE_RETURN GST_TYPE_STATE_CHANGE
GST_TYPE_STATE_CHANGE_RETURN
GST_TYPE_RANK GST_TYPE_RANK
<SUBSECTION Private> <SUBSECTION Private>
GST_PADDING GST_PADDING
GST_PADDING_INIT GST_PADDING_INIT
gst_element_state_get_type gst_state_get_type
gst_element_state_return_get_type gst_state_change_get_type
gst_state_change_return_get_type
gst_rank_get_type gst_rank_get_type
</SECTION> </SECTION>
...@@ -2212,7 +2213,6 @@ GST_TYPE_XML_REGISTRY ...@@ -2212,7 +2213,6 @@ GST_TYPE_XML_REGISTRY
gst_xml_registry_get_type gst_xml_registry_get_type
</SECTION> </SECTION>
<SECTION> <SECTION>
<FILE>gstenumtypes</FILE> <FILE>gstenumtypes</FILE>
<TITLE>GstEnumTypes</TITLE> <TITLE>GstEnumTypes</TITLE>
......
...@@ -36,7 +36,7 @@ gst_xml_get_type ...@@ -36,7 +36,7 @@ gst_xml_get_type
%registries %registries
#include <gst/registries/gstxmlregistry.h> #include <gst/registries/gstlibxmlregistry.h>
gst_xml_registry_get_type gst_xml_registry_get_type
......
...@@ -375,17 +375,15 @@ The direction of a pad. ...@@ -375,17 +375,15 @@ The direction of a pad.
@GST_PAD_FLAG_LAST: @GST_PAD_FLAG_LAST:
<!-- ##### ENUM GstPadLinkReturn ##### --> <!-- ##### ENUM GstPadLinkReturn ##### -->
<para>
The result of a pad link.
</para>
@GST_PAD_LINK_OK: the link succeeded.
@GST_PAD_LINK_OK:
@GST_PAD_LINK_WRONG_HIERARCHY: @GST_PAD_LINK_WRONG_HIERARCHY:
@GST_PAD_LINK_WAS_LINKED: @GST_PAD_LINK_WAS_LINKED:
@GST_PAD_LINK_WRONG_DIRECTION: @GST_PAD_LINK_WRONG_DIRECTION:
@GST_PAD_LINK_NOFORMAT: @GST_PAD_LINK_NOFORMAT:
@GST_PAD_LINK_NOSCHED: @GST_PAD_LINK_NOSCHED:
@GST_PAD_LINK_REFUSED: the link was refused. @GST_PAD_LINK_REFUSED:
<!-- ##### ENUM GstPadPresence ##### --> <!-- ##### ENUM GstPadPresence ##### -->
<para> <para>
......
...@@ -28,6 +28,18 @@ various global enums and constants ...@@ -28,6 +28,18 @@ various global enums and constants
@GST_STATE_PAUSED: @GST_STATE_PAUSED:
@GST_STATE_PLAYING: @GST_STATE_PLAYING:
<!-- ##### ENUM GstStateChange ##### -->
<para>
</para>
@GST_STATE_CHANGE_NULL_TO_READY:
@GST_STATE_CHANGE_READY_TO_PAUSED:
@GST_STATE_CHANGE_PAUSED_TO_PLAYING:
@GST_STATE_CHANGE_PLAYING_TO_PAUSED:
@GST_STATE_CHANGE_PAUSED_TO_READY:
@GST_STATE_CHANGE_READY_TO_NULL:
<!-- ##### ENUM GstStateChangeReturn ##### --> <!-- ##### ENUM GstStateChangeReturn ##### -->
<para> <para>
......
...@@ -28,13 +28,16 @@ G_BEGIN_DECLS ...@@ -28,13 +28,16 @@ G_BEGIN_DECLS
#define GST_TYPE_ADAPTER \ #define GST_TYPE_ADAPTER \
(gst_adapter_get_type()) (gst_adapter_get_type())
#define GST_ADAPTER(obj) \ #define GST_ADAPTER(obj) \
(G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_ADAPTER,GstAdapter)) (G_TYPE_CHECK_INSTANCE_CAST((obj), GST_TYPE_ADAPTER, GstAdapter))
#define GST_ADAPTER_CLASS(klass) \ #define GST_ADAPTER_CLASS(klass) \
(G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_ADAPTER,GstAdapterClass)) (G_TYPE_CHECK_CLASS_CAST((klass), GST_TYPE_ADAPTER, GstAdapterClass))
#define GST_ADAPTER_GET_CLASS(obj) \
(G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_ADAPTER, GstAdapterClass))
#define GST_IS_ADAPTER(obj) \ #define GST_IS_ADAPTER(obj) \
(G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_ADAPTER)) (G_TYPE_CHECK_INSTANCE_TYPE((obj), GST_TYPE_ADAPTER))
#define GST_IS_ADAPTER_CLASS(obj) \ #define GST_IS_ADAPTER_CLASS(obj) \
(G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_ADAPTER)) (G_TYPE_CHECK_CLASS_TYPE((klass), GST_TYPE_ADAPTER))
typedef struct _GstAdapter GstAdapter; typedef struct _GstAdapter GstAdapter;
typedef struct _GstAdapterClass GstAdapterClass; typedef struct _GstAdapterClass GstAdapterClass;
......
...@@ -39,14 +39,14 @@ G_BEGIN_DECLS ...@@ -39,14 +39,14 @@ G_BEGIN_DECLS
* GST_BASE_SINK_CLOCK: * GST_BASE_SINK_CLOCK:
* @obj: base sink instance * @obj: base sink instance
* *
* Returns the pointer to the #GstClock object of the element. * Gives the pointer to the #GstClock object of the element.
*/ */
#define GST_BASE_SINK_CLOCK(obj) (GST_BASE_SINK (obj)->clock) #define GST_BASE_SINK_CLOCK(obj) (GST_BASE_SINK (obj)->clock)
/** /**
* GST_BASE_SINK_PAD: * GST_BASE_SINK_PAD:
* @obj: base sink instance * @obj: base sink instance
* *
* Returns the pointer to the #GstPad object of the element. * Gives the pointer to the #GstPad object of the element.
*/ */
#define GST_BASE_SINK_PAD(obj) (GST_BASE_SINK (obj)->sinkpad) #define GST_BASE_SINK_PAD(obj) (GST_BASE_SINK (obj)->sinkpad)
......
...@@ -48,7 +48,7 @@ typedef struct _GstBaseSrcClass GstBaseSrcClass; ...@@ -48,7 +48,7 @@ typedef struct _GstBaseSrcClass GstBaseSrcClass;
* GST_BASE_SRC_PAD: * GST_BASE_SRC_PAD:
* @obj: base source instance * @obj: base source instance
* *
* Returns the pointer to the #GstPad object of the element. * Gives the pointer to the #GstPad object of the element.
*/ */
#define GST_BASE_SRC_PAD(obj) (GST_BASE_SRC (obj)->srcpad) #define GST_BASE_SRC_PAD(obj) (GST_BASE_SRC (obj)->srcpad)
......
...@@ -54,16 +54,14 @@ typedef enum { ...@@ -54,16 +54,14 @@ typedef enum {
GST_BIN_FLAG_LAST = GST_ELEMENT_FLAG_LAST + 5 GST_BIN_FLAG_LAST = GST_ELEMENT_FLAG_LAST + 5
} GstBinFlags; } GstBinFlags;
typedef struct _GstBin GstBin; typedef struct _GstBin GstBin;
typedef struct _GstBinClass GstBinClass; typedef struct _GstBinClass GstBinClass;
/** /**
* GST_BIN_NUMCHILDREN: * GST_BIN_NUMCHILDREN:
* @bin: the bin to get the number of children from * @bin: the bin to get the number of children from
* *
* Gets the number of children a bin manages. * Gets the number of children a bin manages.
*
* Returns: the number of child objects
*/ */
#define GST_BIN_NUMCHILDREN(bin) (GST_BIN_CAST(bin)->numchildren) #define GST_BIN_NUMCHILDREN(bin) (GST_BIN_CAST(bin)->numchildren)
/** /**
...@@ -71,17 +69,13 @@ typedef struct _GstBinClass GstBinClass; ...@@ -71,17 +69,13 @@ typedef struct _GstBinClass GstBinClass;
* @bin: the bin to get the list with children from * @bin: the bin to get the list with children from
* *
* Gets the list with children a bin manages. * Gets the list with children a bin manages.
*
* Returns: the children list
*/ */
#define GST_BIN_CHILDREN(bin) (GST_BIN_CAST(bin)->children) #define GST_BIN_CHILDREN(bin) (GST_BIN_CAST(bin)->children)
/** /**
* GST_BIN_CHILDREN_COOKIE: * GST_BIN_CHILDREN_COOKIE:
* @bin: the bin to get the children cookie from * @bin: the bin to get the children cookie from
* *
* Gets the children cookie that watches the children list. * Gets the children cookie that watches the children list.
*
* Returns: the children cookie
*/ */
#define GST_BIN_CHILDREN_COOKIE(bin) (GST_BIN_CAST(bin)->children_cookie) #define GST_BIN_CHILDREN_COOKIE(bin) (GST_BIN_CAST(bin)->children_cookie)
......
...@@ -52,9 +52,7 @@ typedef struct _GstBufferClass GstBufferClass; ...@@ -52,9 +52,7 @@ typedef struct _GstBufferClass GstBufferClass;
* GST_BUFFER_FLAGS: * GST_BUFFER_FLAGS:
* @buf: a #GstBuffer to retrieve the flags from. * @buf: a #GstBuffer to retrieve the flags from.
* *
* Gets the flags from this buffer. * Gets the #GstBufferFlag flags from this buffer.
*
* Returns: the set of #GstBufferFlag items
*/ */
#define GST_BUFFER_FLAGS(buf) GST_MINI_OBJECT_FLAGS(buf) #define GST_BUFFER_FLAGS(buf) GST_MINI_OBJECT_FLAGS(buf)
/** /**
...@@ -63,8 +61,6 @@ typedef struct _GstBufferClass GstBufferClass; ...@@ -63,8 +61,6 @@ typedef struct _GstBufferClass GstBufferClass;
* @flag: the #GstBufferFlag to check. * @flag: the #GstBufferFlag to check.
* *
* Gives the status of a given flag of a buffer. * Gives the status of a given flag of a buffer.
*
* Returns: %TRUE if flag is set.
*/ */
#define GST_BUFFER_FLAG_IS_SET(buf,flag) GST_MINI_OBJECT_FLAG_IS_SET (buf, flag) #define GST_BUFFER_FLAG_IS_SET(buf,flag) GST_MINI_OBJECT_FLAG_IS_SET (buf, flag)
/** /**
...@@ -89,8 +85,6 @@ typedef struct _GstBufferClass GstBufferClass; ...@@ -89,8 +85,6 @@ typedef struct _GstBufferClass GstBufferClass;
* @buf: a #GstBuffer to get data pointer of. * @buf: a #GstBuffer to get data pointer of.
* *
* Retrieves a pointer to the data element of this buffer. * Retrieves a pointer to the data element of this buffer.
*
* Returns: the pointer to the actual data contents of the buffer.
*/ */
#define GST_BUFFER_DATA(buf) (GST_BUFFER_CAST(buf)->data) #define GST_BUFFER_DATA(buf) (GST_BUFFER_CAST(buf)->data)
/** /**
...@@ -98,8 +92,6 @@ typedef struct _GstBufferClass GstBufferClass; ...@@ -98,8 +92,6 @@ typedef struct _GstBufferClass GstBufferClass;
* @buf: a #GstBuffer to get data size of. * @buf: a #GstBuffer to get data size of.
* *
* Gets the size of the data in this buffer. * Gets the size of the data in this buffer.
*
* Returns: the buffer size in bytes
*/ */
#define GST_BUFFER_SIZE(buf) (GST_BUFFER_CAST(buf)->size) #define GST_BUFFER_SIZE(buf) (GST_BUFFER_CAST(buf)->size)
/** /**
...@@ -107,8 +99,6 @@ typedef struct _GstBufferClass GstBufferClass; ...@@ -107,8 +99,6 @@ typedef struct _GstBufferClass GstBufferClass;
* @buf: a #GstBuffer to get the timestamp of.: * @buf: a #GstBuffer to get the timestamp of.:
* *
* Gets the timestamp for this buffer. * Gets the timestamp for this buffer.
*
* Returns: the timestamp for this buffer
*/ */
#define GST_BUFFER_TIMESTAMP(buf) (GST_BUFFER_CAST(buf)->timestamp) #define GST_BUFFER_TIMESTAMP(buf) (GST_BUFFER_CAST(buf)->timestamp)
/** /**
...@@ -117,8 +107,6 @@ typedef struct _GstBufferClass GstBufferClass; ...@@ -117,8 +107,6 @@ typedef struct _GstBufferClass GstBufferClass;
* *
* Gets the duration in nanoseconds of the data in the buffer. * Gets the duration in nanoseconds of the data in the buffer.
* Value will be %GST_CLOCK_TIME_NONE if the duration is unknown. * Value will be %GST_CLOCK_TIME_NONE if the duration is unknown.
*
* Returns: the duration of the buffer
*/ */
#define GST_BUFFER_DURATION(buf) (GST_BUFFER_CAST(buf)->duration) #define GST_BUFFER_DURATION(buf) (GST_BUFFER_CAST(buf)->duration)
/** /**
...@@ -126,8 +114,6 @@ typedef struct _GstBufferClass GstBufferClass; ...@@ -126,8 +114,6 @@ typedef struct _GstBufferClass GstBufferClass;
* @buf: a #GstBuffer to get the caps of. * @buf: a #GstBuffer to get the caps of.
* *
* Gets the caps for this buffer. * Gets the caps for this buffer.
*
* Returns: the #GstCaps for this buffer
*/ */
#define GST_BUFFER_CAPS(buf) (GST_BUFFER_CAST(buf)->caps) #define GST_BUFFER_CAPS(buf) (GST_BUFFER_CAST(buf)->caps)
/** /**
...@@ -135,8 +121,6 @@ typedef struct _GstBufferClass GstBufferClass; ...@@ -135,8 +121,6 @@ typedef struct _GstBufferClass GstBufferClass;
* @buf: a #GstBuffer to get the offset of. * @buf: a #GstBuffer to get the offset of.
* *
* Gets the offset in the source file of the beginning of this buffer. * Gets the offset in the source file of the beginning of this buffer.
*
* Returns: the start offset for this buffer
*/ */
#define GST_BUFFER_OFFSET(buf) (GST_BUFFER_CAST(buf)->offset) #define GST_BUFFER_OFFSET(buf) (GST_BUFFER_CAST(buf)->offset)
/** /**
...@@ -144,8 +128,6 @@ typedef struct _GstBufferClass GstBufferClass; ...@@ -144,8 +128,6 @@ typedef struct _GstBufferClass GstBufferClass;
* @buf: a #GstBuffer to get the offset of. * @buf: a #GstBuffer to get the offset of.
* *
* Gets the offset in the source file of the end of this buffer. * Gets the offset in the source file of the end of this buffer.
*
* Returns: the end offset for this buffer
*/ */
#define GST_BUFFER_OFFSET_END(buf) (GST_BUFFER_CAST(buf)->offset_end) #define GST_BUFFER_OFFSET_END(buf) (GST_BUFFER_CAST(buf)->offset_end)
/** /**
...@@ -167,10 +149,8 @@ typedef struct _GstBufferClass GstBufferClass; ...@@ -167,10 +149,8 @@ typedef struct _GstBufferClass GstBufferClass;
/** /**
* GST_BUFFER_DURATION_IS_VALID: * GST_BUFFER_DURATION_IS_VALID:
* @buffer: the #GstBuffer to check for the duration * @buffer: the #GstBuffer to check for the duration
*
* Tests if the duration is known.
* *
* Returns: %TRUE for success * Tests if the duration is known.
*/ */
#define GST_BUFFER_DURATION_IS_VALID(buffer) (GST_CLOCK_TIME_IS_VALID (GST_BUFFER_DURATION (buffer))) #define GST_BUFFER_DURATION_IS_VALID(buffer) (GST_CLOCK_TIME_IS_VALID (GST_BUFFER_DURATION (buffer)))
/** /**
...@@ -178,8 +158,6 @@ typedef struct _GstBufferClass GstBufferClass; ...@@ -178,8 +158,6 @@ typedef struct _GstBufferClass GstBufferClass;
* @buffer: the #GstBuffer to check for the timestamp * @buffer: the #GstBuffer to check for the timestamp
* *
* Tests if the timestamp is known. * Tests if the timestamp is known.
*
* Returns: %TRUE for success
*/ */
#define GST_BUFFER_TIMESTAMP_IS_VALID(buffer) (GST_CLOCK_TIME_IS_VALID (GST_BUFFER_TIMESTAMP (buffer))) #define GST_BUFFER_TIMESTAMP_IS_VALID(buffer) (GST_CLOCK_TIME_IS_VALID (GST_BUFFER_TIMESTAMP (buffer)))
/** /**
...@@ -187,8 +165,6 @@ typedef struct _GstBufferClass GstBufferClass; ...@@ -187,8 +165,6 @@ typedef struct _GstBufferClass GstBufferClass;
* @buffer: the #GstBuffer to check for the start offset * @buffer: the #GstBuffer to check for the start offset
* *
* Tests if the start offset is known. * Tests if the start offset is known.
*
* Returns: %TRUE for success
*/ */
#define GST_BUFFER_OFFSET_IS_VALID(buffer) (GST_BUFFER_OFFSET (buffer) != GST_BUFFER_OFFSET_NONE) #define GST_BUFFER_OFFSET_IS_VALID(buffer) (GST_BUFFER_OFFSET (buffer) != GST_BUFFER_OFFSET_NONE)
/** /**
...@@ -196,8 +172,6 @@ typedef struct _GstBufferClass GstBufferClass; ...@@ -196,8 +172,6 @@ typedef struct _GstBufferClass GstBufferClass;
* @buffer: the #GstBuffer to check for the end offset * @buffer: the #GstBuffer to check for the end offset
* *
* Tests if the end offset is known. * Tests if the end offset is known.
*
* Returns: %TRUE for success
*/ */
#define GST_BUFFER_OFFSET_END_IS_VALID(buffer) (GST_BUFFER_OFFSET_END (buffer) != GST_BUFFER_OFFSET_NONE) #define GST_BUFFER_OFFSET_END_IS_VALID(buffer) (GST_BUFFER_OFFSET_END (buffer) != GST_BUFFER_OFFSET_NONE)
...@@ -306,8 +280,6 @@ G_STMT_START { \ ...@@ -306,8 +280,6 @@ G_STMT_START { \
* *
* Copies the given buffer using the copy function of the parent #GstData * Copies the given buffer using the copy function of the parent #GstData
* structure. * structure.
*
* Returns: a new #GstBuffer copy of the buffer.
*/ */
#define gst_buffer_copy(buf) GST_BUFFER_CAST (gst_mini_object_copy (GST_MINI_OBJECT (buf))) #define gst_buffer_copy(buf) GST_BUFFER_CAST (gst_mini_object_copy (GST_MINI_OBJECT (buf)))
/** /**
...@@ -315,17 +287,13 @@ G_STMT_START { \ ...@@ -315,17 +287,13 @@ G_STMT_START { \
* @buf: a #GstBuffer to check * @buf: a #GstBuffer to check
* *
* Tests if you can safely write data into a buffer's data array. * Tests if you can safely write data into a buffer's data array.
*
* Returns: %TRUE if buffer is writable
*/ */
#define gst_buffer_is_writable(buf) gst_mini_object_is_writable (GST_MINI_OBJECT (buf)) #define gst_buffer_is_writable(buf) gst_mini_object_is_writable (GST_MINI_OBJECT (buf))
/** /**
* gst_buffer_make_writable: * gst_buffer_make_writable:
* @buf: a #GstBuffer to make writable * @buf: a #GstBuffer to make writable
* *
* Makes a buffer writable. * Makes a writable buffer from the given buffer.
*
* Returns: a #GstBuffer that is writable
*/ */
#define gst_buffer_make_writable(buf) GST_BUFFER_CAST (gst_mini_object_make_writable (GST_MINI_OBJECT (buf))) #define gst_buffer_make_writable(buf) GST_BUFFER_CAST (gst_mini_object_make_writable (GST_MINI_OBJECT (buf)))
......
...@@ -55,7 +55,7 @@ typedef enum ...@@ -55,7 +55,7 @@ typedef enum
/** /**
* GstBusSyncHandler: * GstBusSyncHandler:
* @bus: the #GstBus that sent the message * @bus: the #GstBus that sent the message
* @messages: the #GstMessage * @message: the #GstMessage
* @data: user data that has been given, when registering the handler * @data: user data that has been given, when registering the handler
* *
* Handler will be invoked synchronously, when a new message has been injected * Handler will be invoked synchronously, when a new message has been injected
...@@ -63,11 +63,11 @@ typedef enum ...@@ -63,11 +63,11 @@ typedef enum
* *
* Returns: #GstBusSyncReply stating what to do with the message * Returns: #GstBusSyncReply stating what to do with the message
*/ */
typedef GstBusSyncReply (*GstBusSyncHandler) (GstBus * bus, GstMessage * message, gpointer data); typedef GstBusSyncReply (*GstBusSyncHandler) (GstBus * bus, GstMessage * message, gpointer data);
/** /**
* GstBusHandler: * GstBusHandler:
* @bus: the #GstBus that sent the message * @bus: the #GstBus that sent the message
* @messages: the #GstMessage * @message: the #GstMessage
* @data: user data that has been given, when registering the handler * @data: user data that has been given, when registering the handler
* *
* Handler will be invoked asynchronously, after a new message has been injected * Handler will be invoked asynchronously, after a new message has been injected
......
...@@ -54,19 +54,15 @@ G_BEGIN_DECLS ...@@ -54,19 +54,15 @@ G_BEGIN_DECLS
/** /**
* GST_STATIC_CAPS_ANY: * GST_STATIC_CAPS_ANY:
* *
* Creates a static caps that matches anything. This can be used in pad * Creates a new #GstCaps static caps that matches anything.
* templates. * This can be used in pad templates.
*
* Returns: a new #GstCaps instance
*/ */
#define GST_STATIC_CAPS_ANY GST_STATIC_CAPS("ANY") #define GST_STATIC_CAPS_ANY GST_STATIC_CAPS("ANY")
/** /**
* GST_STATIC_CAPS_NONE: * GST_STATIC_CAPS_NONE:
* *
* Creates a static caps that matches nothing. This can be used in pad * Creates a new #GstCaps static caps that matches nothing.
* templates. * This can be used in pad templates.
*
* Returns: a new #GstCaps instance
*/ */
#define GST_STATIC_CAPS_NONE GST_STATIC_CAPS("NONE") #define GST_STATIC_CAPS_NONE GST_STATIC_CAPS("NONE")
...@@ -74,20 +70,18 @@ G_BEGIN_DECLS ...@@ -74,20 +70,18 @@ G_BEGIN_DECLS
* GST_CAPS_IS_SIMPLE: * GST_CAPS_IS_SIMPLE:
* @caps: the #GstCaps instance to check * @caps: the #GstCaps instance to check
* *
* Convinience macro that checks if the number of structures in the gives caps * Convenience macro that checks if the number of structures in the given caps
* is exactly one. * is exactly one.
*
* Returns: %TRUE if caps has exactly one structure
*/ */
#define GST_CAPS_IS_SIMPLE(caps) (gst_caps_get_size(caps) == 1) #define GST_CAPS_IS_SIMPLE(caps) (gst_caps_get_size(caps) == 1)
#ifndef GST_DISABLE_DEPRECATED #ifndef GST_DISABLE_DEPRECATED
/** /**
* GST_DEBUG_CAPS: * GST_DEBUG_CAPS:
* @string: a string the should be prepend to the caps data. * @string: a string that should be prepended to the caps data.
* @caps: the #GstCaps instance to print * @caps: the #GstCaps instance to print
* *
* Convinience macro for prining out the contents of caps with GST_DEBUG(). * Convenience macro for printing out the contents of caps with GST_DEBUG().
* *
* Deprecated: do not use anymore * Deprecated: do not use anymore
*/ */
...@@ -97,12 +91,10 @@ G_BEGIN_DECLS ...@@ -97,12 +91,10 @@ G_BEGIN_DECLS
/** /**
* GST_STATIC_CAPS: * GST_STATIC_CAPS:
* @caps: the string describing the caps. * @string: the string describing the caps
*
* Creates a static caps from an input string. This can be used in pad
* templates.
* *
* Returns: a new #GstCaps instance * Creates a new #GstCaps static caps from an input string.
* This can be used in pad templates.
*/ */
#define GST_STATIC_CAPS(string) \ #define GST_STATIC_CAPS(string) \
{ \ { \
......
...@@ -28,46 +28,44 @@ ...@@ -28,46 +28,44 @@
G_BEGIN_DECLS G_BEGIN_DECLS
/* --- standard type macros --- */ /* --- standard type macros --- */
#define GST_TYPE_CLOCK (gst_clock_get_type ()) #define GST_TYPE_CLOCK (gst_clock_get_type ())
#define GST_CLOCK(clock) (G_TYPE_CHECK_INSTANCE_CAST ((clock), GST_TYPE_CLOCK, GstClock)) #define GST_CLOCK(clock) (G_TYPE_CHECK_INSTANCE_CAST ((clock), GST_TYPE_CLOCK, GstClock))
#define GST_IS_CLOCK(clock) (G_TYPE_CHECK_INSTANCE_TYPE ((clock), GST_TYPE_CLOCK)) #define GST_IS_CLOCK(clock) (G_TYPE_CHECK_INSTANCE_TYPE ((clock), GST_TYPE_CLOCK))
#define GST_CLOCK_CLASS(cclass) (G_TYPE_CHECK_CLASS_CAST ((cclass), GST_TYPE_CLOCK, GstClockClass)) #define GST_CLOCK_CLASS(cclass) (G_TYPE_CHECK_CLASS_CAST ((cclass), GST_TYPE_CLOCK, GstClockClass))
#define GST_IS_CLOCK_CLASS(cclass) (G_TYPE_CHECK_CLASS_TYPE ((cclass), GST_TYPE_CLOCK)) #define GST_IS_CLOCK_CLASS(cclass) (G_TYPE_CHECK_CLASS_TYPE ((cclass), GST_TYPE_CLOCK))
#define GST_CLOCK_GET_CLASS(clock) (G_TYPE_INSTANCE_GET_CLASS ((clock), GST_TYPE_CLOCK, GstClockClass)) #define GST_CLOCK_GET_CLASS(clock) (G_TYPE_INSTANCE_GET_CLASS ((clock), GST_TYPE_CLOCK, GstClockClass))
#define GST_CLOCK_CAST(clock) ((GstClock*)(clock)) #define GST_CLOCK_CAST(clock) ((GstClock*)(clock))
/** /**
* GstClockTime: * GstClockTime:
* *
* A datatype to hold a time, measured in nanoseconds. * A datatype to hold a time, measured in nanoseconds.
*/ */
typedef guint64 GstClockTime; typedef guint64 GstClockTime;
/** /**
* GstClockTimeDiff: * GstClockTimeDiff:
* *
* A datatype to hold a timedifference, measured in nanoseconds. * A datatype to hold a timedifference, measured in nanoseconds.
*/ */
typedef gint64 GstClockTimeDiff; typedef gint64 GstClockTimeDiff;
/** /**
* GstClockID: * GstClockID:
* *
* A detatype to hold the handle to an outstanding async clock callback * A detatype to hold the handle to an outstanding async clock callback
*/ */
typedef gpointer GstClockID; typedef gpointer GstClockID;
/** /**
* GST_CLOCK_TIME_NONE: * GST_CLOCK_TIME_NONE:
* *
* Constant to define an undefined clock time * Constant to define an undefined clock time
*/ */
#define GST_CLOCK_TIME_NONE ((GstClockTime)-1) #define GST_CLOCK_TIME_NONE ((GstClockTime) -1)
/** /**
* GST_CLOCK_TIME_IS_VALID: * GST_CLOCK_TIME_IS_VALID:
* @time: clock time to validate * @time: clock time to validate
* *
* Tests if a clock-time is defined. * Tests if a given #GstClockTime represents a valid defined time.
*
* Returns: %TRUE if clocktime is safe to use.
*/ */
#define GST_CLOCK_TIME_IS_VALID(time) ((time) != GST_CLOCK_TIME_NONE) #define GST_CLOCK_TIME_IS_VALID(time) ((time) != GST_CLOCK_TIME_NONE)
...@@ -101,19 +99,15 @@ typedef gpointer GstClockID; ...@@ -101,19 +99,15 @@ typedef gpointer GstClockID;
* @s: the first time * @s: the first time
* @e: the second time * @e: the second time
* *
* Calculate a difference between two clock times. * Calculate a difference between two clock times as a #GstClockTimeDiff.
*
* Returns: the difference as #GstClockTimeDiff
*/ */
#define GST_CLOCK_DIFF(s, e) (GstClockTimeDiff)((s) - (e)) #define GST_CLOCK_DIFF(s, e) (GstClockTimeDiff)((s) - (e))
/** /**
* GST_TIMEVAL_TO_TIME: * GST_TIMEVAL_TO_TIME: