aboutsummaryrefslogtreecommitdiffstats
path: root/src/bus.c
diff options
context:
space:
mode:
authorMattias Andrée <maandree@operamail.com>2015-05-17 14:32:09 +0200
committerMattias Andrée <maandree@operamail.com>2015-05-17 14:32:09 +0200
commit7a5814ca02265a3c3a9e44713d3708eb4c8d7bb0 (patch)
tree3103ec79cecfa8cad27c6bd597467af4d2b87ab3 /src/bus.c
parentadd timed example and fix timed polling (diff)
downloadbus-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 '')
-rw-r--r--src/bus.c13
1 files changed, 6 insertions, 7 deletions
diff --git a/src/bus.c b/src/bus.c
index 0517f7a..7609de6 100644
--- a/src/bus.c
+++ b/src/bus.c
@@ -978,11 +978,8 @@ done:
* 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)
@@ -1020,8 +1017,10 @@ 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)