diff options
author | Mattias Andrée <maandree@operamail.com> | 2015-05-17 14:32:09 +0200 |
---|---|---|
committer | Mattias Andrée <maandree@operamail.com> | 2015-05-17 14:32:09 +0200 |
commit | 7a5814ca02265a3c3a9e44713d3708eb4c8d7bb0 (patch) | |
tree | 3103ec79cecfa8cad27c6bd597467af4d2b87ab3 /src/bus.h | |
parent | add timed example and fix timed polling (diff) | |
download | bus-7a5814ca02265a3c3a9e44713d3708eb4c8d7bb0.tar.gz bus-7a5814ca02265a3c3a9e44713d3708eb4c8d7bb0.tar.bz2 bus-7a5814ca02265a3c3a9e44713d3708eb4c8d7bb0.tar.xz |
update documentation for bus_poll
Signed-off-by: Mattias Andrée <maandree@operamail.com>
Diffstat (limited to 'src/bus.h')
-rw-r--r-- | src/bus.h | 13 |
1 files changed, 6 insertions, 7 deletions
@@ -247,11 +247,8 @@ int bus_read_timed(const bus_t *bus, int (*callback)(const char *message, void * * misbehave, is `bus_poll` is written to expect * this function to have been called. * - * @param bus Bus information - * @param flags `BUS_NOWAIT` if the bus should fail and set `errno` to - * `EAGAIN` if there isn't already a message available on - * the bus when `bus_poll` is called - * @return 0 on success, -1 on error + * @param bus Bus information + * @return 0 on success, -1 on error */ int bus_poll_start(bus_t *bus); @@ -273,8 +270,10 @@ int bus_poll_stop(const bus_t *bus); * started, the caller of this function should then * either call `bus_poll` again or `bus_poll_stop`. * - * @param bus Bus information - * @return The received message, `NULL` on error + * @param bus Bus information + * @param flags `BUS_NOWAIT` if the bus should fail and set `errno` to + * `EAGAIN` if there isn't already a message available on the bus + * @return The received message, `NULL` on error */ const char *bus_poll(bus_t *bus, int flags); |