From: Kevin Day <Kevin@kevux.org>
Date: Tue, 1 Jul 2025 02:51:33 +0000 (-0500)
Subject: Cleanup: Documentation comments for program signal handlers.
X-Git-Tag: 0.7.2^0
X-Git-Url: https://www.git.kevux.org/?a=commitdiff_plain;h=afa8469f836d2e00855dacd8d3705f7b12516b61;p=controller

Cleanup: Documentation comments for program signal handlers.

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

diff --git a/sources/c/program/controller/main/signal.h b/sources/c/program/controller/main/signal.h
index 1c029ab..d310a10 100644
--- a/sources/c/program/controller/main/signal.h
+++ b/sources/c/program/controller/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_controller_signal_handler_) && !defined(_di_thread_support_)
   extern void controller_signal_handler(controller_t * const main);