diff options
| author | Garrett D'Amore <garrett@damore.org> | 2019-01-07 23:14:51 -0800 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2019-01-14 20:25:40 -0800 |
| commit | d0a26bbd1caf3de2132855d7936fed8ac1f1488c (patch) | |
| tree | 5133c92dbb88df393df670555613d2f4e1a9018a /docs/man/nng_tls_config_alloc.3tls.adoc | |
| parent | 099d89877aca6a7236254e39d9c9f5c46083cee7 (diff) | |
| download | nng-d0a26bbd1caf3de2132855d7936fed8ac1f1488c.tar.gz nng-d0a26bbd1caf3de2132855d7936fed8ac1f1488c.tar.bz2 nng-d0a26bbd1caf3de2132855d7936fed8ac1f1488c.zip | |
fixes #858 Document the TLS public API
This also includes a number of the documentation improvements.
The options document has been broken up into separate pages for
each of the transport specific options. We have made various
other minor improvements, fixes to markup, and cross-references.
Diffstat (limited to 'docs/man/nng_tls_config_alloc.3tls.adoc')
| -rw-r--r-- | docs/man/nng_tls_config_alloc.3tls.adoc | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/docs/man/nng_tls_config_alloc.3tls.adoc b/docs/man/nng_tls_config_alloc.3tls.adoc index edbf1c1e..9b218d9d 100644 --- a/docs/man/nng_tls_config_alloc.3tls.adoc +++ b/docs/man/nng_tls_config_alloc.3tls.adoc @@ -1,6 +1,6 @@ = nng_tls_config_alloc(3tls) // -// Copyright 2018 Staysail Systems, Inc. <info@staysail.tech> +// Copyright 2019 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 @@ -50,9 +50,9 @@ that object is not inadvertently freed while in use. A configuration object created with `nng_tls_config_alloc()` starts with a reference count of one. The reference count may be incremented using -`<<nng_tls_config_hold.3tls#,nng_tls_config_hold()>>` and may be +<<nng_tls_config_hold.3tls#,`nng_tls_config_hold()`>> and may be decremented with -`<<nng_tls_config_free.3tls#,nng_tls_config_free()>>`. +<<nng_tls_config_free.3tls#,`nng_tls_config_free()`>>. Also note that a TLS configuration object becomes "`read-only`" after it is first used with a service. @@ -80,4 +80,5 @@ This function returns 0 on success, and non-zero otherwise. <<nng_tls_config_free.3tls#,nng_tls_config_free(3tls)>>, <<nng_tls_config_hold.3tls#,nng_tls_config_hold(3tls)>>, <<nng_tls_config_server_name.3tls#,nng_tls_config_server_name(3tls)>>, +<<nng_tls_config.5#,nng_tls_config(5)>>, <<nng.7#,nng(7)>> |