diff options
Diffstat (limited to 'docs/ref/api/util')
| -rw-r--r-- | docs/ref/api/util/index.md | 1 | ||||
| -rw-r--r-- | docs/ref/api/util/nng_version.md | 36 |
2 files changed, 37 insertions, 0 deletions
diff --git a/docs/ref/api/util/index.md b/docs/ref/api/util/index.md index e11692c6..0a96da44 100644 --- a/docs/ref/api/util/index.md +++ b/docs/ref/api/util/index.md @@ -9,3 +9,4 @@ of other uses. - [nng_id_map](nng_id_map.md) - [nng_msleep](nng_msleep.md) - [nng_random](nng_random.md) +- [nng_version](nng_version.md) diff --git a/docs/ref/api/util/nng_version.md b/docs/ref/api/util/nng_version.md new file mode 100644 index 00000000..a84ed4cc --- /dev/null +++ b/docs/ref/api/util/nng_version.md @@ -0,0 +1,36 @@ +# nng_version + +## NAME + +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 {{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. |