* [PATCH] timeout: Clearified the ruturn behavior in comments
@ 2016-04-28 18:21 Tim Kourt
2016-04-28 18:23 ` Denis Kenzior
0 siblings, 1 reply; 2+ messages in thread
From: Tim Kourt @ 2016-04-28 18:21 UTC (permalink / raw)
To: ell
[-- Attachment #1: Type: text/plain, Size: 1231 bytes --]
---
ell/timeout.c | 6 ++++--
1 file changed, 4 insertions(+), 2 deletions(-)
diff --git a/ell/timeout.c b/ell/timeout.c
index 499c6d6..4ba4e6e 100644
--- a/ell/timeout.c
+++ b/ell/timeout.c
@@ -103,7 +103,8 @@ static inline int timeout_set(int fd, unsigned int seconds, long nanoseconds)
* The timeout will on fire once. The timeout handling needs to be rearmed
* with l_timeout_modify() to trigger again.
*
- * Returns: a newly allocated #l_timeout object
+ * Returns: a newly allocated #l_timeout object. On failure, the function
+ * returns NULL.
**/
LIB_EXPORT struct l_timeout *l_timeout_create(unsigned int seconds,
l_timeout_notify_cb_t callback,
@@ -126,7 +127,8 @@ LIB_EXPORT struct l_timeout *l_timeout_create(unsigned int seconds,
* The timeout will on fire once. The timeout handling needs to be rearmed
* with l_timeout_modify_with_nanoseconds() to trigger again.
*
- * Returns: a newly allocated #l_timeout object
+ * Returns: a newly allocated #l_timeout object. On failure, the function
+ * returns NULL.
**/
LIB_EXPORT struct l_timeout *l_timeout_create_with_nanoseconds(unsigned int seconds,
long nanoseconds, l_timeout_notify_cb_t callback,
--
2.5.0
^ permalink raw reply related [flat|nested] 2+ messages in thread
end of thread, other threads:[~2016-04-28 18:23 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2016-04-28 18:21 [PATCH] timeout: Clearified the ruturn behavior in comments Tim Kourt
2016-04-28 18:23 ` Denis Kenzior
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.