From: Andre Noll <maan@tuebingen.mpg.de>
Date: Tue, 27 Dec 2016 01:01:55 +0000 (+0100)
Subject: signal.h: Add documentation of signal_pre_select().
X-Git-Tag: v0.5.7~3^2
X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=commitdiff_plain;h=c257c9c321c6e9494dbcbb6da0af675c3a2aa8e4;ds=sidebyside

signal.h: Add documentation of signal_pre_select().

It is a public function which should be annotated.
---

diff --git a/signal.h b/signal.h
index b5b06f35..742f677a 100644
--- a/signal.h
+++ b/signal.h
@@ -16,6 +16,22 @@ struct signal_task {
 	struct task *task;
 };
 
+/**
+ * A generic pre-select method for signal tasks.
+ *
+ * \param s Passed to para_fd_set().
+ * \param context Signal task pointer.
+ *
+ * This convenience helper is called from several programs which need to handle
+ * signals, including para_server and para_audiod. These programs define a
+ * signal task structure and set its ->pre_select method to this function which
+ * adds the file descriptor of the signal task to the set of descriptors to be
+ * watched in the next select() call.
+ *
+ * Although the second parameter must be in fact a pointer to a signal_task
+ * structure, the parameter is specified as void * here to match the
+ * ->pre_select method of struct task.
+ */
 _static_inline_ void signal_pre_select(struct sched *s, void *context)
 {
 	struct signal_task *st = context;