Cleanup: Documentation comments regarding "This alters setting.status" in programs.

In such programs, this is comment is no longer accurate.

diff --git a/level_3/fake/c/main/signal.h b/level_3/fake/c/main/signal.h
index 89dc952f9099f88a37f08b906a625222790ec250..87ac4df7629f6eb5e056eb6d3c21253f99ed9e56 100644 (file)
--- a/level_3/fake/c/main/signal.h
+++ b/level_3/fake/c/main/signal.h
@@ -67,7 +67,7 @@ extern "C" {
  *
  *   This alters main.program.signal_received, setting it to a received signal.
  *
- *   This alters setting.status:
+ *   This alters main.setting.state.status:
  *     Errors (with error bit) from: f_signal_open()
  *     Errors (with error bit) from: f_signal_wait()
  *

diff --git a/level_3/fss_identify/c/main/load.h b/level_3/fss_identify/c/main/load.h
index 55552d6d447f7c98272682b427ca51fbb160adcc..fef66ee5f9a4570ff8d3d94dff1abdcd2a73a652 100644 (file)
--- a/level_3/fss_identify/c/main/load.h
+++ b/level_3/fss_identify/c/main/load.h
@@ -18,7 +18,7 @@
  * @param main
  *   The main program and settings data.
  *
- *   This alters setting.status:
+ *   This alters main.setting.state.status:
  *     F_none on success.
  *
  *     Errors (with error bit) from: f_file_stream_read_block().

diff --git a/level_3/fss_identify/c/main/process.h b/level_3/fss_identify/c/main/process.h
index 1e8c8aba89c81feb7523315c2d00dc99393bcef6..f2a169e0f726e86d7dc25b2c2e8fd1175d385be4 100644 (file)
--- a/level_3/fss_identify/c/main/process.h
+++ b/level_3/fss_identify/c/main/process.h
@@ -21,7 +21,7 @@
  *
  *   This alters main.program.signal_received, setting it to a received signal.
  *
- *   This alters setting.status:
+ *   This alters main.setting.state.status:
  *     F_none on success.
  *
  *     Errors (with error bit) from: fll_fss_identify().
@@ -43,7 +43,7 @@
  *
  *   This alters main.program.signal_received, setting it to a received signal.
  *
- *   This alters setting.status:
+ *   This alters main.setting.state.status:
  *     Errors (with error bit) from: f_compare_dynamic_partial_string().
  *     Errors (with error bit) from: f_compare_dynamic_string().
  *     Errors (with error bit) from: fl_conversion_dynamic_partial_to_hexidecimal_unsigned().

diff --git a/level_3/fss_identify/c/main/signal.h b/level_3/fss_identify/c/main/signal.h
index 9df4c8e4b17d6ac75b58a15b46c46f30c515c7a4..594492c74ede44dc8b183ae135025f45e2758a24 100644 (file)
--- a/level_3/fss_identify/c/main/signal.h
+++ b/level_3/fss_identify/c/main/signal.h
@@ -67,7 +67,7 @@ extern "C" {
  *
  *   This alters main.program.signal_received, setting it to a received signal.
  *
- *   This alters setting.status:
+ *   This alters main.setting.state.status:
  *     Errors (with error bit) from: f_signal_open()
  *     Errors (with error bit) from: f_signal_wait()
  *

diff --git a/level_3/fss_read/c/main/signal.h b/level_3/fss_read/c/main/signal.h
index 3cea0ae5f0534544ed57f6ed487998c772e640bb..0b82211b5ff5fa4c8b1406c3f15a754ede795082 100644 (file)
--- a/level_3/fss_read/c/main/signal.h
+++ b/level_3/fss_read/c/main/signal.h
@@ -67,7 +67,7 @@ extern "C" {
  *
  *   This alters main.program.signal_received, setting it to a received signal.
  *
- *   This alters setting.status:
+ *   This alters main.setting.state.status:
  *     Errors (with error bit) from: f_signal_open()
  *     Errors (with error bit) from: f_signal_wait()
  *

diff --git a/level_3/fss_write/c/main/signal.h b/level_3/fss_write/c/main/signal.h
index c72d814e204f36c0ef26cdec87a5f79a606cd4a0..9c5c310175e764e1d784b1462aba13d71d345638 100644 (file)
--- a/level_3/fss_write/c/main/signal.h
+++ b/level_3/fss_write/c/main/signal.h
@@ -67,7 +67,7 @@ extern "C" {
  *
  *   This alters main.program.signal_received, setting it to a received signal.
  *
- *   This alters setting.status:
+ *   This alters main.setting.state.status:
  *     Errors (with error bit) from: f_signal_open()
  *     Errors (with error bit) from: f_signal_wait()
  *

diff --git a/level_3/iki_read/c/main/signal.h b/level_3/iki_read/c/main/signal.h
index e6d096779a490b0ee053a0947263d7bdf7ec7e51..bcec0e25d0f26e2effc224ef1ded693013648a59 100644 (file)
--- a/level_3/iki_read/c/main/signal.h
+++ b/level_3/iki_read/c/main/signal.h
@@ -67,7 +67,7 @@ extern "C" {
  *
  *   This alters main.program.signal_received, setting it to a received signal.
  *
- *   This alters setting.status:
+ *   This alters main.setting.state.status:
  *     Errors (with error bit) from: f_signal_open()
  *     Errors (with error bit) from: f_signal_wait()
  *

diff --git a/level_3/iki_write/c/main/signal.h b/level_3/iki_write/c/main/signal.h
index 8ad8ab8c8d036aaf1896e132ab0bcd851cf8292c..891877300cc15a2b530cc912a2cd521009cccc07 100644 (file)
--- a/level_3/iki_write/c/main/signal.h
+++ b/level_3/iki_write/c/main/signal.h
@@ -67,7 +67,7 @@ extern "C" {
  *
  *   This alters main.program.signal_received, setting it to a received signal.
  *
- *   This alters setting.status:
+ *   This alters main.setting.state.status:
  *     Errors (with error bit) from: f_signal_open()
  *     Errors (with error bit) from: f_signal_wait()
  *

diff --git a/level_3/status_code/c/main/signal.h b/level_3/status_code/c/main/signal.h
index 479f373b0c55055520bf9fdf11a121368f0f0fd8..00134c2126a4a98ddf7d45e4906ae70456c0e515 100644 (file)
--- a/level_3/status_code/c/main/signal.h
+++ b/level_3/status_code/c/main/signal.h
@@ -67,7 +67,7 @@ extern "C" {
  *
  *   This alters main.program.signal_received, setting it to a received signal.
  *
- *   This alters setting.status:
+ *   This alters main.setting.state.status:
  *     Errors (with error bit) from: f_signal_open()
  *     Errors (with error bit) from: f_signal_wait()
  *

diff --git a/level_3/utf8/c/main/signal.h b/level_3/utf8/c/main/signal.h
index 8baa1e2a32152f335939c33420396e792de97836..0d5bb92c6ac7be258924e9036644b79e5537e79b 100644 (file)
--- a/level_3/utf8/c/main/signal.h
+++ b/level_3/utf8/c/main/signal.h
@@ -67,7 +67,7 @@ extern "C" {
  *
  *   This alters main.program.signal_received, setting it to a received signal.
  *
- *   This alters setting.status:
+ *   This alters main.setting.state.status:
  *     Errors (with error bit) from: f_signal_open()
  *     Errors (with error bit) from: f_signal_wait()
  *