From: Kevin Day <thekevinday@gmail.com>
Date: Sun, 8 Jan 2023 00:36:15 +0000 (-0600)
Subject: Update: Add more detailed documentation to fss_status_code and status_code.
X-Git-Tag: 0.6.3~29
X-Git-Url: https://git.kevux.org/?a=commitdiff_plain;h=015944dd7d402a90ae58818ce7d799e5d25aa483;p=fll

Update: Add more detailed documentation to fss_status_code and status_code.
---

diff --git a/level_3/fss_status_code/c/fss_status_code.c b/level_3/fss_status_code/c/fss_status_code.c
index a880d7a..75c8ba9 100644
--- a/level_3/fss_status_code/c/fss_status_code.c
+++ b/level_3/fss_status_code/c/fss_status_code.c
@@ -33,6 +33,22 @@ extern "C" {
 
     fll_program_print_help_usage(file, context, fss_status_code_program_name_s, fss_status_code_program_help_parameters_s);
 
+    fl_print_format("  The FLL programs use a %[16-bit unsigned integer%] to represent the return status of programs and functions.%r%r", file.stream, context.set.notable, context.set.notable, f_string_eol_s, f_string_eol_s);
+
+    fl_print_format("  Programs may print a generic error with one of these codes.%r", file.stream, f_string_eol_s);
+    fl_print_format("  This is a tool for converting to or converting from these codes.%r%r", file.stream, f_string_eol_s, f_string_eol_s);
+
+    fl_print_format("  The %[16-bit unsigned integer%] also has the first two high-order bits used to represent flags.%r", file.stream, context.set.notable, context.set.notable, f_string_eol_s);
+    fl_print_format("  These flags are the %[error%] bit and the %[warning%] bit.%r", file.stream, context.set.notable, context.set.notable, context.set.notable, context.set.notable, f_string_eol_s);
+    fl_print_format("  When neither of these flags are set, then the status is considered %[fine%].%r%r", file.stream, context.set.notable, context.set.notable, f_string_eol_s, f_string_eol_s);
+
+    fl_print_format("  This operates identical to the %[status_codes%] program except that this program handles additional codes regarding FSS.%r", file.stream, context.set.notable, context.set.notable, f_string_eol_s);
+    fl_print_format("  These special codes numericaly appear after the %[F_status_code_last%] code.%r", file.stream, context.set.notable, context.set.notable, f_string_eol_s);
+    fl_print_format("  These codes stop at the %[F_fss_status_code_last%] code.%r%r", file.stream, context.set.notable, context.set.notable, f_string_eol_s, f_string_eol_s);
+
+    fl_print_format("  Each code will be printed on its own line.%r", file.stream, f_string_eol_s);
+    fl_print_format("  Errors regarding each code may be printed on its own line.%r%r", file.stream, f_string_eol_s, f_string_eol_s);
+
     funlockfile(file.stream);
 
     return F_none;
diff --git a/level_3/status_code/c/status_code.c b/level_3/status_code/c/status_code.c
index 8c5ee20..4b3e05b 100644
--- a/level_3/status_code/c/status_code.c
+++ b/level_3/status_code/c/status_code.c
@@ -33,6 +33,20 @@ extern "C" {
 
     fll_program_print_help_usage(file, context, status_code_program_name_s, status_code_program_help_parameters_s);
 
+    fl_print_format("  The FLL programs use a %[16-bit unsigned integer%] to represent the return status of programs and functions.%r%r", file.stream, context.set.notable, context.set.notable, f_string_eol_s, f_string_eol_s);
+
+    fl_print_format("  Programs may print a generic error with one of these codes.%r", file.stream, f_string_eol_s);
+    fl_print_format("  This is a tool for converting to or converting from these codes.%r%r", file.stream, f_string_eol_s, f_string_eol_s);
+
+    fl_print_format("  The %[16-bit unsigned integer%] also has the first two high-order bits used to represent flags.%r", file.stream, context.set.notable, context.set.notable, f_string_eol_s);
+    fl_print_format("  These flags are the %[error%] bit and the %[warning%] bit.%r", file.stream, context.set.notable, context.set.notable, context.set.notable, context.set.notable, f_string_eol_s);
+    fl_print_format("  When neither of these flags are set, then the status is considered %[fine%].%r%r", file.stream, context.set.notable, context.set.notable, f_string_eol_s, f_string_eol_s);
+
+    fl_print_format("  These codes stop at the %[F_status_code_last%] code.%r%r", file.stream, context.set.notable, context.set.notable, f_string_eol_s, f_string_eol_s);
+
+    fl_print_format("  Each code will be printed on its own line.%r", file.stream, context.set.notable, context.set.notable, f_string_eol_s);
+    fl_print_format("  Errors regarding each code may be printed on its own line.%r%r", file.stream, f_string_eol_s, f_string_eol_s);
+
     funlockfile(file.stream);
 
     return F_none;