From e117175631c0a2810289c1c57a076de9c06a07c5 Mon Sep 17 00:00:00 2001
From: Garrett D'Amore <garrett@damore.org>
Date: Thu, 8 Nov 2018 20:53:22 -0800
Subject: Improved option docs slightly.

---
 docs/man/nng_ws.7.adoc | 42 ++++++++++++++++++------------------------
 1 file changed, 18 insertions(+), 24 deletions(-)

(limited to 'docs/man/nng_ws.7.adoc')

diff --git a/docs/man/nng_ws.7.adoc b/docs/man/nng_ws.7.adoc
index 9d4ef497..581da044 100644
--- a/docs/man/nng_ws.7.adoc
+++ b/docs/man/nng_ws.7.adoc
@@ -114,26 +114,24 @@ only available for `wss://` endpoints.
 
 ((`NNG_OPT_WS_REQUEST_HEADERS`))::
 
-This value is a string, consisting of multiple lines terminated
+(string) Concentation of multiple lines terminated
 by CRLF sequences, that can be used to add further headers to the
 HTTP request sent when connecting.
 This option can be set on dialers, and retrieved from pipes.
 
 ((`NNG_OPT_WS_RESPONSE_HEADERS`))::
 
-This value is a string, consisting of multiple lines terminated
+(string) Concatenation of multiple lines terminated
 by CRLF sequences, that can be used to add further headers to the
 HTTP response sent when connecting.
 This option can be set on listeners, and retrieved from pipes.
 
 ((`NNG_OPT_TLS_CONFIG`))::
 
-(opaque) This option is used on an endpoint to access the underlying TLS
+(`nng_tls_config *`) The underlying TLS
 configuration object for `wss://` endpoints.
-The value is of type `nng_tls_config *`.
 A hold is placed on the underlying
-configuration object before returning it (see
-`<<nng_tls_config_hold.3tls#,nng_tls_config_hold()>>`).
+configuration object before returning it.
 The caller should release the object with
 `<<nng_tls_config_free.3tls#,nng_tls_config_free()>>` when it no
 longer needs the TLS configuration.
@@ -141,16 +139,14 @@ longer needs the TLS configuration.
 TIP: Use this option when advanced TLS configuration is required.
 
 ((`NNG_OPT_TLS_CA_FILE`))::
-
-(string) This is a write-only option used to load certificates associated
-associated private key from a file.
+(string) Write-only option naming a file containing certificates to
+use for peer validation.
 See `<<nng_tls_config_ca_file.3tls#,nng_tls_config_ca_file()>>` for more
 information.
 
 ((`NNG_OPT_TLS_CERT_KEY_FILE`))::
-
-(string) This is a write-only option used to load the local certificate and
-associated private key from a file.
+(string) Write-only option naming a file containing the local certificate and
+associated private key.
 The private key used must be unencrypted.
 (Use the `NNG_OPT_TLS_CONFIG` option to access the underlying
 TLS configuration if more advanced configuration is needed.)
@@ -158,20 +154,18 @@ See `<<nng_tls_config_own_cert.3tls#,nng_tls_config_own_cert()>>` for more
 information.
 
 ((`NNG_OPT_TLS_AUTH_MODE`))::
-
-(`int`) This is a write-only option used to configure the authentication mode
-used.
-It can take an integer with value `NNG_TLS_AUTH_MODE_NONE`,
-`NNG_TLS_AUTH_MODE_REQUIRED`, or `NNG_TLS_AUTH_MODE_OPTIONAL`.
-See `<<nng_tls_config_auth_mode.3tls#,nng_tls_config_auth_mode()>>` for more
-details.
+(`int`) Write-only option used to configure the authentication mode used.
+Must be one of
+`NNG_TLS_AUTH_MODE_NONE`,
+`NNG_TLS_AUTH_MODE_REQUIRED`, or
+`NNG_TLS_AUTH_MODE_OPTIONAL`.
+See `<<nng_tls_config_auth_mode.3tls#,nng_tls_config_auth_mode()>>` for
+more details.
 
 `NNG_OPT_TLS_VERIFIED`::
-
-(bool) This is a read-only option that is `true` if the remote peer has been
-properly verified using TLS authentication, or `false` otherwise.
-This option may return incorrect
-results if peer authentication is disabled with `NNG_TLS_AUTH_MODE_NONE`.
+(`bool`) Whether the remote peer has been properly verified using TLS
+authentication.
+May return incorrect results if peer authentication is disabled.
 
 // We should also look at a hook mechanism for listeners. Probably this could
 // look like NNG_OPT_WS_LISTEN_HOOK_FUNC which would take a function pointer
-- 
cgit v1.2.3-70-g09d2

