diff options
Diffstat (limited to 'docs/man')
| -rw-r--r-- | docs/man/libnng.3.adoc | 2 | ||||
| -rw-r--r-- | docs/man/nng_strerror.3.adoc | 48 |
2 files changed, 1 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)] |