diff options
| author | Garrett D'Amore <garrett@damore.org> | 2018-03-17 17:28:52 -0700 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2018-03-17 17:28:52 -0700 |
| commit | d759d4726ba8ac0fe8f8711a4015de717eb8a4a2 (patch) | |
| tree | 5580817646c60a992867c14b44409854721e35da | |
| parent | 2e6f76636e2adbc5e2bc4659a0639d83eb3f2d59 (diff) | |
| download | nng-d759d4726ba8ac0fe8f8711a4015de717eb8a4a2.tar.gz nng-d759d4726ba8ac0fe8f8711a4015de717eb8a4a2.tar.bz2 nng-d759d4726ba8ac0fe8f8711a4015de717eb8a4a2.zip | |
fixes #294 rename nng_zerotier_xxx to nng_zt_xxx
| -rw-r--r-- | docs/man/libnng.3.adoc | 2 | ||||
| -rw-r--r-- | docs/man/nng_zerotier.7.adoc | 4 | ||||
| -rw-r--r-- | docs/man/nng_zt_register.3.adoc (renamed from docs/man/nng_zerotier_register.3.adoc) | 8 |
3 files changed, 8 insertions, 6 deletions
diff --git a/docs/man/libnng.3.adoc b/docs/man/libnng.3.adoc index ba68b17c..66b00698 100644 --- a/docs/man/libnng.3.adoc +++ b/docs/man/libnng.3.adoc @@ -190,7 +190,7 @@ The following functions are used to register a transport for use. | <<nng_tls_register.3#,nng_tls_register()>>|register TLS transport | <<nng_ws_register.3#,nng_ws_register()>>|register WebSocket transport | <<nng_wss_register.3#,nng_wss_register()>>|register WebSocket Secure transport -| <<nng_zerotier_register.3#,nng_zerotier_register()>>|register ZeroTier transport +| <<nng_zt_register.3#,nng_zt_register()>>|register ZeroTier transport |=== === URL Object diff --git a/docs/man/nng_zerotier.7.adoc b/docs/man/nng_zerotier.7.adoc index 04a68409..2e62edc9 100644 --- a/docs/man/nng_zerotier.7.adoc +++ b/docs/man/nng_zerotier.7.adoc @@ -58,7 +58,9 @@ concepts and administration. === Registration Depending upon how the library was built, it may be necessary to -register the transport by calling `nng_zt_register()`. This function +register the transport by calling +<<nng_zt_register.3#,`nng_zt_register()`>>. +This function returns zero on success, or an nng error value if the transport cannot be initialized for any reason. diff --git a/docs/man/nng_zerotier_register.3.adoc b/docs/man/nng_zt_register.3.adoc index 4998fe32..181429a6 100644 --- a/docs/man/nng_zerotier_register.3.adoc +++ b/docs/man/nng_zt_register.3.adoc @@ -1,4 +1,4 @@ -= nng_zerotier_register(3) += nng_zt_register(3) // // Copyright 2018 Staysail Systems, Inc. <info@staysail.tech> // Copyright 2018 Capitar IT Group BV <info@capitar.com> @@ -11,7 +11,7 @@ == NAME -nng_zerotier_register - register ZeroTier transport +nng_zt_register - register ZeroTier transport == SYNOPSIS @@ -19,12 +19,12 @@ nng_zerotier_register - register ZeroTier transport ---- #include <nng/transport/zerotier/zerotier.h> -int nng_zerotier_register(void); +int nng_zt_register(void); ---- == DESCRIPTION -The `nng_zerotier_register()` function registers the +The `nng_zt_register()` function registers the ((_zt_ transport))(((transport, _zt_))) for use. == RETURN VALUES |