From 6f7501cdfcf1b891002f58100b220917e2c1dc9b Mon Sep 17 00:00:00 2001 From: Kevin Day Date: Tue, 18 Feb 2025 18:49:34 -0600 Subject: [PATCH] Update: IKI Read documentation comments should use main.call. The `main.callback` was recently replaced with `main.call`. These documentation comments were overlooked or otherwise missed. --- level_3/fss_read/c/main/common.h | 2 +- level_3/fss_read/c/main/fss_read.h | 2 +- level_3/fss_read/c/main/main.h | 2 +- level_3/fss_read/c/main/print/data.h | 16 ++++++++-------- level_3/fss_read/c/main/process.h | 16 ++++++++-------- level_3/fss_read/c/payload/print.h | 6 +++--- level_3/iki_read/c/main/process.h | 12 ++++++------ 7 files changed, 28 insertions(+), 28 deletions(-) diff --git a/level_3/fss_read/c/main/common.h b/level_3/fss_read/c/main/common.h index feed8bb..e462ead 100644 --- a/level_3/fss_read/c/main/common.h +++ b/level_3/fss_read/c/main/common.h @@ -47,7 +47,7 @@ extern "C" { * @param main * The main program data. * - * This calls main.callback.process_last_line() if not NULL. + * This calls main.call.process_last_line() if not NULL. * * This alters main.setting.range. * diff --git a/level_3/fss_read/c/main/fss_read.h b/level_3/fss_read/c/main/fss_read.h index 2819368..e03c6f9 100644 --- a/level_3/fss_read/c/main/fss_read.h +++ b/level_3/fss_read/c/main/fss_read.h @@ -126,7 +126,7 @@ extern "C" { * F_true on success when performing verification and verify passed. * F_false on success when performing verification and verify failed. * - * Errors (with error bit) from: main.callback.process(). + * Errors (with error bit) from: main.call.process(). */ #ifndef _di_fss_read_main_ extern void fss_read_main(fss_read_main_t * const main); diff --git a/level_3/fss_read/c/main/main.h b/level_3/fss_read/c/main/main.h index 04e6d53..54e07b6 100644 --- a/level_3/fss_read/c/main/main.h +++ b/level_3/fss_read/c/main/main.h @@ -61,7 +61,7 @@ extern int main(const int argc, const f_string_t *argv, const f_string_t *envp); * @param main * The main program and settings data. * - * This alters main.callback.process_help, main.callback.process, and main.callback.process_pipe. + * This alters main.call.process_help, main.call.process, and main.call.process_pipe. * * This alters main.setting.state.status: * F_okay on success. diff --git a/level_3/fss_read/c/main/print/data.h b/level_3/fss_read/c/main/print/data.h index b1c3439..e55ce5d 100644 --- a/level_3/fss_read/c/main/print/data.h +++ b/level_3/fss_read/c/main/print/data.h @@ -21,7 +21,7 @@ extern "C" { * * This locks, uses, and unlocks the file stream. * - * This processes multiple Content ranges and calls main.callback.print_content() for each individual Content range. + * This processes multiple Content ranges and calls main.call.print_content() for each individual Content range. * * @param print * The output structure to print to. @@ -44,10 +44,10 @@ extern "C" { * * F_output_not (with error bit) if a parameter is NULL. * - * @see main.callback.print_content() - * @see main.callback.print_object() - * @see main.callback.print_object_end() - * @see main.callback.print_set_end() + * @see main.call.print_content() + * @see main.call.print_object() + * @see main.call.print_object_end() + * @see main.call.print_set_end() */ #ifndef _di_fss_read_print_at_ extern f_status_t fss_read_print_at(fl_print_t * const print, const f_number_unsigned_t at, const f_number_unsigneds_t delimits_object, const f_number_unsigneds_t delimits_content); @@ -82,9 +82,9 @@ extern "C" { * * F_output_not (with error bit) if a parameter is NULL. * - * @see main.callback.print_content() - * @see main.callback.print_object_end() - * @see main.callback.print_set_end() + * @see main.call.print_content() + * @see main.call.print_object_end() + * @see main.call.print_set_end() */ #ifndef _di_fss_read_print_content_ extern f_status_t fss_read_print_content(fl_print_t * const print, const f_number_unsigned_t at, const f_range_t range, const uint8_t quote, const f_number_unsigneds_t delimits); diff --git a/level_3/fss_read/c/main/process.h b/level_3/fss_read/c/main/process.h index 072815e..c027a99 100644 --- a/level_3/fss_read/c/main/process.h +++ b/level_3/fss_read/c/main/process.h @@ -27,14 +27,14 @@ extern "C" { * This alters main.setting.state.status: * F_okay on success. * - * Errors (with error bit) from: main.callback.process_at(). - * Errors (with error bit) from: main.callback.process_at_line(). - * Errors (with error bit) from: main.callback.process_columns(). - * Errors (with error bit) from: main.callback.process_load(). - * Errors (with error bit) from: main.callback.process_name(). - * Errors (with error bit) from: main.callback.print_at(). - * Errors (with error bit) from: main.callback.process_read(). - * Errors (with error bit) from: main.callback.process_total(). + * Errors (with error bit) from: main.call.process_at(). + * Errors (with error bit) from: main.call.process_at_line(). + * Errors (with error bit) from: main.call.process_columns(). + * Errors (with error bit) from: main.call.process_load(). + * Errors (with error bit) from: main.call.process_name(). + * Errors (with error bit) from: main.call.print_at(). + * Errors (with error bit) from: main.call.process_read(). + * Errors (with error bit) from: main.call.process_total(). * * Errors (with error bit) from: fss_read_signal_check(). * diff --git a/level_3/fss_read/c/payload/print.h b/level_3/fss_read/c/payload/print.h index 6f107b3..86e2dc0 100644 --- a/level_3/fss_read/c/payload/print.h +++ b/level_3/fss_read/c/payload/print.h @@ -41,9 +41,9 @@ extern "C" { * * F_output_not (with error bit) if a parameter is NULL. * - * @see main.callback.print_content() - * @see main.callback.print_object_end() - * @see main.callback.print_set_end() + * @see main.call.print_content() + * @see main.call.print_object_end() + * @see main.call.print_set_end() */ #ifndef _di_fss_read_payload_print_content_ extern f_status_t fss_read_payload_print_content(fl_print_t * const print, const f_number_unsigned_t at, const f_range_t range, const uint8_t quote, const f_number_unsigneds_t delimits); diff --git a/level_3/iki_read/c/main/process.h b/level_3/iki_read/c/main/process.h index 5080dca..05bb961 100644 --- a/level_3/iki_read/c/main/process.h +++ b/level_3/iki_read/c/main/process.h @@ -33,13 +33,13 @@ extern "C" { * * F_interrupt (with error bit) on (exit) signal received. * - * Errors (with error bit) from: main.callback.process_buffer_ranges(). - * Errors (with error bit) from: main.callback.process_buffer_ranges_whole(). - * Errors (with error bit) from: main.callback.process_buffer_total(). + * Errors (with error bit) from: main.call.process_buffer_ranges(). + * Errors (with error bit) from: main.call.process_buffer_ranges_whole(). + * Errors (with error bit) from: main.call.process_buffer_total(). * - * @see main.callback.process_buffer_ranges() - * @see main.callback.process_buffer_ranges_whole() - * @see main.callback.process_buffer_total() + * @see main.call.process_buffer_ranges() + * @see main.call.process_buffer_ranges_whole() + * @see main.call.process_buffer_total() */ #ifndef _di_iki_read_process_buffer_ extern void iki_read_process_buffer(iki_read_main_t * const main); -- 1.8.3.1