crypt_common.c: Add missing doxygen documentation.

[paraslash.git] / recv_common.c

diff --git a/recv_common.c b/recv_common.c
index 6517948d4cd9d1638eed2e50271e46fbce73a62b..f38184b4484b3db6f263ac76b2c39e42adaa86c9 100644 (file)
--- a/recv_common.c
+++ b/recv_common.c
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2006-2010 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2006-2011 Andre Noll <maan@systemlinux.org>
  *
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
@@ -123,6 +123,18 @@ void print_receiver_helps(int detailed)
        }
 }
 
+/**
+ * Simple pre-select hook, used by all receivers.
+ *
+ * \param s Scheduler info.
+ * \param t Determines the receiver node.
+ *
+ * This requests a minimal delay from the scheduler if the status of the buffer
+ * tree node indicates an error/eof condition. No file descriptors are added to
+ * the fd sets of \a s.
+ *
+ * \return Standard.
+ */
 int generic_recv_pre_select(struct sched *s, struct task *t)
 {
        struct receiver_node *rn = container_of(t, struct receiver_node, task);