]> Kevux Git Server - kevux-tools/commitdiff
Cleanup: Documentation comments for program signal handlers.
authorKevin Day <Kevin@kevux.org>
Tue, 1 Jul 2025 02:50:51 +0000 (21:50 -0500)
committerKevin Day <Kevin@kevux.org>
Tue, 1 Jul 2025 02:50:51 +0000 (21:50 -0500)
The function references and "must not be NULL" messages are missing.

sources/c/program/kevux/tools/remove/main/signal.h
sources/c/program/kevux/tools/tacocat/main/signal.h

index e7ad5fc4927b092cccf7ed8d48c785bf06e40f3a..da48d53bf71489f27827b39a47939da807ed3f5e 100644 (file)
@@ -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);
index 38eac067cc60535f6dc70b3a6f90440a8c4e0f7d..e23ae367b205b9b6912ac477cfb7443c073f8f68 100644 (file)
@@ -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);