Cleanup: Documentation comments for program signal handlers.

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

diff --git a/level_3/byte_dump/c/main/signal.h b/level_3/byte_dump/c/main/signal.h
index c4497987ca43409e3110fae21edc38619ff45f18..f5e63d61788fbff0cfa4e77b8f86f21259ac1fe7 100644 (file)
--- 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 3137967745c1aacd305e6fdda1b4e40a55f17f1d..4b17bf716c914d62f9bca715bcfacb9b4b1db1e6 100644 (file)
--- 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 cb9f9870248db43f8dcbbd633937e872a028506e..39b363b1a952e2701211b2e95e4673ea70c9a5f7 100644 (file)
--- 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 726d39a70bf7660bceb8d0f0bf7a98886dac8551..3812f6656f187fba1e5e8ce9667209b2f925e367 100644 (file)
--- 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 eafb74d59834804100a2b812ae14fec5ba992a9d..c7a043dc3138871bdc42dbcd89e6c208067d6601 100644 (file)
--- 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 3271d07ef080242450bc460c16230bc5254e9575..be8a0fba7cb6eb843625e1cd57c446edbc72fe07 100644 (file)
--- 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 a4d70134bf859049e891c7f89e577c259aa769bf..24cbd44b3b03c0ebc13cefbfbf4e60e50bcd9460 100644 (file)
--- 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 8c9ba039764db31ab09ea6c3d27e12a65ba09025..c3b4e4ae1fd3c501df3a6f02768ee82fa1b90863 100644 (file)
--- 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 1c02f4cd929a06c70dfddf64b38c44dd48bf1fe8..5ab13213d08fa180bf0a163e7b3bb15bc40197b0 100644 (file)
--- 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 e64bf48a4371fe2e107858e1279bb437998eee37..04dfda42d08b989f36c42e6810d64197d2f85d8c 100644 (file)
--- 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 e7b354620bcfc6a367bc12ceabaceedebcf15eb0..c8e3b1be5304a0a23049962bf1bb36705b27c221 100644 (file)
--- 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_)