Cleanup: Documentation comments in fss_read.

The F_interrupt comments are now more correct.

diff --git a/level_3/fss_read/c/main/fss_read.h b/level_3/fss_read/c/main/fss_read.h
index 2dd5064c4b2978b7e4b4d7b78d5a891ff2460512..888edd341ff871de64df287ae597252df6708b46 100644 (file)
--- a/level_3/fss_read/c/main/fss_read.h
+++ b/level_3/fss_read/c/main/fss_read.h
@@ -126,7 +126,8 @@ extern "C" {
  *     F_none on success.
  *     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.
+ *
+ *     Errors (with error bit) from: main.callback.process_normal().
  */
 #ifndef _di_fss_read_main_
   extern void fss_read_main(void * const main);

diff --git a/level_3/fss_read/c/main/main.h b/level_3/fss_read/c/main/main.h
index a5fdf2b1e101bc54c6ebbf5fb2c66f02e2b0a769..f913001c7844584febd0590295e12f11c91bdefb 100644 (file)
--- a/level_3/fss_read/c/main/main.h
+++ b/level_3/fss_read/c/main/main.h
@@ -67,7 +67,8 @@ extern int main(const int argc, const f_string_t *argv, const f_string_t *envp);
  *   This alters main.setting.state.status:
  *     F_none on success.
  *     F_data_not on success but nothing was provided to operate with.
- *     F_interrupt on (exit) signal received.
+
+ *     F_parameter (with error bit) on parameter related error.
  *
  *     Errors (with error bit) from: f_console_parameter_process().
  *     Errors (with error bit) from: f_file_stream_open().

diff --git a/level_3/fss_read/c/payload/fss_read.h b/level_3/fss_read/c/payload/fss_read.h
index 5d8dc410ceb4a2b7a03eb5c7bc1d4fcaf17edd6c..3df87a6c6c568cb799ce88d84b533c0ded0c299a 100644 (file)
--- a/level_3/fss_read/c/payload/fss_read.h
+++ b/level_3/fss_read/c/payload/fss_read.h
@@ -126,7 +126,6 @@ extern "C" {
  *
  *   This alters main.setting.state.status:
  *     F_none on success.
- *     F_interrupt on (exit) signal received.
  */
 #ifndef _di_fss_read_payload_process_set_
   extern void fss_read_payload_process_set(void * const main);