mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2025-01-12 10:25:33 +00:00
Code Issues 1 Projects Releases Wiki Activity

gstpoll: Fix up documentation strings.

Browse source 
Note the changed behaviour of gst_poll_wait for timer GstPoll's, and
fix a couple of spelling errors.
This commit is contained in:
Jan Schmidt 2009-03-25 17:31:16 +00:00
parent df30f60048
commit 31669a4819
1 changed files with 11 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
gst/gstpoll.c
View file

@ -505,7 +505,9 @@ not_controllable:
/** /**
* gst_poll_new_timer: * gst_poll_new_timer:
* *
* Create a new poll object that can be used for scheduling cancelable timeouts. * Create a new poll object that can be used for scheduling cancellable
* timeouts.
*
* A timeout is performed with gst_poll_wait(). Multiple timeouts can be * A timeout is performed with gst_poll_wait(). Multiple timeouts can be
* performed from different threads. * performed from different threads.
* *
@ -1055,8 +1057,12 @@ gst_poll_check_ctrl_commands (GstPoll * set, gint res, gboolean * restarting)
* Wait for activity on the file descriptors in @set. This function waits up to * Wait for activity on the file descriptors in @set. This function waits up to
* the specified @timeout. A timeout of #GST_CLOCK_TIME_NONE waits forever. * the specified @timeout. A timeout of #GST_CLOCK_TIME_NONE waits forever.
* *
* When this function is called from multiple threads, -1 will be returned with * For GstPoll objects created with gst_poll_new(), this function can only be
* errno set to EPERM. * called from a single thread at a time threads. If called from multiple
* threads, -1 will be returned with errno set to EPERM.
*
* This is not true for timer GstPoll objects created with gst_poll_new_timer(),
* where it is allowed to have multiple threads waiting simultaneously.
* *
* Returns: The number of #GstPollFD in @set that have activity or 0 when no * Returns: The number of #GstPollFD in @set that have activity or 0 when no
* activity was detected after @timeout. If an error occurs, -1 is returned * activity was detected after @timeout. If an error occurs, -1 is returned
@ -1424,7 +1430,7 @@ gst_poll_set_flushing (GstPoll * set, gboolean flushing)
* @set: a #GstPoll. * @set: a #GstPoll.
* *
* Write a byte to the control socket of the controllable @set. * Write a byte to the control socket of the controllable @set.
* This function is mostly usefull for timer #GstPoll objects created with * This function is mostly useful for timer #GstPoll objects created with
* gst_poll_new_timer(). * gst_poll_new_timer().
* *
* It will make any current and future gst_poll_wait() function return with * It will make any current and future gst_poll_wait() function return with
@ -1465,7 +1471,7 @@ gst_poll_write_control (GstPoll * set)
* @set: a #GstPoll. * @set: a #GstPoll.
* *
* Read a byte from the control socket of the controllable @set. * Read a byte from the control socket of the controllable @set.
* This function is mostly usefull for timer #GstPoll objects created with * This function is mostly useful for timer #GstPoll objects created with
* gst_poll_new_timer(). * gst_poll_new_timer().
* *
* Returns: %TRUE on success. %FALSE when @set is not controllable or when there * Returns: %TRUE on success. %FALSE when @set is not controllable or when there