io: fix example in io_plan.h which didn't compile.
authorRusty Russell <rusty@rustcorp.com.au>
Tue, 11 Nov 2014 05:40:21 +0000 (16:10 +1030)
committerRusty Russell <rusty@rustcorp.com.au>
Tue, 11 Nov 2014 05:40:21 +0000 (16:10 +1030)
This was found because ccanlint now looks for examples here too.

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
ccan/io/io_plan.h

index 1781856ea6f8e11a75cf54e11b2f79e848516c39..1d503133b6ddb24f4f50cb2e4d12c4fb3e9732d3 100644 (file)
@@ -35,22 +35,24 @@ enum io_direction {
  * io_set_plan() when you've initialized it.
  *
  * Example:
+ * #include <ccan/io/io_plan.h>
+ *
  * // Simple helper to read a single char.
  * static int do_readchar(int fd, struct io_plan_arg *arg)
  * {
  *     return read(fd, arg->u1.cp, 1) <= 0 ? -1 : 1;
  * }
  *
- * struct io_plan *io_read_char_(struct io_conn *conn, char *in,
+ * static struct io_plan *io_read_char_(struct io_conn *conn, char *in,
  *                              struct io_plan *(*next)(struct io_conn*,void*),
- *                              void *arg)
+ *                              void *next_arg)
  * {
- *     struct io_plan_arg *arg = io_get_plan_arg(conn, IO_IN);
+ *     struct io_plan_arg *arg = io_plan_arg(conn, IO_IN);
  *
  *     // Store information we need in the plan unions u1 and u2.
  *     arg->u1.cp = in;
  *
- *     return io_set_plan(conn, IO_IN, do_readchar, next, arg);
+ *     return io_set_plan(conn, IO_IN, do_readchar, next, next_arg);
  * }
  */
 struct io_plan_arg *io_plan_arg(struct io_conn *conn, enum io_direction dir);