]> Kevux Git Server - fll/commitdiff
Update: Manually add missing man pages.
authorKevin Day <kevin@kevux.org>
Sun, 2 Jul 2023 03:56:13 +0000 (22:56 -0500)
committerKevin Day <kevin@kevux.org>
Sun, 2 Jul 2023 03:59:49 +0000 (22:59 -0500)
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.

level_2/fll_fss_status_string/data/documentation/man/man3/fll_fss_status_string_from.3 [new file with mode: 0644]
level_2/fll_fss_status_string/data/documentation/man/man3/fll_fss_status_string_to.3 [new file with mode: 0644]

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 (file)
index 0000000..27492c5
--- /dev/null
@@ -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 <fll/level_2/fss_status_string.h>
+.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 (file)
index 0000000..f889060
--- /dev/null
@@ -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 <fll/level_2/fss_status_string.h>
+.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.