aboutsummaryrefslogtreecommitdiff
path: root/docs/ref
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2024-10-06 21:38:24 -0700
committerGarrett D'Amore <garrett@damore.org>2024-10-06 21:38:24 -0700
commit1ca231debcd1cf9f9f67ef1afda095e8c28d8975 (patch)
treed548e4ca6d6166c878b29647398533a2ce7e05ac /docs/ref
parent6e2f8f0d0f38ea70a9f79b0bae296f53dfab8a51 (diff)
downloadnng-1ca231debcd1cf9f9f67ef1afda095e8c28d8975.tar.gz
nng-1ca231debcd1cf9f9f67ef1afda095e8c28d8975.tar.bz2
nng-1ca231debcd1cf9f9f67ef1afda095e8c28d8975.zip
Convert nng_strerror to mdbook.
Diffstat (limited to 'docs/ref')
-rw-r--r--docs/ref/SUMMARY.md1
-rw-r--r--docs/ref/api/util/index.md1
-rw-r--r--docs/ref/api/util/nng_strerror.md33
3 files changed, 35 insertions, 0 deletions
diff --git a/docs/ref/SUMMARY.md b/docs/ref/SUMMARY.md
index 59010794..58e59695 100644
--- a/docs/ref/SUMMARY.md
+++ b/docs/ref/SUMMARY.md
@@ -13,6 +13,7 @@
- [nng_id_map](./api/util/nng_id_map.md)
- [nng_msleep](./api/util/nng_msleep.md)
- [nng_random](./api/util/nng_random.md)
+ - [nng_strerror](./api/util/nng_strerror.md)
- [nng_version](./api/util/nng_version.md)
- [Transports](./tran/index.md)
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.