From 7e83c78ad2c98a7c32a1b9557deaa13723e75b02 Mon Sep 17 00:00:00 2001
From: Garrett D'Amore <garrett@damore.org>
Date: Mon, 1 Jan 2018 18:11:17 -0800
Subject: Add TLS configuration manipulation documentation.

While here, also fixup the markup on many of the pages, to
use commas in SEE ALSO, avoid adding the .adoc extension to
cross-references, and correct the link to the MIT license text.
---
 docs/nng_tls_config_alloc.adoc | 37 ++++++++++++++++++++-----------------
 1 file changed, 20 insertions(+), 17 deletions(-)

(limited to 'docs/nng_tls_config_alloc.adoc')

diff --git a/docs/nng_tls_config_alloc.adoc b/docs/nng_tls_config_alloc.adoc
index 4b41258f..21b4755f 100644
--- a/docs/nng_tls_config_alloc.adoc
+++ b/docs/nng_tls_config_alloc.adoc
@@ -6,7 +6,8 @@ nng_tls_config_alloc(3)
 :manvolnum: 3
 :icons: font
 :source-highlighter: pygments
-:copyright: Copyright 2017 Staysail Systems, Inc. <info@staysail.tech> \
+:copyright: Copyright 2018 Staysail Systems, Inc. <info@staysail.tech> \
+            Copyright 2018 Capitar IT Group BV <info@capitar.com> \
             This software 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 \
@@ -35,12 +36,13 @@ DESCRIPTION
 -----------
 
 The `nng_tls_config_alloc()` function creates a newly initialized
-TLS (Transport Layer Security, see
-https://tools.ietf.org/html/rfc5246[RFC 5246])
-configuration object.
+https://tools.ietf.org/html/rfc5246[Transport Layer Security])
+configuration object, and stores a pointer to it in the value pointed
+to by 'cfgp'.
 
 This object is initialized for use when acting as either a
-client (`NNG_TLS_MODE_CLIENT`) or as a server (`NNG_TLS_MODE_SERVER`).
+client (`NNG_TLS_MODE_CLIENT`) or as a server (`NNG_TLS_MODE_SERVER`),
+depending on the value of 'mode'.
 
 A TLS object can be further modified by functions that set the security
 keys used, peeer certificates, protocol policies, and so forth.
@@ -64,28 +66,29 @@ ERRORS
 ------
 
 `NNG_ENOMEM`:: Insufficient memory is available to allocate the object.
+`NNG_EINVAL`:: An invalid 'mode' was specified.
 
 
 SEE ALSO
 --------
 
-<<nng_setopt#,nng_setopt(3)>>
-<<nng_strerror#,nng_strerror(3)>>
-<<nng_tls_config_auth_mode#,nng_tls_config_auth_mode(3)>>
-<<nng_tls_config_ca_cert#,nng_tls_config_ca_cert(3)>>
-<<nng_tls_config_cert#,nng_tls_config_cert(3)>>
-<<nng_tls_config_crl#,nng_tls_config_crl(3)>>
-<<nng_tls_config_free#,nng_tls_config_free(3)>>
-<<nng_tls_config_key#,nng_tls_config_key(3)>>
-<<nng_tls_config_pass#,nng_tls_config_pass(3)>>
-<<nng_tls_config_server_name#,nng_tls_config_server_name(3)>>
+<<nng_strerror#,nng_strerror(3)>>,
+<<nng_tls_config_auth_mode#,nng_tls_config_auth_mode(3)>>,
+<<nng_tls_config_ca_cert#,nng_tls_config_ca_cert(3)>>,
+<<nng_tls_config_cert#,nng_tls_config_cert(3)>>,
+<<nng_tls_config_crl#,nng_tls_config_crl(3)>>,
+<<nng_tls_config_free#,nng_tls_config_free(3)>>,
+<<nng_tls_config_key#,nng_tls_config_key(3)>>,
+<<nng_tls_config_pass#,nng_tls_config_pass(3)>>,
+<<nng_tls_config_server_name#,nng_tls_config_server_name(3)>>,
 <<nng#,nng(7)>>
 
 
 COPYRIGHT
 ---------
 
-Copyright 2017 mailto:info@staysail.tech[Staysail Systems, Inc.]
+Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] +
+Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV]
 
 This document is supplied under the terms of the
-https://opensource.org/licenses/LICENSE.txt[MIT License].
+https://opensource.org/licenses/MIT[MIT License].
-- 
cgit v1.2.3-70-g09d2

