From b779b71b00c5f5f8cb9f0ee7d8feeadf9e2dca48 Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Sat, 30 Mar 2024 16:12:02 -0700 Subject: util funcs reorg --- docs/reference/src/util/nng_version.md | 38 ++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 docs/reference/src/util/nng_version.md (limited to 'docs/reference/src/util/nng_version.md') diff --git a/docs/reference/src/util/nng_version.md b/docs/reference/src/util/nng_version.md new file mode 100644 index 00000000..cd6666e3 --- /dev/null +++ b/docs/reference/src/util/nng_version.md @@ -0,0 +1,38 @@ +# nng_version + +## NAME + +nng_version --- report library version + +## SYNOPSIS + +```c +#include + +const char * nng_version(void); +``` + +## DESCRIPTION + +The `nng_version()` function returns a human readable {{i:version number}} +for _NNG_. + +Additionally, compile time version information is available +via some predefined macros: + +- {{i:`NNG_MAJOR_VERSION`}}: Major version number. +- {{i:`NNG_MINOR_VERSION`}}: Minor version number. +- {{i:`NNG_PATCH_VERSION`}}: Patch version number. + +_NNG_ is developed and released using +[Semantic Versioning 2.0](http://www.semver.org), and +the version numbers reported refer to both the API and the library itself. +(The {{i:ABI}} -- {{i: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 + +`NUL`-terminated string containing the library version number. + +{{#include ../refs.md}} -- cgit v1.2.3-70-g09d2