diff options
| author | Garrett D'Amore <garrett@damore.org> | 2018-05-01 17:11:32 -0700 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2018-05-01 19:18:37 -0700 |
| commit | 3d3fa690c4f81bf4ed0a2de42c3c8fbb9f4cca5c (patch) | |
| tree | d670fc9ac327e017c62a72cbaeda4bcacda5f9dd /docs/man/nng_pipe_getopt.3.adoc | |
| parent | 1ef281a7fbd544c6d3384fd8a71d10dc4bb081e8 (diff) | |
| download | nng-3d3fa690c4f81bf4ed0a2de42c3c8fbb9f4cca5c.tar.gz nng-3d3fa690c4f81bf4ed0a2de42c3c8fbb9f4cca5c.tar.bz2 nng-3d3fa690c4f81bf4ed0a2de42c3c8fbb9f4cca5c.zip | |
Markup fixes, ensuring links are colored properly.
It turns out that when creating cross references, we need to
make any text styling (generally literal characters) outside of
the link, to avoid having the styling override the link color.
(We prefer to have links colored for ease of use.)
While here a few other markup, and actual content, errors were fixed.
Diffstat (limited to 'docs/man/nng_pipe_getopt.3.adoc')
| -rw-r--r-- | docs/man/nng_pipe_getopt.3.adoc | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/docs/man/nng_pipe_getopt.3.adoc b/docs/man/nng_pipe_getopt.3.adoc index 66216a73..64cad9a3 100644 --- a/docs/man/nng_pipe_getopt.3.adoc +++ b/docs/man/nng_pipe_getopt.3.adoc @@ -51,8 +51,8 @@ documented with the transports andp protocols themselves. NOTE: All "`options`" on a pipe are read-only values, and intended to facilitate understanding the identity of an associated peer. Modification of options must be done on the listener or dialer using either -<<nng_listener_setopt.3#,`nng_listener_setopt()`>> or -<<nng_dialer_getopt.3#,`nng_dialer_getopt()`>> +`<<nng_listener_setopt.3#,nng_listener_setopt()>>` or +`<<nng_dialer_getopt.3#,nng_dialer_setopt()>>`. Any option that is set on a dialer or listener will normally be retrievable from pipes created by that dialer or listener. @@ -98,7 +98,7 @@ The value will be stored at _ivalp_. For booleans the value will be eiher 0 ==== `nng_pipe_getopt_ms()` This function is used to retrieve time durations -(<<nng_duration.5#,`nng_duration`>>) in milliseconds, which are stored in +(`<<nng_duration.5#,nng_duration>>`) in milliseconds, which are stored in _durp_. ==== `nng_pipe_getopt_ptr()` @@ -114,15 +114,15 @@ typically for buffer sizes, message maximum sizes, and similar options. ==== `nng_pipe_getopt_sockaddr()` -This function is used to retrieve an <<nng_sockaddr.5#,`nng_sockaddr`>> +This function is used to retrieve an `<<nng_sockaddr.5#,nng_sockaddr>>` into _sap_. ==== `nng_pipe_getopt_string()` This function is used to retrieve a string into _strp_. -This string is created from the source using <<nng_strdup.3#,`nng_strdup()`>> +This string is created from the source using `<<nng_strdup.3#,nng_strdup()>>` and consequently must be freed by the caller using -<<nng_strfree.3#,`nng_strfree()`>> when it is no longer needed. +`<<nng_strfree.3#,nng_strfree()>>` when it is no longer needed. ==== `nng_pipe_getopt_uint64()` |