From e48e89fd9ad02924bb912a3bffd2dcf37f4a0ca0 Mon Sep 17 00:00:00 2001 From: Kevin Day Date: Sun, 9 Jul 2023 11:32:16 -0500 Subject: [PATCH] Cleanup: Documentation comments regarding "This alters setting.status" in programs. In such programs, this is comment is no longer accurate. --- level_3/fake/c/main/signal.h | 2 +- level_3/fss_identify/c/main/load.h | 2 +- level_3/fss_identify/c/main/process.h | 4 ++-- level_3/fss_identify/c/main/signal.h | 2 +- level_3/fss_read/c/main/signal.h | 2 +- level_3/fss_write/c/main/signal.h | 2 +- level_3/iki_read/c/main/signal.h | 2 +- level_3/iki_write/c/main/signal.h | 2 +- level_3/status_code/c/main/signal.h | 2 +- level_3/utf8/c/main/signal.h | 2 +- 10 files changed, 11 insertions(+), 11 deletions(-) diff --git a/level_3/fake/c/main/signal.h b/level_3/fake/c/main/signal.h index 89dc952..87ac4df 100644 --- 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 55552d6..fef66ee 100644 --- 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 1e8c8ab..f2a169e 100644 --- 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 9df4c8e..594492c 100644 --- 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 3cea0ae..0b82211 100644 --- 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 c72d814..9c5c310 100644 --- 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 e6d0967..bcec0e2 100644 --- 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 8ad8ab8..8918773 100644 --- 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 479f373..00134c2 100644 --- 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 8baa1e2..0d5bb92 100644 --- 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() * -- 1.8.3.1