misc

Signed-off-by: Mattias Andrée <m@maandree.se>

1 files changed, 43 insertions, 0 deletions

diff --git a/liblss16_encode_strerror.3 b/liblss16_encode_strerror.3
new file mode 100644
index 0000000..758c887
--- /dev/null
+++ b/liblss16_encode_strerror.3
@@ -0,0 +1,43 @@
+.TH LIBLSS16_ENCODE_STRERROR 3 LIBLSS16
+.SH NAME
+liblss16_encode_strerror \- Get error description for an LSS16 encoding error
+
+.SH SYNOPSIS
+.nf
+#include <liblss16.h>
+
+enum liblss16_encode_error { /* values omitted */ };
+
+const char *liblss16_encode_strerror(enum liblss16_encode_error \fIerror\fP);
+.fi
+.PP
+Link with
+.IR -llss16 .
+
+.SH DESCRIPTION
+The
+.BR liblss16_encode_strerror ()
+function returns a stirng the describes
+.IR error .
+.PP
+The function is used for encoding errors, which may be
+received from the
+.BR liblss16_encoder_init (3)
+function.
+
+.SH RETURN VALUE
+The
+.BR liblss16_encode_strerror ()
+function returns a statically allocated single-line
+of text (not LF-terminated) describing the error, in
+sentence case, single-sentence (not period-terminated).
+If the error code is not recognised, a generic text
+is returned.
+
+.SH ERRORS
+The
+.BR liblss16_encode_strerror ()
+function cannot fail.
+
+.SH SEE ALSO
+.BR liblss16 (7)