mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-09-29 23:32:33 +00:00
Code Issues 1 Projects Releases Wiki Activity

docs: Improve some docs

Browse source 
Rename some function variables and add some Return: to make the docs more happy.
This commit is contained in:
Wim Taymans 2009-03-12 10:48:21 +01:00
parent 15e7d1e9c7
commit 5467c64379
5 changed files with 18 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
gst/gstbuffer.h
View file

@ -370,6 +370,8 @@ gst_buffer_unref (GstBuffer * buf)
* *
* Create a copy of the given buffer. This will also make a newly allocated * Create a copy of the given buffer. This will also make a newly allocated
* copy of the data the source buffer contains. * copy of the data the source buffer contains.
*
* Returns: a new copy of @buf.
*/ */
#ifdef _FOOL_GTK_DOC_ #ifdef _FOOL_GTK_DOC_
G_INLINE_FUNC GstBuffer * gst_buffer_copy (const GstBuffer * buf); G_INLINE_FUNC GstBuffer * gst_buffer_copy (const GstBuffer * buf);

16
gst/gstevent.h
View file

@ -348,14 +348,14 @@ G_INLINE_FUNC GstEvent * gst_event_ref (GstEvent * event);
#endif #endif
static inline GstEvent * static inline GstEvent *
gst_event_ref (GstEvent * ev) gst_event_ref (GstEvent * event)
{ {
return (GstEvent *) gst_mini_object_ref (GST_MINI_OBJECT (ev)); return (GstEvent *) gst_mini_object_ref (GST_MINI_OBJECT (event));
} }
/** /**
* gst_event_unref: * gst_event_unref:
* @ev: The event to refcount * @event: The event to refcount
* *
* Decrease the refcount of an event, freeing it if the refcount reaches 0. * Decrease the refcount of an event, freeing it if the refcount reaches 0.
*/ */
@ -364,15 +364,15 @@ G_INLINE_FUNC void gst_event_unref (GstEvent * event);
#endif #endif
static inline void static inline void
gst_event_unref (GstEvent * ev) gst_event_unref (GstEvent * event)
{ {
gst_mini_object_unref (GST_MINI_OBJECT (ev)); gst_mini_object_unref (GST_MINI_OBJECT (event));
} }
/* copy event */ /* copy event */
/** /**
* gst_event_copy: * gst_event_copy:
* @ev: The event to copy * @event: The event to copy
* *
* Copy the event using the event specific copy function. * Copy the event using the event specific copy function.
*/ */
@ -381,9 +381,9 @@ G_INLINE_FUNC void gst_event_copy (GstEvent * event);
#endif #endif
static inline GstEvent * static inline GstEvent *
gst_event_copy (const GstEvent * ev) gst_event_copy (const GstEvent * event)
{ {
return GST_EVENT_CAST (gst_mini_object_copy (GST_MINI_OBJECT (ev))); return GST_EVENT_CAST (gst_mini_object_copy (GST_MINI_OBJECT (event)));
} }

2
gst/gstmessage.h
View file

@ -287,6 +287,8 @@ gst_message_unref (GstMessage * msg)
* *
* Creates a copy of the message. Returns a copy of the message. * Creates a copy of the message. Returns a copy of the message.
* *
* Returns: a new copy of @msg.
*
* MT safe * MT safe
*/ */
#ifdef _FOOL_GTK_DOC_ #ifdef _FOOL_GTK_DOC_

3
gst/gstpad.h
View file

@ -558,6 +558,7 @@ typedef struct _GstPadTemplate GstPadTemplate;
* @do_buffer_signals: counter counting installed buffer signals * @do_buffer_signals: counter counting installed buffer signals
* @do_event_signals: counter counting installed event signals * @do_event_signals: counter counting installed event signals
* @iterintlinkfunc: get the internal links iterator of this pad * @iterintlinkfunc: get the internal links iterator of this pad
* @block_destroy_data: notify function for gst_pad_set_blocked_async_full()
* *
* The #GstPad structure. Use the functions to update the variables. * The #GstPad structure. Use the functions to update the variables.
*/ */
@ -819,7 +820,7 @@ gboolean gst_pad_set_blocked_async (GstPad *pad, gboolean blocked,
GstPadBlockCallback callback, gpointer user_data); GstPadBlockCallback callback, gpointer user_data);
gboolean gst_pad_set_blocked_async_full (GstPad *pad, gboolean blocked, gboolean gst_pad_set_blocked_async_full (GstPad *pad, gboolean blocked,
GstPadBlockCallback callback, gpointer user_data, GstPadBlockCallback callback, gpointer user_data,
GDestroyNotify destroy_data); GDestroyNotify destroy_data);
gboolean gst_pad_is_blocked (GstPad *pad); gboolean gst_pad_is_blocked (GstPad *pad);
gboolean gst_pad_is_blocking (GstPad *pad); gboolean gst_pad_is_blocking (GstPad *pad);

4
gst/gstquery.h
View file

@ -189,6 +189,8 @@ GstIterator* gst_query_type_iterate_definitions (void);
* @q: a #GstQuery to increase the refcount of. * @q: a #GstQuery to increase the refcount of.
* *
* Increases the refcount of the given query by one. * Increases the refcount of the given query by one.
*
* Returns: @q
*/ */
#ifdef _FOOL_GTK_DOC_ #ifdef _FOOL_GTK_DOC_
G_INLINE_FUNC GstQuery * gst_query_ref (GstQuery * q); G_INLINE_FUNC GstQuery * gst_query_ref (GstQuery * q);
@ -224,6 +226,8 @@ gst_query_unref (GstQuery * q)
* *
* Copies the given query using the copy function of the parent #GstData * Copies the given query using the copy function of the parent #GstData
* structure. * structure.
*
* Returns: a new copy of @q.
*/ */
#ifdef _FOOL_GTK_DOC_ #ifdef _FOOL_GTK_DOC_
G_INLINE_FUNC GstQuery * gst_query_copy (const GstQuery * q); G_INLINE_FUNC GstQuery * gst_query_copy (const GstQuery * q);