aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/man/libnng.3.adoc2
-rw-r--r--docs/man/nng_strerror.3.adoc48
-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
5 files changed, 36 insertions, 49 deletions
diff --git a/docs/man/libnng.3.adoc b/docs/man/libnng.3.adoc
index 14ba6d69..8fe595f0 100644
--- a/docs/man/libnng.3.adoc
+++ b/docs/man/libnng.3.adoc
@@ -34,7 +34,7 @@ The following common functions exist in _libnng_.
//|xref:nng_alloc.3.adoc[nng_alloc()]|allocate memory
//|xref:nng_free.3.adoc[nng_free()]|free memory
|xref:nng_strdup.3.adoc[nng_strdup()]|duplicate string
-|xref:nng_strerror.3.adoc[nng_strerror()]|return an error description
+//|xref:nng_strerror.3.adoc[nng_strerror()]|return an error description
|xref:nng_strfree.3.adoc[nng_strfree()]|free string
// |xref:nng_version.3.adoc[nng_version()]|report library version
|===
diff --git a/docs/man/nng_strerror.3.adoc b/docs/man/nng_strerror.3.adoc
deleted file mode 100644
index 145fd0bc..00000000
--- a/docs/man/nng_strerror.3.adoc
+++ /dev/null
@@ -1,48 +0,0 @@
-= nng_strerror(3)
-//
-// Copyright 2018 Staysail Systems, Inc. <info@staysail.tech>
-// Copyright 2018 Capitar IT Group BV <info@capitar.com>
-//
-// This document is supplied under the terms of the MIT License, a
-// copy of which should be located in the distribution where this
-// file was obtained (LICENSE.txt). A copy of the license may also be
-// found online at https://opensource.org/licenses/MIT.
-//
-
-== NAME
-
-nng_strerror - return an error description
-
-== SYNOPSIS
-
-[source, 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`.
-
-NOTE: 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.
-
-== SEE ALSO
-
-[.text-left]
-xref:libnng.3.adoc[libnng(3)],
-xref:nng.7.adoc[nng(7)]
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.