aboutsummaryrefslogtreecommitdiffstats
path: root/src/bus.h
diff options
context:
space:
mode:
authorMattias Andrée <maandree@operamail.com>2015-04-26 08:58:45 +0200
committerMattias Andrée <maandree@operamail.com>2015-04-26 08:58:45 +0200
commit05fd0c0ea0694d5b69bf13f12fb3256b72028fcd (patch)
treea7f66b3348702203429f1673a4466d0844e65973 /src/bus.h
parentupdate dist (diff)
downloadbus-05fd0c0ea0694d5b69bf13f12fb3256b72028fcd.tar.gz
bus-05fd0c0ea0694d5b69bf13f12fb3256b72028fcd.tar.bz2
bus-05fd0c0ea0694d5b69bf13f12fb3256b72028fcd.tar.xz
fix doc
Signed-off-by: Mattias Andrée <maandree@operamail.com>
Diffstat (limited to '')
-rw-r--r--src/bus.h10
1 files changed, 5 insertions, 5 deletions
diff --git a/src/bus.h b/src/bus.h
index abae46b..d67b4f2 100644
--- a/src/bus.h
+++ b/src/bus.h
@@ -163,11 +163,11 @@ int bus_write(const bus_t *bus, const char *message);
* * 1: continue listening
* * -1: an error has occurred
* However, the function [`bus_read`] will invoke
- * `callback` with `message` one time directly after
- * it has started listening on the bus. This is to
- * the the program now it can safely continue with
- * any action that requires that the programs is
- * listening on the port.
+ * `callback` with `message` set to `NULL`one time
+ * directly after it has started listening on the
+ * bus. This is to the the program now it can safely
+ * continue with any action that requires that the
+ * programs is listening on the bus.
* @return 0 on success, -1 on error
*/
int bus_read(const bus_t *bus, int (*callback)(const char *message, void *user_data), void *user_data);