From: Tim-Philipp Müller <tim@centricular.com>
Date: Fri, 8 Jun 2018 16:58:43 +0000 (+0100)
Subject: poll: minor docs clarification
X-Git-Tag: 1.16.2~357
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=b0777476ff687a23e5dc98a09e8b63a1a005439e;p=platform%2Fupstream%2Fgstreamer.git

poll: minor docs clarification

'Not implemented' could be misinterpreted to mean that
the API doesn't even exist there.
---

diff --git a/gst/gstpoll.c b/gst/gstpoll.c
index 421b884..5e0a668 100644
--- a/gst/gstpoll.c
+++ b/gst/gstpoll.c
@@ -1073,9 +1073,10 @@ gst_poll_fd_ctl_read (GstPoll * set, GstPollFD * fd, gboolean active)
  * Control whether the descriptor @fd in @set will be monitored for
  * exceptional conditions (POLLPRI).
  *
- * Not available on Windows.
+ * Not implemented on Windows (will just return %FALSE there).
  *
  * Returns: %TRUE if the descriptor was successfully updated.
+ *
  * Since: 1.16
  */
 gboolean
@@ -1343,9 +1344,10 @@ gst_poll_fd_can_write (const GstPoll * set, GstPollFD * fd)
  *
  * Check if @fd in @set has an exceptional condition (POLLPRI).
  *
- * Not available on Windows.
+ * Not implemented on Windows (will just return %FALSE there).
  *
  * Returns: %TRUE if the descriptor has an exceptional condition.
+ *
  * Since: 1.16
  */
 gboolean