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_getopt.3.adoc | 33 +++++++++++++++++----------------
 1 file changed, 17 insertions(+), 16 deletions(-)

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

diff --git a/docs/man/nng_getopt.3.adoc b/docs/man/nng_getopt.3.adoc
index 5bb151c8..bd4d4c70 100644
--- a/docs/man/nng_getopt.3.adoc
+++ b/docs/man/nng_getopt.3.adoc
@@ -36,14 +36,17 @@ int nng_getopt_uint64(nng_socket s, const char *opt, uint64_t *u64p);
 
 == DESCRIPTION
 
+(((options, socket)))
 The `nng_getopt()` functions are used to retrieve option values for
-the socket _s_.
+the <<nng_socket.5#,socket>> _s_.
 The actual options that may be retrieved in this way vary.
 A number of them are documented in <<nng_options.5#,nng_options(5)>>.
 
 Additionally transport-specific options and protocol-specific options are
 documented with the transports and protocols themselves.
 
+=== Forms
+
 In all of these forms, the option _opt_ is retrieved from the socket _s_.
 The forms vary based on the type of the option they take.
 
@@ -55,13 +58,12 @@ type is performed, so the caller must take care to use the *correct* typed form.
 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.
 
-
-`nng_getopt()`::
-This function is untyped can be used to retrieve the value of any option.
+==== `nng_getopt()`
+This function is untyped and can be used to retrieve the value of any option.
 The caller must store a pointer to a buffer to receive the value in _val_,
 and the size of the buffer shall be stored at the location referenced by
 _valszp_.
-+
+
 When the function returns, the actual size of the data copied (or that
 would have been copied if sufficient space were present) is stored at
 the location referened by _valszp_.
@@ -69,38 +71,36 @@ If the caller's buffer is not large enough to hold the entire object,
 then the copy is truncated.
 Therefore the caller should check for truncation by verifyng that the
 returned size in _valszp_ does not exceed the original buffer size.
-+
+
 It is acceptable to pass `NULL` for _val_ if the value in _valszp_ is zero.
 This can be used to determine the size of the buffer needed to receive
 the object.
 
-`nng_getopt_bool()`::
-
+==== `nng_getopt_bool()`
 This function is for options which take a boolean (`bool`).
 The value will be stored at _ivalp_.
 
-`nng_getopt_int()`::
-
+==== `nng_getopt_int()`
 This function is for options which take an integer (`int`).
 The value will be stored at _ivalp_.
 
-`nng_getopt_ms()`::
-This function is used to retrieve time durations
+==== `nng_getopt_ms()`
+This function is used to retrieve time <<nng_duration.5#,durations>>
 (such as timeouts), stored in _durp_ as a number of milliseconds.
 (The special value ((`NNG_DUR_INFINITE`)) means an infinite amount of time, and
 the special value ((`NNG_DUR_DEFAULT`)) means a context-specific default.)
 
-`nng_getopt_ptr()`::
+==== `nng_getopt_ptr()`
 This function is used to retrieve a pointer, _ptr_, to structured data.
 The data referenced by _ptr_ is generally managed using other functions.
 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_getopt_size()`::
+==== `nng_getopt_size()`
 This function is used to retrieve a size into the pointer _zp_,
 typically for buffer sizes, message maximum sizes, and similar options.
 
-`nng_getopt_uint64()`::
+==== `nng_getopt_uint64()`
 This function is used to retrieve a 64-bit unsigned value into the value
 referenced by _u64p_.
 This is typically used for options related to identifiers, network
@@ -108,7 +108,7 @@ 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
 
@@ -123,6 +123,7 @@ This function returns 0 on success, and non-zero otherwise.
 <<nng_pipe_getopt.3#,nng_pipe_getopt(3)>>,
 <<nng_setopt.3#,nng_setopt(3)>>,
 <<nng_strerror.3#,nng_strerror(3)>>,
+<<nng_duration.5#,nng_duration(5)>>,
 <<nng_options.5#,nng_options(5)>>,
 <<nng_socket.5#,nng_socket(5)>>,
 <<nng.7#,nng(7)>>
-- 
cgit v1.2.3-70-g09d2

