]> git.e2factory.org Git - e2factory.git/commitdiff
Correct e2lib.poll() documentation
authorTobias Ulmer <tu@emlix.com>
Fri, 15 Nov 2013 12:09:15 +0000 (13:09 +0100)
committerTobias Ulmer <tu@emlix.com>
Wed, 16 Nov 2016 14:41:17 +0000 (15:41 +0100)
Signed-off-by: Tobias Ulmer <tu@emlix.com>
generic/e2lib.lua

index 230ecf8d87215a4c0a8fc4e101998b6cd788f1c5..bc3847ce25cc481ca7193276d23143b9922203f6 100644 (file)
@@ -213,8 +213,9 @@ end
 -- Only indicates first selected file descriptor.
 -- @param timeout Timeout in milliseconds (number).
 -- @param fdvec Vector of file descriptors (table of numbers).
--- @return Returns 0 on timeout, < 0 on error and > 0 to indicate which file
---         descriptor triggered.
+-- @return Returns 0 on timeout, < 0 on error and > 0 for the position in fdvec
+-- that has an event waiting.
+
 -- @return True if it's a POLLIN event.
 -- @return True if it's a POLLOUT event.
 function e2lib.poll(timeout, fdvec)