From 848dbfced3491a01ff69fff9770a6c1dcd5cb112 Mon Sep 17 00:00:00 2001
From: Garrett D'Amore <garrett@damore.org>
Date: Thu, 8 Nov 2018 20:05:54 -0800
Subject: Improved layout and wording of option accessor functions.

---
 docs/man/nng_dialer_setopt.3.adoc | 25 +++++++++++++------------
 1 file changed, 13 insertions(+), 12 deletions(-)

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

diff --git a/docs/man/nng_dialer_setopt.3.adoc b/docs/man/nng_dialer_setopt.3.adoc
index fd62d0ce..01fcb3d4 100644
--- a/docs/man/nng_dialer_setopt.3.adoc
+++ b/docs/man/nng_dialer_setopt.3.adoc
@@ -58,50 +58,51 @@ In all of these forms, the option _opt_ is configured on the dialer _d_.
 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.
 
-TIP: Generally, it will be easier to use one of the typed forms instead.
-
-==== `nng_dialer_setopt()`
+`nng_dialer_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_dialer_setopt_bool()`
+TIP: It may be easier to use one of the typed forms of this function.
+
+`nng_dialer_setopt_bool()`::
 This function is for options which take a Boolean (`bool`).
 The _bval_ is passed to the option.
 
-==== `nng_dialer_setopt_int()`
+`nng_dialer_setopt_int()`::
 This function is for options which take an integer (`int`).
 The _ival_ is passed to the option.
 
-==== `nng_dialer_setopt_ms()`
+`nng_dialer_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_dialer_setopt_ptr()`
+`nng_dialer_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
 (`<<nng_tls_config_alloc.3tls#,nng_tls_config_alloc()>>`)
 can be passed this way.
-Note that this form is somewhat special in that the object is generally
+
+NOTE: This form is somewhat special in that the object is generally
 not copied, but instead the *pointer* to the object is copied.
 
-==== `nng_dialer_setopt_size()`
+`nng_dialer_setopt_size()`::
 This function is used to configure a size, _z_, typically for buffer sizes,
 message maximum sizes, and similar options.
 
-==== `nng_dialer_setopt_string()`
+`nng_dialer_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_dialer_setopt_uint64()`
+`nng_dialer_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.
+and such.
 
 == RETURN VALUES
 
-- 
cgit v1.2.3-70-g09d2

