From f60bda0c58218b9c5a617e82c2dcdd7c2f203fb5 Mon Sep 17 00:00:00 2001 From: Andre Noll Date: Tue, 20 Sep 2011 22:27:18 +0200 Subject: [PATCH] recv: Improve documentation of generic_recv_pre_select(). Make it clear that this function returns the state of the given buffer tree node, i.e. > 0 on success, == 0 if there is nothing to do and < 0 on errors. --- recv_common.c | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/recv_common.c b/recv_common.c index f38184b4..53a105df 100644 --- a/recv_common.c +++ b/recv_common.c @@ -133,7 +133,8 @@ void print_receiver_helps(int detailed) * tree node indicates an error/eof condition. No file descriptors are added to * the fd sets of \a s. * - * \return Standard. + * \return The status of the btr node of the receiver node, i.e. the return + * value of the underlying call to \ref btr_node_status(). */ int generic_recv_pre_select(struct sched *s, struct task *t) { -- 2.39.5