From e114123df2a05650f0f7e34044c1e8f829c50a44 Mon Sep 17 00:00:00 2001 From: Mattias Andrée Date: Mon, 3 Mar 2025 16:43:19 +0100 Subject: misc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Mattias Andrée --- liblss16_decode_strerror.3 | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 liblss16_decode_strerror.3 (limited to 'liblss16_decode_strerror.3') diff --git a/liblss16_decode_strerror.3 b/liblss16_decode_strerror.3 new file mode 100644 index 0000000..ee011ed --- /dev/null +++ b/liblss16_decode_strerror.3 @@ -0,0 +1,43 @@ +.TH LIBLSS16_DECODE_STRERROR 3 LIBLSS16 +.SH NAME +liblss16_decode_strerror \- Get error description for an LSS16 decoding error + +.SH SYNOPSIS +.nf +#include + +enum liblss16_decode_error { /* values omitted */ }; + +const char *liblss16_decode_strerror(enum liblss16_decode_error \fIerror\fP); +.fi +.PP +Link with +.IR -llss16 . + +.SH DESCRIPTION +The +.BR liblss16_decode_strerror () +function returns a stirng the describes +.IR error . +.PP +The function is used for decoding errors, which may be +received from the +.BR liblss16_decode_to_colour_index (3) +function. + +.SH RETURN VALUE +The +.BR liblss16_decode_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_decode_strerror () +function cannot fail. + +.SH SEE ALSO +.BR liblss16 (7) -- cgit v1.2.3-70-g09d2