From 5dc7e9d721b6a37fc5af0250326dddc08161c41d Mon Sep 17 00:00:00 2001 From: Kevin Day Date: Sun, 18 Jun 2023 22:32:10 -0500 Subject: [PATCH] Cleanup: Documentation comments in fss_read. The F_interrupt comments are now more correct. --- level_3/fss_read/c/main/fss_read.h | 3 ++- level_3/fss_read/c/main/main.h | 3 ++- level_3/fss_read/c/payload/fss_read.h | 1 - 3 files changed, 4 insertions(+), 3 deletions(-) diff --git a/level_3/fss_read/c/main/fss_read.h b/level_3/fss_read/c/main/fss_read.h index 2dd5064..888edd3 100644 --- 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 a5fdf2b..f913001 100644 --- 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 5d8dc41..3df87a6 100644 --- 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); -- 1.8.3.1