From 8da1ec98c6d30b809ff09392ae2989a4de9ed71c Mon Sep 17 00:00:00 2001
From: Garrett D'Amore <garrett@damore.org>
Date: Sun, 18 Mar 2018 14:58:21 -0700
Subject: fixes #293 nng_listener_getopt doc needs updating

Actually I updated all the option related documents, and fixed minor
markup issues on several others.
---
 docs/man/nng_setopt.3.adoc | 20 +++++++++++---------
 1 file changed, 11 insertions(+), 9 deletions(-)

(limited to 'docs/man/nng_setopt.3.adoc')

diff --git a/docs/man/nng_setopt.3.adoc b/docs/man/nng_setopt.3.adoc
index 201181cc..915fb5de 100644
--- a/docs/man/nng_setopt.3.adoc
+++ b/docs/man/nng_setopt.3.adoc
@@ -47,6 +47,8 @@ A number of them are documented in <<nng_options.5#,nng_options(5)>>.
 Additionally some transport-specific and protocol-specific options are
 documented with the transports and protocols themselves.
 
+=== Forms
+
 The details of the type, size, and semantics of the option will depend
 on the actual option, and will be documented with the option itself.
 
@@ -56,25 +58,25 @@ of this function.
 NOTE: No validation that the option is actually of the associated
 type is performed, so the caller must take care to use the *correct* typed form.
 
-`nng_setopt()`::
+==== `nng_setopt()`
 This function is untyped, and can be used to configure any arbitrary data.
 The _val_ pointer addresses the data to copy, and _valsz_ is the
 size of the objected located at _val_.
 
-`nng_setopt_bool()`::
+==== `nng_setopt_bool()`
 This function is for options which take a boolean (`bool`).
 The _bval_ is passed to the option.
 
-`nng_setopt_int()`::
+==== `nng_setopt_int()`
 This function is for options which take an integer (`int`).
 The _ival_ is passed to the option.
 
-`nng_setopt_ms()`::
+==== `nng_setopt_ms()`
 This function is used to configure time durations (such as timeouts) using
 type <<nng_duration.5#,`nng_duration`>>.
 The duration _dur_ is an integer number of milliseconds.
 
-`nng_setopt_ptr()`::
+==== `nng_setopt_ptr()`
 This function is used to pass a pointer, _ptr_, to structured data.
 The data referenced by _ptr_ is generally managed by other functions.
 For example, TLS configuration objects created with
@@ -83,25 +85,25 @@ can be passed this way.
 Note that this form is somewhat special in that the object is generally
 not copied, but instead the *pointer* to the object is copied.
 
-`nng_setopt_size()`::
+==== `nng_setopt_size()`
 This function is used to configure a size, _z_, typically for buffer sizes,
 message maximum sizes, and similar options.
 
-`nng_setopt_string()`::
+==== `nng_setopt_string()`
 This function is used to pass configure a string, _str_.
 Strings passed this way must be legal UTF-8 or ASCII strings, terminated
 with a `NUL` (`\0`) byte.
 (Other constraints may apply as well, see the documentation for each option
 for details.)
 
-`nng_setopt_uint64()`::
+==== `nng_setopt_uint64()`
 This function is used to configure a 64-bit unsigned value, _u64_.
 This is typically used for options related to identifiers, network numbers,
 and similar.
 
 == RETURN VALUES
 
-This function returns 0 on success, and non-zero otherwise.
+These functions return 0 on success, and non-zero otherwise.
 
 == ERRORS
 
-- 
cgit v1.2.3-70-g09d2

