aboutsummaryrefslogtreecommitdiff
path: root/docs/man/nng_socket.5.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2018-05-01 17:11:32 -0700
committerGarrett D'Amore <garrett@damore.org>2018-05-01 19:18:37 -0700
commit3d3fa690c4f81bf4ed0a2de42c3c8fbb9f4cca5c (patch)
treed670fc9ac327e017c62a72cbaeda4bcacda5f9dd /docs/man/nng_socket.5.adoc
parent1ef281a7fbd544c6d3384fd8a71d10dc4bb081e8 (diff)
downloadnng-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_socket.5.adoc')
-rw-r--r--docs/man/nng_socket.5.adoc10
1 files changed, 5 insertions, 5 deletions
diff --git a/docs/man/nng_socket.5.adoc b/docs/man/nng_socket.5.adoc
index 2d8d7256..35a6a3c6 100644
--- a/docs/man/nng_socket.5.adoc
+++ b/docs/man/nng_socket.5.adoc
@@ -27,9 +27,9 @@ typedef struct nng_socket_s nng_socket;
An `nng_socket`(((socket))) is a handle to an underlying "`socket`" object.
All communication between the application and remote Scalability Protocol
peers is done through sockets.
-A given socket can have multiple dialers (<<nng_dialer.5#,`nng_dialer`>>)
-and/or (<<nng_listener.5#,`nng_listener`>>), and multiple
-pipes (<<nng_pipe.5#,`nng_pipe`>>), and
+A given socket can have multiple dialers (`<<nng_dialer.5#,nng_dialer>>`)
+and/or listeners (`<<nng_listener.5#,nng_listener>>`), and multiple
+pipes (`<<nng_pipe.5#,nng_pipe>>`), and
may be connected to multiple transports at the same time.
However, a given socket will have exactly one "`protocol`" associated with it,
and is responsible for any state machines or other protocol-specific logic.
@@ -40,9 +40,9 @@ Passing structures this way ensures gives the compiler a chance to perform
accurate type checks in functions passing values of this type.
Each `nng_socket` is created by a protocol-specific constructor, such as
-<<nng_rep_open.3#,`nng_rep_open()`>>.
+`<<nng_rep_open.3#,nng_rep_open()>>`.
When the socket is no longer needed, it can be closed with
-<<nng_close.3#,`nng_close()`>>.
+`<<nng_close.3#,nng_close()>>`.
[[NNG_SOCKET_INITIALIZER]]
=== Initialization