From 7fddb29aadb502f8821b1cfc1c0f55683e9b42fa Mon Sep 17 00:00:00 2001 From: Kevin Day Date: Mon, 30 Jun 2025 21:49:49 -0500 Subject: [PATCH] Cleanup: Documentation comments for program signal handlers. The function references and "must not be NULL" messages are missing. --- level_3/byte_dump/c/main/signal.h | 4 ++++ level_3/example/c/main/signal.h | 4 ++++ level_3/fake/c/main/signal.h | 4 ++++ level_3/firewall/c/main/signal.h | 4 ++++ level_3/fss_identify/c/main/signal.h | 4 ++++ level_3/fss_read/c/main/signal.h | 4 ++++ level_3/fss_write/c/main/signal.h | 4 ++++ level_3/iki_read/c/main/signal.h | 4 ++++ level_3/iki_write/c/main/signal.h | 4 ++++ level_3/status_code/c/main/signal.h | 4 ++++ level_3/utf8/c/main/signal.h | 4 ++++ 11 files changed, 44 insertions(+) diff --git a/level_3/byte_dump/c/main/signal.h b/level_3/byte_dump/c/main/signal.h index c449798..f5e63d6 100644 --- a/level_3/byte_dump/c/main/signal.h +++ b/level_3/byte_dump/c/main/signal.h @@ -33,11 +33,15 @@ 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 does not alter main.setting.state.status. * + * @see f_signal_set_add() + * @see f_signal_set_empty() * @see fll_program_standard_signal_received_wait() */ #if !defined(_di_byte_dump_signal_handler_) && !defined(_di_thread_support_) diff --git a/level_3/example/c/main/signal.h b/level_3/example/c/main/signal.h index 3137967..4b17bf7 100644 --- a/level_3/example/c/main/signal.h +++ b/level_3/example/c/main/signal.h @@ -33,11 +33,15 @@ 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 does not alter main.setting.state.status. * + * @see f_signal_set_add() + * @see f_signal_set_empty() * @see fll_program_standard_signal_received_wait() */ #if !defined(_di_example_signal_handler_) && !defined(_di_thread_support_) diff --git a/level_3/fake/c/main/signal.h b/level_3/fake/c/main/signal.h index cb9f987..39b363b 100644 --- a/level_3/fake/c/main/signal.h +++ b/level_3/fake/c/main/signal.h @@ -33,11 +33,15 @@ 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 does not alter main.setting.state.status. * + * @see f_signal_set_add() + * @see f_signal_set_empty() * @see fll_program_standard_signal_received_wait() */ #if !defined(_di_fake_signal_handler_) && !defined(_di_thread_support_) diff --git a/level_3/firewall/c/main/signal.h b/level_3/firewall/c/main/signal.h index 726d39a..3812f66 100644 --- a/level_3/firewall/c/main/signal.h +++ b/level_3/firewall/c/main/signal.h @@ -33,11 +33,15 @@ 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 does not alter main.setting.state.status. * + * @see f_signal_set_add() + * @see f_signal_set_empty() * @see fll_program_standard_signal_received_wait() */ #if !defined(_di_firewall_signal_handler_) && !defined(_di_thread_support_) diff --git a/level_3/fss_identify/c/main/signal.h b/level_3/fss_identify/c/main/signal.h index eafb74d..c7a043d 100644 --- a/level_3/fss_identify/c/main/signal.h +++ b/level_3/fss_identify/c/main/signal.h @@ -33,11 +33,15 @@ 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 does not alter main.setting.state.status. * + * @see f_signal_set_add() + * @see f_signal_set_empty() * @see fll_program_standard_signal_received_wait() */ #if !defined(_di_fss_identify_signal_handler_) && !defined(_di_thread_support_) diff --git a/level_3/fss_read/c/main/signal.h b/level_3/fss_read/c/main/signal.h index 3271d07..be8a0fb 100644 --- a/level_3/fss_read/c/main/signal.h +++ b/level_3/fss_read/c/main/signal.h @@ -33,11 +33,15 @@ 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 does not alter main.setting.state.status. * + * @see f_signal_set_add() + * @see f_signal_set_empty() * @see fll_program_standard_signal_received_wait() */ #if !defined(_di_fss_read_signal_handler_) && !defined(_di_thread_support_) diff --git a/level_3/fss_write/c/main/signal.h b/level_3/fss_write/c/main/signal.h index a4d7013..24cbd44 100644 --- a/level_3/fss_write/c/main/signal.h +++ b/level_3/fss_write/c/main/signal.h @@ -33,11 +33,15 @@ 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 does not alter main.setting.state.status. * + * @see f_signal_set_add() + * @see f_signal_set_empty() * @see fll_program_standard_signal_received_wait() */ #if !defined(_di_fss_write_signal_handler_) && !defined(_di_thread_support_) diff --git a/level_3/iki_read/c/main/signal.h b/level_3/iki_read/c/main/signal.h index 8c9ba03..c3b4e4a 100644 --- a/level_3/iki_read/c/main/signal.h +++ b/level_3/iki_read/c/main/signal.h @@ -33,11 +33,15 @@ 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 does not alter main.setting.state.status. * + * @see f_signal_set_add() + * @see f_signal_set_empty() * @see fll_program_standard_signal_received_wait() */ #if !defined(_di_iki_read_signal_handler_) && !defined(_di_thread_support_) diff --git a/level_3/iki_write/c/main/signal.h b/level_3/iki_write/c/main/signal.h index 1c02f4c..5ab1321 100644 --- a/level_3/iki_write/c/main/signal.h +++ b/level_3/iki_write/c/main/signal.h @@ -33,11 +33,15 @@ 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 does not alter main.setting.state.status. * + * @see f_signal_set_add() + * @see f_signal_set_empty() * @see fll_program_standard_signal_received_wait() */ #if !defined(_di_iki_write_signal_handler_) && !defined(_di_thread_support_) diff --git a/level_3/status_code/c/main/signal.h b/level_3/status_code/c/main/signal.h index e64bf48..04dfda4 100644 --- a/level_3/status_code/c/main/signal.h +++ b/level_3/status_code/c/main/signal.h @@ -33,11 +33,15 @@ 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 does not alter main.setting.state.status. * + * @see f_signal_set_add() + * @see f_signal_set_empty() * @see fll_program_standard_signal_received_wait() */ #if !defined(_di_status_code_signal_handler_) && !defined(_di_thread_support_) diff --git a/level_3/utf8/c/main/signal.h b/level_3/utf8/c/main/signal.h index e7b3546..c8e3b1b 100644 --- a/level_3/utf8/c/main/signal.h +++ b/level_3/utf8/c/main/signal.h @@ -33,11 +33,15 @@ 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 does not alter main.setting.state.status. * + * @see f_signal_set_add() + * @see f_signal_set_empty() * @see fll_program_standard_signal_received_wait() */ #if !defined(_di_utf8_signal_handler_) && !defined(_di_thread_support_) -- 1.8.3.1