Cleanup: Documentation comments for program signal handlers.

The function references and "must not be NULL" messages are missing.

diff --git a/sources/c/program/control/main/signal.h b/sources/c/program/control/main/signal.h
index d7702dd3eee94d57403f2501b03482e72f70cf45..02f46feaf6284dc38ae10ba339d1dc3c655ac7c9 100644 (file)
--- a/sources/c/program/control/main/signal.h
+++ b/sources/c/program/control/main/signal.h
@@ -33,15 +33,16 @@ extern "C" {
  * @param main
  *   The main program and settings data.
  *
+ *   Must not be NULL.
+ *
  *   This alters main.program.signal_received, setting it to a received signal.
+ *   This alters main.program.signal_status.
  *
- *   This alters main.setting.state.status:
- *     Errors (with error bit) from: f_signal_open()
- *     Errors (with error bit) from: f_signal_wait()
+ *   This does not alter main.setting.state.status.
  *
- * @see f_signal_close()
- * @see f_signal_open()
- * @see f_signal_wait()
+ * @see f_signal_set_add()
+ * @see f_signal_set_empty()
+ * @see fll_program_standard_signal_received_wait()
  */
 #if !defined(_di_control_signal_handler_) && !defined(_di_thread_support_)
   extern void control_signal_handler(control_main_t * const main);