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

Cleanup: Documentation comments for program signal handlers.

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

diff --git a/sources/c/program/kevux/tools/remove/main/signal.h b/sources/c/program/kevux/tools/remove/main/signal.h
index e7ad5fc..da48d53 100644
--- a/sources/c/program/kevux/tools/remove/main/signal.h
+++ b/sources/c/program/kevux/tools/remove/main/signal.h
@@ -57,14 +57,13 @@ extern "C" {
  *   Must not be NULL.
  *
  *   This alters main.program.signal_received, setting it to a received signal.
+ *   This alters main.program.signal_status.
  *
- *   This alters setting.status:
- *     Errors with (error bit set) from: f_signal_open()
- *     Errors with (error bit set) 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_kt_remove_signal_handler_) && !defined(_di_thread_support_)
   extern void kt_remove_signal_handler(kt_remove_main_t * const main);
diff --git a/sources/c/program/kevux/tools/tacocat/main/signal.h b/sources/c/program/kevux/tools/tacocat/main/signal.h
index 38eac06..e23ae36 100644
--- a/sources/c/program/kevux/tools/tacocat/main/signal.h
+++ b/sources/c/program/kevux/tools/tacocat/main/signal.h
@@ -32,14 +32,13 @@ extern "C" {
  *   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_kt_tacocat_signal_handler_) && !defined(_di_thread_support_)
   extern void kt_tacocat_signal_handler(kt_tacocat_main_t * const main);