From: Kevin Day <kevin@kevux.org>
Date: Sun, 18 Jun 2023 16:59:41 +0000 (-0500)
Subject: Cleanup: Remove incorrect documentation content about return type.
X-Git-Url: https://git.kevux.org/?a=commitdiff_plain;h=71cb9426c5e17a77a98c59915843f4a479daab88;p=fll

Cleanup: Remove incorrect documentation content about return type.

The comment no longer applies as the functions return void.
---

diff --git a/level_3/fss_read/c/main/fss_read.h b/level_3/fss_read/c/main/fss_read.h
index 40bf80f..2dd5064 100644
--- a/level_3/fss_read/c/main/fss_read.h
+++ b/level_3/fss_read/c/main/fss_read.h
@@ -127,8 +127,6 @@ extern "C" {
  *     F_true on success when performing verification and verify passed.
  *     F_false on success when performing verification and verify failed.
  *     F_interrupt on (exit) signal received.
- *
- *     F_parameter (with error bit) if main is NULL or setting is NULL.
  */
 #ifndef _di_fss_read_main_
   extern void fss_read_main(void * const main);
@@ -167,8 +165,6 @@ extern "C" {
  *   This alters main.setting.state.status:
  *     F_none on success.
  *
- *     F_parameter (with error bit) if main is NULL or setting is NULL.
- *
  *     Errors (with error bit) from: f_string_dynamic_append_assure().
  *
  *     Errors (with error bit) from: fss_read_signal_check().
diff --git a/level_3/fss_read/c/main/main.h b/level_3/fss_read/c/main/main.h
index 86e79b9..a5fdf2b 100644
--- a/level_3/fss_read/c/main/main.h
+++ b/level_3/fss_read/c/main/main.h
@@ -69,8 +69,6 @@ extern int main(const int argc, const f_string_t *argv, const f_string_t *envp);
  *     F_data_not on success but nothing was provided to operate with.
  *     F_interrupt on (exit) signal received.
  *
- *     F_parameter (with error bit) if main is NULL or setting is NULL.
- *
  *     Errors (with error bit) from: f_console_parameter_process().
  *     Errors (with error bit) from: f_file_stream_open().
  *     Errors (with error bit) from: f_string_dynamics_resize().
diff --git a/level_3/fss_read/c/main/process_normal.h b/level_3/fss_read/c/main/process_normal.h
index 4a37ea4..44c7273 100644
--- a/level_3/fss_read/c/main/process_normal.h
+++ b/level_3/fss_read/c/main/process_normal.h
@@ -91,8 +91,6 @@ extern "C" {
  *     F_none on success but line not yet found.
  *     F_success on success and line is found and printed.
  *
- *     F_parameter (with error bit) if main is NULL or setting is NULL.
- *
  *     Errors (with error bit) from: f_string_dynamic_append_assure().
  *
  *     Errors (with error bit) from: fss_read_signal_check().
diff --git a/level_3/fss_read/c/payload/fss_read.h b/level_3/fss_read/c/payload/fss_read.h
index b97f2a9..5d8dc41 100644
--- a/level_3/fss_read/c/payload/fss_read.h
+++ b/level_3/fss_read/c/payload/fss_read.h
@@ -127,8 +127,6 @@ extern "C" {
  *   This alters main.setting.state.status:
  *     F_none on success.
  *     F_interrupt on (exit) signal received.
- *
- *     F_parameter (with error bit) if main is NULL or setting is NULL.
  */
 #ifndef _di_fss_read_payload_process_set_
   extern void fss_read_payload_process_set(void * const main);
@@ -151,7 +149,6 @@ extern "C" {
  *   This alters setting.state.status:
  *     F_none on success.
  *
- *     F_parameter (with error bit) if main is NULL or setting is NULL.
  *     F_parameter (with error bit) on parameter error.
  *
  *   This alters setting.state.status: