diff options
| author | Garrett D'Amore <garrett@damore.org> | 2024-04-06 11:55:24 -0700 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2024-04-06 11:55:24 -0700 |
| commit | 008e579773ee7e8371ae739ef2392fa2e8a1ffd6 (patch) | |
| tree | 1f9e7b16c8118aab20485339290bceba7a84982a /docs | |
| parent | 1513230c59410538d15d57cac77b887cfcf632a0 (diff) | |
| download | nng-008e579773ee7e8371ae739ef2392fa2e8a1ffd6.tar.gz nng-008e579773ee7e8371ae739ef2392fa2e8a1ffd6.tar.bz2 nng-008e579773ee7e8371ae739ef2392fa2e8a1ffd6.zip | |
nng_version update.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/man/nng_version.3.adoc | 58 | ||||
| -rw-r--r-- | docs/ref/util/nng_version.adoc | 28 |
2 files changed, 28 insertions, 58 deletions
diff --git a/docs/man/nng_version.3.adoc b/docs/man/nng_version.3.adoc deleted file mode 100644 index 8859a46a..00000000 --- a/docs/man/nng_version.3.adoc +++ /dev/null @@ -1,58 +0,0 @@ -= nng_version(3) -// -// Copyright 2020 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_version - report library version - -== SYNOPSIS - -[source, c] ----- -#include <nng/nng.h> - -const char * nng_version(void); ----- - -== DESCRIPTION - -The `nng_version()` function returns a human readable ((version number)) -for _NNG_. - -Additionally, compile time version information is available -via some predefined macros: - -[horizontal] -((`NNG_MAJOR_VERSION`)):: Major version number. -((`NNG_MINOR_VERSION`)):: Minor version number. -((`NNG_PATCH_VERSION`)):: Patch version number. - -_NNG_ is developed and released using -http://www.semver.org[Semantic Versioning 2.0], and -the version numbers reported refer to both the API and the -library itself. -(The ((ABI)) -- ((application binary interface)) -- between the -library and the application is controlled in a similar, but different -manner depending upon the link options and how the library is built.) - -== RETURN VALUES - -Null-terminated string containing the library version number. - -== ERRORS - -None. - -== SEE ALSO - -[.text-left] -xref:libnng.3.adoc[libnng(3)], -xref:nng.7.adoc[nng(7)] diff --git a/docs/ref/util/nng_version.adoc b/docs/ref/util/nng_version.adoc new file mode 100644 index 00000000..7cefd42e --- /dev/null +++ b/docs/ref/util/nng_version.adoc @@ -0,0 +1,28 @@ +## nng_version + +Report library version. + +### Synopsis + +```c +#include <nng/nng.h> + +const char * nng_version(void); +``` + +### Description + +The `nng_version` function returns a human readable ((version number)) string for _NNG_.footnote:[This version string is meant for human consumption and should not be used progammatically.] + +Additionally, compile time version information is available via the following predefined macros: + +[horizontal] +((`NNG_MAJOR_VERSION`)):: Major version number. +((`NNG_MINOR_VERSION`)):: Minor version number. +((`NNG_PATCH_VERSION`)):: Patch version number. + +_NNG_ is developed and released using http://www.semver.org[Semantic Versioning 2.0], and the version numbers reported refer to both the API and the library itself.footnote:[The ((ABI)) -- ((application binary interface)) -- between the library and the application is controlled in a similar, but different manner depending upon the link options and how the library is built.] + +### Return Values + +Zero-terminated string containing the library version number. |