From f16dbb03d1616277fba7a61cf72cce1dfeb4dda1 Mon Sep 17 00:00:00 2001 From: Kevin Day Date: Sat, 1 Jul 2023 22:56:13 -0500 Subject: [PATCH] Update: Manually add missing man pages. I don't know why these were missed during the generation process. I copied another man page and modified it accordingly, attempting to keep to a similar structure. --- .../man/man3/fll_fss_status_string_from.3 | 44 ++++++++++++++++++++++ .../man/man3/fll_fss_status_string_to.3 | 36 ++++++++++++++++++ 2 files changed, 80 insertions(+) create mode 100644 level_2/fll_fss_status_string/data/documentation/man/man3/fll_fss_status_string_from.3 create mode 100644 level_2/fll_fss_status_string/data/documentation/man/man3/fll_fss_status_string_to.3 diff --git a/level_2/fll_fss_status_string/data/documentation/man/man3/fll_fss_status_string_from.3 b/level_2/fll_fss_status_string/data/documentation/man/man3/fll_fss_status_string_from.3 new file mode 100644 index 0000000..27492c5 --- /dev/null +++ b/level_2/fll_fss_status_string/data/documentation/man/man3/fll_fss_status_string_from.3 @@ -0,0 +1,44 @@ +.TH fll_fss_status_string_from "3" "July 2023" "FLL - Featureless Linux Library 0.6.6" "Library Functions" +.SH "NAME" +fll_fss_status_string_from - Convert FSS status codes from their string equivalents to a status code. +.SH SYNOPSIS +.nf +.B #include +.sp +\fBf_status_t fll_fss_status_string_from\fP( + \fBconst f_string_static_t \fP\fIname\fP + \fBf_status_t * const \fP\fIcode\fP +); +.fi +.SH DESCRIPTION +.PP +Convert FSS status codes from their string equivalents to a status code. +.PP +Error, warning, and signal flags will not be assigned to the code. +.PP +This process the string until either a match or NULL is reached. +.SH PARAMETERS +.TP +.B name +The status name to process. + +.TP +.B code +The status number a matched string represents. + +.SH RETURN VALUE +.PP +\fBF_none\fP on success. +.br +\fBF_data_not\fP if string is empty. +.br +\fBF_data\fP (with error bit) if not found. +.br +\fBF_parameter\fP (with error bit) if a parameter is invalid. +.br +Errors (with error bit) from: f_conversion_character_is_decimal(). +.SH AUTHOR +Written by Kevin Day. +.SH COPYRIGHT +.PP +Copyright \(co 2007-2023 Kevin Day, GNU LGPL Version 2.1 or later. diff --git a/level_2/fll_fss_status_string/data/documentation/man/man3/fll_fss_status_string_to.3 b/level_2/fll_fss_status_string/data/documentation/man/man3/fll_fss_status_string_to.3 new file mode 100644 index 0000000..f889060 --- /dev/null +++ b/level_2/fll_fss_status_string/data/documentation/man/man3/fll_fss_status_string_to.3 @@ -0,0 +1,36 @@ +.TH fll_fss_status_string_to "3" "July 2023" "FLL - Featureless Linux Library 0.6.6" "Library Functions" +.SH "NAME" +fll_fss_status_string_to - Convert code codes to their string equivalents. +.SH SYNOPSIS +.nf +.B #include +.sp +\fBf_status_t fll_fss_status_string_to\fP( + \fBconst f_status_t \fP\fIcode\fP + \fBf_string_static_t * const \fP\fIname\fP +); +.fi +.SH DESCRIPTION +.PP +Convert code codes to their string equivalents. +.SH PARAMETERS +.TP +.B code +The status number to process. + +.TP +.B name +The status name that represents the given code. + +.SH RETURN VALUE +.PP +\fBF_none\fP on success. +.br +\fBF_parameter\fP (with error bit) if a parameter is invalid. +.br +Errors (with error bit) from: f_status_string_to(). +.SH AUTHOR +Written by Kevin Day. +.SH COPYRIGHT +.PP +Copyright \(co 2007-2023 Kevin Day, GNU LGPL Version 2.1 or later. -- 1.8.3.1