From: Kevin Day Date: Wed, 14 Dec 2022 05:29:20 +0000 (-0600) Subject: Cleanup: Fix problems with comments. X-Git-Url: https://git.kevux.org/?a=commitdiff_plain;h=fe0d78a9c5a20b798bf9cb0d851aced57275057d;p=fll Cleanup: Fix problems with comments. --- diff --git a/level_0/f_console/c/console/common.h b/level_0/f_console/c/console/common.h index 34c4616..02a01b2 100644 --- a/level_0/f_console/c/console/common.h +++ b/level_0/f_console/c/console/common.h @@ -391,7 +391,7 @@ extern "C" { * symbol_long: The NULL terminated multi-character string, such as 'help' in '--help'. * symbol_simple: The NULL terminated parameter that has no prefix, such as 'all' in 'make all'. * values_total: Designates that a parameter will have a given number of values arguments, such as 'blue' in '--color blue'. - * flag: A set of bits for providing. + * flag: A set of bits for providing states associated with the parameter. * result: A set of bits representing if and how the parameter is found (such as '-h' vs '--help'). * location: The last location in argv[] where this parameter is found. * location_sub: The last sub-location at location in argv (only used by short parameters, such as -h or +l). diff --git a/level_3/byte_dump/c/byte_dump.h b/level_3/byte_dump/c/byte_dump.h index b117547..6029420 100644 --- a/level_3/byte_dump/c/byte_dump.h +++ b/level_3/byte_dump/c/byte_dump.h @@ -104,7 +104,7 @@ extern "C" { * * This prints error messages as appropriate. * - * If either main or setting is NULL, then this immediately retuns without doing anything. + * If either main or setting is NULL, then this immediately returns without doing anything. * * @param arguments * The parameters passed to the process (often referred to as command line arguments). diff --git a/level_3/byte_dump/c/common.h b/level_3/byte_dump/c/common.h index 90dc0bb..da28d4a 100644 --- a/level_3/byte_dump/c/common.h +++ b/level_3/byte_dump/c/common.h @@ -354,10 +354,10 @@ extern "C" { #endif // _di_byte_dump_parameter_d_ /** - * Flags used to represent flags passed to the main function. + * Flags passed to the main function or program. * * byte_dump_main_flag_*_e: - * - none: No modes in use. + * - none: No flags set. * - file_from: Using a specified source file. * - file_to: Using a specified destination file. * - help: Print help. diff --git a/level_3/control/c/common.h b/level_3/control/c/common.h index 4620183..5378347 100644 --- a/level_3/control/c/common.h +++ b/level_3/control/c/common.h @@ -188,10 +188,10 @@ extern "C" { #endif // _di_control_payload_type_e_ /** - * Flags used to represent flags passed to the main function. + * Flags passed to the main function or program. * * control_main_flag_*_e: - * - none: No modes in use. + * - none: No flags set. * - file_from: Using a specified source file. * - file_to: Using a specified destination file. * - help: Print help. @@ -325,7 +325,7 @@ extern "C" { * * This prints error messages as appropriate. * - * If either main or setting is NULL, then this immediately retuns without doing anything. + * If either main or setting is NULL, then this immediately returns without doing anything. * * @param arguments * The parameters passed to the process (often referred to as command line arguments). diff --git a/level_3/controller/c/common.h b/level_3/controller/c/common.h index 26a9ad6..6631066 100644 --- a/level_3/controller/c/common.h +++ b/level_3/controller/c/common.h @@ -446,10 +446,10 @@ extern "C" { #endif // _di_controller_resource_limit_type_d_ /** - * Flags used to represent flags passed to the main function. + * Flags passed to the main function or program. * * controller_main_flag_*_e: - * - none: No modes in use. + * - none: No flags set. * - file_from: Using a specified source file. * - file_to: Using a specified destination file. * - help: Print help. @@ -718,7 +718,7 @@ extern "C" { * * This prints error messages as appropriate. * - * If either main or setting is NULL, then this immediately retuns without doing anything. + * If either main or setting is NULL, then this immediately returns without doing anything. * * @param arguments * The parameters passed to the process (often referred to as command line arguments). diff --git a/level_3/fake/c/common.h b/level_3/fake/c/common.h index bda8931..3d11962 100644 --- a/level_3/fake/c/common.h +++ b/level_3/fake/c/common.h @@ -503,10 +503,10 @@ extern "C" { #endif // _di_fake_parameter_d_ /** - * Flags used to represent flags passed to the main function. + * Flags passed to the main function or program. * * fake_main_flag_*_e: - * - none: No modes in use. + * - none: No flags set. * - file_from: Using a specified source file. * - file_to: Using a specified destination file. * - help: Print help. @@ -587,7 +587,7 @@ extern "C" { * * This prints error messages as appropriate. * - * If either main or setting is NULL, then this immediately retuns without doing anything. + * If either main or setting is NULL, then this immediately returns without doing anything. * * @param arguments * The parameters passed to the process (often referred to as command line arguments). diff --git a/level_3/firewall/c/common.h b/level_3/firewall/c/common.h index 2db3934..622bbdd 100644 --- a/level_3/firewall/c/common.h +++ b/level_3/firewall/c/common.h @@ -410,10 +410,10 @@ extern "C" { #endif // _di_firewall_parameter_d_ /** - * Flags used to represent flags passed to the main function. + * Flags passed to the main function or program. * * firewall_main_flag_*_e: - * - none: No modes in use. + * - none: No flags set. * - file_from: Using a specified source file. * - file_to: Using a specified destination file. * - help: Print help. @@ -491,7 +491,7 @@ extern "C" { * * This prints error messages as appropriate. * - * If either main or setting is NULL, then this immediately retuns without doing anything. + * If either main or setting is NULL, then this immediately returns without doing anything. * * @param arguments * The parameters passed to the process (often referred to as command line arguments). diff --git a/level_3/fss_basic_list_read/c/common.h b/level_3/fss_basic_list_read/c/common.h index d94e738..98bd551 100644 --- a/level_3/fss_basic_list_read/c/common.h +++ b/level_3/fss_basic_list_read/c/common.h @@ -306,10 +306,10 @@ extern "C" { #endif // _di_fss_basic_list_read_delimit_mode_e_ /** - * Flags used to represent flags passed to the main function. + * Flags passed to the main function or program. * * fss_basic_list_read_main_flag_*_e: - * - none: No modes in use. + * - none: No flags set. * - file_from: Using a specified source file. * - file_to: Using a specified destination file. * - help: Print help. @@ -387,7 +387,7 @@ extern "C" { * * This prints error messages as appropriate. * - * If either main or setting is NULL, then this immediately retuns without doing anything. + * If either main or setting is NULL, then this immediately returns without doing anything. * * @param arguments * The parameters passed to the process (often referred to as command line arguments). diff --git a/level_3/fss_basic_read/c/common.h b/level_3/fss_basic_read/c/common.h index 71e55bd..1a4bffb 100644 --- a/level_3/fss_basic_read/c/common.h +++ b/level_3/fss_basic_read/c/common.h @@ -304,10 +304,10 @@ extern "C" { #endif // _di_fss_basic_read_delimit_mode_e_ /** - * Flags used to represent flags passed to the main function. + * Flags passed to the main function or program. * * fss_basic_read_main_flag_*_e: - * - none: No modes in use. + * - none: No flags set. * - file_from: Using a specified source file. * - file_to: Using a specified destination file. * - help: Print help. @@ -385,7 +385,7 @@ extern "C" { * * This prints error messages as appropriate. * - * If either main or setting is NULL, then this immediately retuns without doing anything. + * If either main or setting is NULL, then this immediately returns without doing anything. * * @param arguments * The parameters passed to the process (often referred to as command line arguments). diff --git a/level_3/fss_embedded_list_read/c/common.h b/level_3/fss_embedded_list_read/c/common.h index a110112..89b8fd5 100644 --- a/level_3/fss_embedded_list_read/c/common.h +++ b/level_3/fss_embedded_list_read/c/common.h @@ -287,10 +287,10 @@ extern "C" { #endif // _di_fss_embedded_list_read_delimit_mode_e_ /** - * Flags used to represent flags passed to the main function. + * Flags passed to the main function or program. * * fss_embedded_list_read_main_flag_*_e: - * - none: No modes in use. + * - none: No flags set. * - file_from: Using a specified source file. * - file_to: Using a specified destination file. * - help: Print help. @@ -368,7 +368,7 @@ extern "C" { * * This prints error messages as appropriate. * - * If either main or setting is NULL, then this immediately retuns without doing anything. + * If either main or setting is NULL, then this immediately returns without doing anything. * * @param arguments * The parameters passed to the process (often referred to as command line arguments). diff --git a/level_3/fss_extended_list_read/c/common.h b/level_3/fss_extended_list_read/c/common.h index f4d6f27..9514768 100644 --- a/level_3/fss_extended_list_read/c/common.h +++ b/level_3/fss_extended_list_read/c/common.h @@ -304,10 +304,10 @@ extern "C" { #endif // _di_fss_extended_list_read_delimit_mode_e_ /** - * Flags used to represent flags passed to the main function. + * Flags passed to the main function or program. * * fss_extended_list_read_main_flag_*_e: - * - none: No modes in use. + * - none: No flags set. * - file_from: Using a specified source file. * - file_to: Using a specified destination file. * - help: Print help. @@ -402,7 +402,7 @@ extern "C" { * * This prints error messages as appropriate. * - * If either main or setting is NULL, then this immediately retuns without doing anything. + * If either main or setting is NULL, then this immediately returns without doing anything. * * @param arguments * The parameters passed to the process (often referred to as command line arguments). diff --git a/level_3/fss_extended_read/c/common.h b/level_3/fss_extended_read/c/common.h index a0b2489..d4bbb4f 100644 --- a/level_3/fss_extended_read/c/common.h +++ b/level_3/fss_extended_read/c/common.h @@ -303,10 +303,10 @@ extern "C" { #endif // _di_fss_extended_read_delimit_mode_e_ /** - * Flags used to represent flags passed to the main function. + * Flags passed to the main function or program. * * fss_extended_read_main_flag_*_e: - * - none: No modes in use. + * - none: No flags set. * - file_from: Using a specified source file. * - file_to: Using a specified destination file. * - help: Print help. @@ -384,7 +384,7 @@ extern "C" { * * This prints error messages as appropriate. * - * If either main or setting is NULL, then this immediately retuns without doing anything. + * If either main or setting is NULL, then this immediately returns without doing anything. * * @param arguments * The parameters passed to the process (often referred to as command line arguments). diff --git a/level_3/fss_identify/c/common.h b/level_3/fss_identify/c/common.h index fec33c7..c524174 100644 --- a/level_3/fss_identify/c/common.h +++ b/level_3/fss_identify/c/common.h @@ -153,10 +153,10 @@ extern "C" { #endif // _di_fss_identify_parameter_d_ /** - * Flags used to represent flags passed to the main function. + * Flags passed to the main function or program. * * fss_identify_main_flag_*_e: - * - none: No modes in use. + * - none: No flags set. * - file_from: Using a specified source file. * - file_to: Using a specified destination file. * - help: Print help. @@ -234,7 +234,7 @@ extern "C" { * * This prints error messages as appropriate. * - * If either main or setting is NULL, then this immediately retuns without doing anything. + * If either main or setting is NULL, then this immediately returns without doing anything. * * @param arguments * The parameters passed to the process (often referred to as command line arguments). diff --git a/level_3/fss_payload_read/c/common.h b/level_3/fss_payload_read/c/common.h index 6afc92b..84c8c75 100644 --- a/level_3/fss_payload_read/c/common.h +++ b/level_3/fss_payload_read/c/common.h @@ -298,10 +298,10 @@ extern "C" { #endif // _di_fss_payload_read_delimit_mode_e_ /** - * Flags used to represent flags passed to the main function. + * Flags passed to the main function or program. * * fss_payload_read_main_flag_*_e: - * - none: No modes in use. + * - none: No flags set. * - at: Selecting at a specific index. * - content: Print Contents. * - help: Print help. @@ -391,7 +391,7 @@ extern "C" { * * This prints error messages as appropriate. * - * If either main or setting is NULL, then this immediately retuns without doing anything. + * If either main or setting is NULL, then this immediately returns without doing anything. * * @param arguments * The parameters passed to the process (often referred to as command line arguments). diff --git a/level_3/fss_write/c/main/common.h b/level_3/fss_write/c/main/common.h index 05b585c..ba21e60 100644 --- a/level_3/fss_write/c/main/common.h +++ b/level_3/fss_write/c/main/common.h @@ -284,10 +284,10 @@ extern "C" { #endif // _di_fss_write_parameter_d_ /** - * Flags used to represent flags passed to the main function. + * Flags passed to the main function or program. * * fss_write_flag_*_e: - * - none: No modes in use. + * - none: No flags set. * - content: The Content being written is specified. * - content_end: The Content end characters are to be printed. * - content_multiple: Designate that multiple Content is allowed for an Object for this standard rather than a single Content per Object. @@ -353,9 +353,6 @@ extern "C" { * content: A pointer to a specific Content used during processing. * contents: A pointer to a specific set of Content used during processing. * - * program_name: The short name of the program. - * program_name_long: The human friendly name of the program. - * * process_content: Process a single Content. * process_help: Process help (generally printing help). * process_normal: Process normally (data from parameters and files). @@ -451,7 +448,7 @@ extern "C" { * * This prints error messages as appropriate. * - * If either main or setting is NULL, then this immediately retuns without doing anything. + * If either main or setting is NULL, then this immediately returns without doing anything. * * @param arguments * The parameters passed to the process (often referred to as command line arguments). diff --git a/level_3/fss_write/c/main/fss_write.c b/level_3/fss_write/c/main/fss_write.c index c4a0529..a07d92f 100644 --- a/level_3/fss_write/c/main/fss_write.c +++ b/level_3/fss_write/c/main/fss_write.c @@ -36,7 +36,7 @@ extern "C" { if (setting->flag & (fss_write_flag_object_e | fss_write_flag_content_e | fss_write_flag_object_open_e | fss_write_flag_content_next_e | fss_write_flag_content_end_e)) { if (setting->process_normal) { - setting->process_normal(main, setting); + setting->process_normal(main, (void *) setting); if (F_status_is_error(setting->status)) return; } } diff --git a/level_3/fss_write/c/main/main.h b/level_3/fss_write/c/main/main.h index a571262..0bfb66a 100644 --- a/level_3/fss_write/c/main/main.h +++ b/level_3/fss_write/c/main/main.h @@ -55,7 +55,7 @@ extern int main(const int argc, const f_string_t *argv, const f_string_t *envp); * * This prints error messages as appropriate. * - * If either main or setting is NULL, then this immediately retuns without doing anything. + * If either main or setting is NULL, then this immediately returns without doing anything. * * @param arguments * The parameters passed to the process (often referred to as command line arguments). diff --git a/level_3/fss_write/c/payload/fss_write.h b/level_3/fss_write/c/payload/fss_write.h index 7a87455..4b1fb68 100644 --- a/level_3/fss_write/c/payload/fss_write.h +++ b/level_3/fss_write/c/payload/fss_write.h @@ -118,7 +118,7 @@ extern "C" { * * This prints error messages as appropriate. * - * If either main or setting is NULL, then this immediately retuns without doing anything. + * If either main or setting is NULL, then this immediately returns without doing anything. * * @param arguments * The parameters passed to the process (often referred to as command line arguments). diff --git a/level_3/iki_read/c/main/common.h b/level_3/iki_read/c/main/common.h index 3221d7c..7282f21 100644 --- a/level_3/iki_read/c/main/common.h +++ b/level_3/iki_read/c/main/common.h @@ -243,10 +243,10 @@ extern "C" { #endif // _di_iki_read_substitution_t_ /** - * Flags used to represent flags passed to the main function. + * Flags passed to the main function or program. * * iki_read_main_flag_*_e: - * - none: No modes in use. + * - none: No flags set. * - at: Selecting at a specific index. * - content: Print Contents. * - help: Print help. @@ -382,7 +382,7 @@ extern "C" { * * This prints error messages as appropriate. * - * If either main or setting is NULL, then this immediately retuns without doing anything. + * If either main or setting is NULL, then this immediately returns without doing anything. * * @param arguments * The parameters passed to the process (often referred to as command line arguments). diff --git a/level_3/iki_write/c/main/common.h b/level_3/iki_write/c/main/common.h index 469c506..58003fa 100644 --- a/level_3/iki_write/c/main/common.h +++ b/level_3/iki_write/c/main/common.h @@ -172,10 +172,10 @@ extern "C" { #endif // _di_iki_write_parameter_d_ /** - * Flags used to represent flags passed to the main function. + * Flags passed to the main function or program. * * iki_write_main_flag_*_e: - * - none: No modes in use. + * - none: No flags set. * - content: The Content being written is specified. * - file_to: Using a specified destination file. * - help: Print help. @@ -273,7 +273,7 @@ extern "C" { * * This prints error messages as appropriate. * - * If either main or setting is NULL, then this immediately retuns without doing anything. + * If either main or setting is NULL, then this immediately returns without doing anything. * * @param arguments * The parameters passed to the process (often referred to as command line arguments). diff --git a/level_3/status_code/c/main/common.h b/level_3/status_code/c/main/common.h index ce0b119..265a034 100644 --- a/level_3/status_code/c/main/common.h +++ b/level_3/status_code/c/main/common.h @@ -184,12 +184,12 @@ extern "C" { #endif // _di_status_code_parameter_d_ /** - * Flags used to represent flags passed to the main function. + * Flags passed to the main function or program. * * When number mode is not specified, then mode is "string" mode (there is no flag for "string" mode). * * status_code_main_flag_*_e: - * - none: No modes in use. + * - none: No flags set. * - error: Check if status is "error". * - fine: Check if status is "fine". * - help: Print help. @@ -276,7 +276,7 @@ extern "C" { * * This prints error messages as appropriate. * - * If either main or setting is NULL, then this immediately retuns without doing anything. + * If either main or setting is NULL, then this immediately returns without doing anything. * * @param arguments * The parameters passed to the process (often referred to as command line arguments). diff --git a/level_3/utf8/c/main/common.h b/level_3/utf8/c/main/common.h index 722b1b1..756225b 100644 --- a/level_3/utf8/c/main/common.h +++ b/level_3/utf8/c/main/common.h @@ -309,7 +309,7 @@ extern "C" { * Modes used to designate how to the input and output are to be processed. * * utf8_mode_*_e: - * - none: No modes in use. + * - none: No flags set. * * utf8_mode_from_*_e: * - bytesequence: The input format is bytesequence. @@ -334,10 +334,10 @@ extern "C" { #endif // _di_utf8_modes_e_ /** - * Flags used to represent flags passed to the main function. + * Flags passed to the main function or program. * * utf8_main_flag_*_e: - * - none: No modes in use. + * - none: No flags set. * - file_from: Using a specified source file. * - file_to: Using a specified destination file. * - header: Enable printing of headers. @@ -455,7 +455,7 @@ extern "C" { * * This prints error messages as appropriate. * - * If either main or setting is NULL, then this immediately retuns without doing anything. + * If either main or setting is NULL, then this immediately returns without doing anything. * * @param arguments * The parameters passed to the process (often referred to as command line arguments).