summaryrefslogtreecommitdiff
path: root/gst/gstpoll.c
diff options
context:
space:
mode:
authorThibault Saunier <thibault.saunier@osg.samsung.com>2017-01-16 11:26:16 -0300
committerThibault Saunier <thibault.saunier@osg.samsung.com>2017-01-27 16:36:38 -0300
commita87b4551a6090663a1714f263d4e20fe75eb46ca (patch)
tree4367eb5b3027851743c464bd159abb6c7325f694 /gst/gstpoll.c
parent76f049bc49fc6fc56ca19d64749cfbe2f601c3c9 (diff)
Port gtk-doc comments to their equivalent markdown syntax
Modernizing our documentation and preparing a possible move to hotdoc. This commits also adds missing @title metadatas to all SECTIONs
Diffstat (limited to 'gst/gstpoll.c')
-rw-r--r--gst/gstpoll.c5
1 files changed, 3 insertions, 2 deletions
diff --git a/gst/gstpoll.c b/gst/gstpoll.c
index b2b1b681c..fd672ed40 100644
--- a/gst/gstpoll.c
+++ b/gst/gstpoll.c
@@ -23,6 +23,7 @@
*/
/**
* SECTION:gstpoll
+ * @title: GstPoll
* @short_description: Keep track of file descriptors and make it possible
* to wait on them in a cancellable way
*
@@ -734,7 +735,7 @@ no_socket_pair:
* timeouts.
*
* A timeout is performed with gst_poll_wait(). Multiple timeouts can be
- * performed from different threads.
+ * performed from different threads.
*
* Free-function: gst_poll_free
*
@@ -1636,7 +1637,7 @@ gst_poll_set_flushing (GstPoll * set, gboolean flushing)
*
* Write a byte to the control socket of the controllable @set.
* 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
* 1, meaning the control socket is set. After an equal amount of calls to