From 1ca231debcd1cf9f9f67ef1afda095e8c28d8975 Mon Sep 17 00:00:00 2001
From: Garrett D'Amore <garrett@damore.org>
Date: Sun, 6 Oct 2024 21:38:24 -0700
Subject: Convert nng_strerror to mdbook.

---
 docs/ref/api/util/index.md        |  1 +
 docs/ref/api/util/nng_strerror.md | 33 +++++++++++++++++++++++++++++++++
 2 files changed, 34 insertions(+)
 create mode 100644 docs/ref/api/util/nng_strerror.md

(limited to 'docs/ref/api')

diff --git a/docs/ref/api/util/index.md b/docs/ref/api/util/index.md
index 24c88d9c..eeb13906 100644
--- a/docs/ref/api/util/index.md
+++ b/docs/ref/api/util/index.md
@@ -10,4 +10,5 @@ of other uses.
 - [nng_id_map](nng_id_map.md)
 - [nng_msleep](nng_msleep.md)
 - [nng_random](nng_random.md)
+- [nng_strerror](nng_strerror.md)
 - [nng_version](nng_version.md)
diff --git a/docs/ref/api/util/nng_strerror.md b/docs/ref/api/util/nng_strerror.md
new file mode 100644
index 00000000..82d2f840
--- /dev/null
+++ b/docs/ref/api/util/nng_strerror.md
@@ -0,0 +1,33 @@
+# nng_strerror
+
+## NAME
+
+nng_strerror --- return an error description
+
+## SYNOPSIS
+
+```c
+#include <nng/nng.h>
+
+const char *nng_strerror(int err);
+```
+
+## DESCRIPTION
+
+The `nng_strerror` returns the human-readable description of the
+given error in `err`.
+
+The returned error message is provided in US English, but in the
+future locale-specific strings may be presented instead.
+
+> [!NOTE]
+> The specific strings associated with specific error messages are
+> subject to change.
+> Therefore applications must not depend on the message,
+> but may use them verbatim when supplying information to end-users, such
+> as in diagnostic messages or log entries.
+
+## RETURN VALUES
+
+This function returns the human-readable error message, terminated
+by a `NUL` byte.
-- 
cgit v1.2.3-70-g09d2