Feature: improve see-also doc section

* Use unordered lists instead of space-separated lists
zeromq · Nov 3, 2023 · 245617d · 245617d
1 parent 267e856
commit 245617d
Show file tree

Hide file tree

Showing 71 changed files with 341 additions and 341 deletions.
diff --git a/doc/zmq.adoc b/doc/zmq.adoc
@@ -107,7 +107,7 @@ Sockets
 ~~~~~~~
 0MQ sockets present an abstraction of an asynchronous _message queue_, with the
 exact queueing semantics depending on the socket type in use. See
-xref:zmq_socket.adoc[zmq_socket] for the socket types provided.
+* xref:zmq_socket.adoc[zmq_socket] for the socket types provided.
 
 The following functions are provided to work with sockets:
 
@@ -139,7 +139,7 @@ Monitoring socket events::
 0MQ provides a mechanism for applications to multiplex input/output events over
 a set containing both 0MQ sockets and standard sockets. This mechanism mirrors
 the standard _poll()_ system call, and is described in detail in
-xref:zmq_poll.adoc[zmq_poll] This API is deprecated, however.
+* xref:zmq_poll.adoc[zmq_poll] This API is deprecated, however.
 
 There is a new DRAFT API with multiple zmq_poller_* function, which is described
 in xref:zmq_poller.adoc[zmq_poller]

diff --git a/doc/zmq_atomic_counter_dec.adoc b/doc/zmq_atomic_counter_dec.adoc
@@ -42,11 +42,11 @@ return 0;
 
 
 == SEE ALSO
-xref:zmq_atomic_counter_new.adoc[zmq_atomic_counter_new]
-xref:zmq_atomic_counter_set.adoc[zmq_atomic_counter_set]
-xref:zmq_atomic_counter_inc.adoc[zmq_atomic_counter_inc]
-xref:zmq_atomic_counter_value.adoc[zmq_atomic_counter_value]
-xref:zmq_atomic_counter_destroy.adoc[zmq_atomic_counter_destroy]
+* xref:zmq_atomic_counter_new.adoc[zmq_atomic_counter_new]
+* xref:zmq_atomic_counter_set.adoc[zmq_atomic_counter_set]
+* xref:zmq_atomic_counter_inc.adoc[zmq_atomic_counter_inc]
+* xref:zmq_atomic_counter_value.adoc[zmq_atomic_counter_value]
+* xref:zmq_atomic_counter_destroy.adoc[zmq_atomic_counter_destroy]
 
 
 == AUTHORS

diff --git a/doc/zmq_atomic_counter_destroy.adoc b/doc/zmq_atomic_counter_destroy.adoc
@@ -42,11 +42,11 @@ return 0;
 
 
 == SEE ALSO
-xref:zmq_atomic_counter_new.adoc[zmq_atomic_counter_new]
-xref:zmq_atomic_counter_set.adoc[zmq_atomic_counter_set]
-xref:zmq_atomic_counter_inc.adoc[zmq_atomic_counter_inc]
-xref:zmq_atomic_counter_dec.adoc[zmq_atomic_counter_dec]
-xref:zmq_atomic_counter_value.adoc[zmq_atomic_counter_value]
+* xref:zmq_atomic_counter_new.adoc[zmq_atomic_counter_new]
+* xref:zmq_atomic_counter_set.adoc[zmq_atomic_counter_set]
+* xref:zmq_atomic_counter_inc.adoc[zmq_atomic_counter_inc]
+* xref:zmq_atomic_counter_dec.adoc[zmq_atomic_counter_dec]
+* xref:zmq_atomic_counter_value.adoc[zmq_atomic_counter_value]
 
 
 == AUTHORS

diff --git a/doc/zmq_atomic_counter_inc.adoc b/doc/zmq_atomic_counter_inc.adoc
@@ -41,11 +41,11 @@ return 0;
 
 
 == SEE ALSO
-xref:zmq_atomic_counter_new.adoc[zmq_atomic_counter_new]
-xref:zmq_atomic_counter_set.adoc[zmq_atomic_counter_set]
-xref:zmq_atomic_counter_dec.adoc[zmq_atomic_counter_dec]
-xref:zmq_atomic_counter_value.adoc[zmq_atomic_counter_value]
-xref:zmq_atomic_counter_destroy.adoc[zmq_atomic_counter_destroy]
+* xref:zmq_atomic_counter_new.adoc[zmq_atomic_counter_new]
+* xref:zmq_atomic_counter_set.adoc[zmq_atomic_counter_set]
+* xref:zmq_atomic_counter_dec.adoc[zmq_atomic_counter_dec]
+* xref:zmq_atomic_counter_value.adoc[zmq_atomic_counter_value]
+* xref:zmq_atomic_counter_destroy.adoc[zmq_atomic_counter_destroy]
 
 
 == AUTHORS

diff --git a/doc/zmq_atomic_counter_new.adoc b/doc/zmq_atomic_counter_new.adoc
@@ -42,11 +42,11 @@ return 0;
 
 
 == SEE ALSO
-xref:zmq_atomic_counter_set.adoc[zmq_atomic_counter_set]
-xref:zmq_atomic_counter_inc.adoc[zmq_atomic_counter_inc]
-xref:zmq_atomic_counter_dec.adoc[zmq_atomic_counter_dec]
-xref:zmq_atomic_counter_value.adoc[zmq_atomic_counter_value]
-xref:zmq_atomic_counter_destroy.adoc[zmq_atomic_counter_destroy]
+* xref:zmq_atomic_counter_set.adoc[zmq_atomic_counter_set]
+* xref:zmq_atomic_counter_inc.adoc[zmq_atomic_counter_inc]
+* xref:zmq_atomic_counter_dec.adoc[zmq_atomic_counter_dec]
+* xref:zmq_atomic_counter_value.adoc[zmq_atomic_counter_value]
+* xref:zmq_atomic_counter_destroy.adoc[zmq_atomic_counter_destroy]
 
 
 == AUTHORS

diff --git a/doc/zmq_atomic_counter_set.adoc b/doc/zmq_atomic_counter_set.adoc
@@ -41,11 +41,11 @@ return 0;
 
 
 == SEE ALSO
-xref:zmq_atomic_counter_new.adoc[zmq_atomic_counter_new]
-xref:zmq_atomic_counter_inc.adoc[zmq_atomic_counter_inc]
-xref:zmq_atomic_counter_dec.adoc[zmq_atomic_counter_dec]
-xref:zmq_atomic_counter_value.adoc[zmq_atomic_counter_value]
-xref:zmq_atomic_counter_destroy.adoc[zmq_atomic_counter_destroy]
+* xref:zmq_atomic_counter_new.adoc[zmq_atomic_counter_new]
+* xref:zmq_atomic_counter_inc.adoc[zmq_atomic_counter_inc]
+* xref:zmq_atomic_counter_dec.adoc[zmq_atomic_counter_dec]
+* xref:zmq_atomic_counter_value.adoc[zmq_atomic_counter_value]
+* xref:zmq_atomic_counter_destroy.adoc[zmq_atomic_counter_destroy]
 
 
 == AUTHORS

diff --git a/doc/zmq_atomic_counter_value.adoc b/doc/zmq_atomic_counter_value.adoc
@@ -42,11 +42,11 @@ return 0;
 
 
 == SEE ALSO
-xref:zmq_atomic_counter_new.adoc[zmq_atomic_counter_new]
-xref:zmq_atomic_counter_set.adoc[zmq_atomic_counter_set]
-xref:zmq_atomic_counter_inc.adoc[zmq_atomic_counter_inc]
-xref:zmq_atomic_counter_dec.adoc[zmq_atomic_counter_dec]
-xref:zmq_atomic_counter_destroy.adoc[zmq_atomic_counter_destroy]
+* xref:zmq_atomic_counter_new.adoc[zmq_atomic_counter_new]
+* xref:zmq_atomic_counter_set.adoc[zmq_atomic_counter_set]
+* xref:zmq_atomic_counter_inc.adoc[zmq_atomic_counter_inc]
+* xref:zmq_atomic_counter_dec.adoc[zmq_atomic_counter_dec]
+* xref:zmq_atomic_counter_destroy.adoc[zmq_atomic_counter_destroy]
 
 
 == AUTHORS

diff --git a/doc/zmq_bind.adoc b/doc/zmq_bind.adoc
@@ -28,11 +28,11 @@ The 'endpoint' is a string consisting of a 'transport'`://` followed by an
 
 Every 0MQ socket type except 'ZMQ_PAIR' and 'ZMQ_CHANNEL' supports one-to-many and many-to-one
 semantics. The precise semantics depend on the socket type and are defined in
-xref:zmq_socket.adoc[zmq_socket]
+* xref:zmq_socket.adoc[zmq_socket]
 
 The 'ipc', 'tcp', 'vmci' and 'udp' transports accept wildcard addresses: see
-xref:zmq_ipc.adoc[zmq_ipc], xref:zmq_tcp.adoc[zmq_tcp], xref:zmq_vmci.adoc[zmq_vmci] and
-xref:zmq_udp.adoc[zmq_udp] for details.
+* xref:zmq_ipc.adoc[zmq_ipc], xref:zmq_tcp.adoc[zmq_tcp], xref:zmq_vmci.adoc[zmq_vmci] and
+* xref:zmq_udp.adoc[zmq_udp] for details.
 
 NOTE: the address syntax may be different for _zmq_bind()_ and _zmq_connect()_
 especially for the 'tcp', 'pgm' and 'epgm' transports.
@@ -86,9 +86,9 @@ assert (rc == 0);
 
 
 == SEE ALSO
-xref:zmq_connect.adoc[zmq_connect]
-xref:zmq_socket.adoc[zmq_socket]
-xref:zmq.adoc[zmq]
+* xref:zmq_connect.adoc[zmq_connect]
+* xref:zmq_socket.adoc[zmq_socket]
+* xref:zmq.adoc[zmq]
 
 
 == AUTHORS

diff --git a/doc/zmq_close.adoc b/doc/zmq_close.adoc
@@ -40,10 +40,10 @@ The provided 'socket' was NULL.
 
 
 == SEE ALSO
-xref:zmq_socket.adoc[zmq_socket]
-xref:zmq_ctx_term.adoc[zmq_ctx_term]
-xref:zmq_setsockopt.adoc[zmq_setsockopt]
-xref:zmq.adoc[zmq]
+* xref:zmq_socket.adoc[zmq_socket]
+* xref:zmq_ctx_term.adoc[zmq_ctx_term]
+* xref:zmq_setsockopt.adoc[zmq_setsockopt]
+* xref:zmq.adoc[zmq]
 
 
 == AUTHORS

diff --git a/doc/zmq_connect.adoc b/doc/zmq_connect.adoc
@@ -28,7 +28,7 @@ The 'endpoint' is a string consisting of a 'transport'`://` followed by an
 
 Every 0MQ socket type except 'ZMQ_PAIR' and 'ZMQ_CHANNEL' supports one-to-many and many-to-one
 semantics. The precise semantics depend on the socket type and are defined in
-xref:zmq_socket.adoc[zmq_socket]
+* xref:zmq_socket.adoc[zmq_socket]
 
 NOTE: for most transports and socket types the connection is not performed
 immediately but as needed by 0MQ. Thus a successful call to _zmq_connect()_
@@ -42,7 +42,7 @@ NOTE: following a _zmq_connect()_, for socket types except for ZMQ_ROUTER,
 the socket enters its normal 'ready' state. By contrast, following a
 _zmq_bind()_ alone, the socket enters a 'mute' state in which the socket
 blocks or drops messages according to the socket type, as defined in
-xref:zmq_socket.adoc[zmq_socket] A ZMQ_ROUTER socket enters its normal 'ready' state
+* xref:zmq_socket.adoc[zmq_socket] A ZMQ_ROUTER socket enters its normal 'ready' state
 for a specific peer only when handshaking is complete for that peer, which
 may take an arbitrary time.
 
@@ -90,9 +90,9 @@ assert (rc == 0);
 
 
 == SEE ALSO
-xref:zmq_bind.adoc[zmq_bind]
-xref:zmq_socket.adoc[zmq_socket]
-xref:zmq.adoc[zmq]
+* xref:zmq_bind.adoc[zmq_bind]
+* xref:zmq_socket.adoc[zmq_socket]
+* xref:zmq.adoc[zmq]
 
 
 == AUTHORS

diff --git a/doc/zmq_connect_peer.adoc b/doc/zmq_connect_peer.adoc
@@ -72,10 +72,10 @@ assert (rc == 0);
 
 
 == SEE ALSO
-xref:zmq_connect.adoc[zmq_connect]
-xref:zmq_bind.adoc[zmq_bind]
-xref:zmq_socket.adoc[zmq_socket]
-xref:zmq.adoc[zmq]
+* xref:zmq_connect.adoc[zmq_connect]
+* xref:zmq_bind.adoc[zmq_bind]
+* xref:zmq_socket.adoc[zmq_socket]
+* xref:zmq.adoc[zmq]
 
 
 == AUTHORS

diff --git a/doc/zmq_ctx_get.adoc b/doc/zmq_ctx_get.adoc
@@ -45,7 +45,7 @@ NOTE: in DRAFT state, not yet available in stable releases.
 ZMQ_SOCKET_LIMIT: Get largest configurable number of sockets
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 The 'ZMQ_SOCKET_LIMIT' argument returns the largest number of sockets that
-xref:zmq_ctx_set.adoc[zmq_ctx_set] will accept.
+* xref:zmq_ctx_set.adoc[zmq_ctx_set] will accept.
 
 
 ZMQ_IPV6: Set IPv6 option
@@ -107,8 +107,8 @@ zmq_ctx_set (ctx, ZMQ_BLOCKY, false);
 
 
 == SEE ALSO
-xref:zmq_ctx_set.adoc[zmq_ctx_set]
-xref:zmq.adoc[zmq]
+* xref:zmq_ctx_set.adoc[zmq_ctx_set]
+* xref:zmq.adoc[zmq]
 
 
 == AUTHORS

diff --git a/doc/zmq_ctx_get_ext.adoc b/doc/zmq_ctx_get_ext.adoc
@@ -66,8 +66,8 @@ assert (buffLen == prefixLen);
 
 
 == SEE ALSO
-xref:zmq_ctx_get.adoc[zmq_ctx_get]
-xref:zmq.adoc[zmq]
+* xref:zmq_ctx_get.adoc[zmq_ctx_get]
+* xref:zmq.adoc[zmq]
 
 
 == AUTHORS

diff --git a/doc/zmq_ctx_new.adoc b/doc/zmq_ctx_new.adoc
@@ -36,10 +36,10 @@ and it wasn't possible to create a new context.
 
 
 == SEE ALSO
-xref:zmq.adoc[zmq]
-xref:zmq_ctx_set.adoc[zmq_ctx_set]
-xref:zmq_ctx_get.adoc[zmq_ctx_get]
-xref:zmq_ctx_term.adoc[zmq_ctx_term]
+* xref:zmq.adoc[zmq]
+* xref:zmq_ctx_set.adoc[zmq_ctx_set]
+* xref:zmq_ctx_get.adoc[zmq_ctx_get]
+* xref:zmq_ctx_term.adoc[zmq_ctx_term]
 
 
 == AUTHORS

diff --git a/doc/zmq_ctx_set.adoc b/doc/zmq_ctx_set.adoc
@@ -130,7 +130,7 @@ The 'ZMQ_ZERO_COPY_RECV' argument specifies whether the message decoder should
 use a zero copy strategy when receiving messages. The zero copy strategy can
 lead to increased memory usage in some cases. This option allows you to use the
 older copying strategy. You can query the value of this option with
-xref:zmq_ctx_get.adoc[zmq_ctx_get] using the 'ZMQ_ZERO_COPY_RECV' option.
+* xref:zmq_ctx_get.adoc[zmq_ctx_get] using the 'ZMQ_ZERO_COPY_RECV' option.
 NOTE: in DRAFT state, not yet available in stable releases.
 
 [horizontal]
@@ -141,7 +141,7 @@ ZMQ_MAX_SOCKETS: Set maximum number of sockets
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 The 'ZMQ_MAX_SOCKETS' argument sets the maximum number of sockets allowed
 on the context. You can query the maximal allowed value with
-xref:zmq_ctx_get.adoc[zmq_ctx_get] using the 'ZMQ_SOCKET_LIMIT' option.
+* xref:zmq_ctx_get.adoc[zmq_ctx_get] using the 'ZMQ_SOCKET_LIMIT' option.
 
 [horizontal]
 Default value:: 1023
@@ -180,8 +180,8 @@ assert (max_sockets == 256);
 
 
 == SEE ALSO
-xref:zmq_ctx_get.adoc[zmq_ctx_get]
-xref:zmq.adoc[zmq]
+* xref:zmq_ctx_get.adoc[zmq_ctx_get]
+* xref:zmq.adoc[zmq]
 
 
 == AUTHORS

diff --git a/doc/zmq_ctx_set_ext.adoc b/doc/zmq_ctx_set_ext.adoc
@@ -70,8 +70,8 @@ assert (buffLen == prefixLen);
 
 
 == SEE ALSO
-xref:zmq_ctx_set.adoc[zmq_ctx_set]
-xref:zmq.adoc[zmq]
+* xref:zmq_ctx_set.adoc[zmq_ctx_set]
+* xref:zmq.adoc[zmq]
 
 
 == AUTHORS

diff --git a/doc/zmq_ctx_shutdown.adoc b/doc/zmq_ctx_shutdown.adoc
@@ -34,11 +34,11 @@ The provided 'context' was invalid.
 
 
 == SEE ALSO
-xref:zmq.adoc[zmq]
-xref:zmq_init.adoc[zmq_init]
-xref:zmq_ctx_term.adoc[zmq_ctx_term]
-xref:zmq_close.adoc[zmq_close]
-xref:zmq_setsockopt.adoc[zmq_setsockopt]
+* xref:zmq.adoc[zmq]
+* xref:zmq_init.adoc[zmq_init]
+* xref:zmq_ctx_term.adoc[zmq_ctx_term]
+* xref:zmq_close.adoc[zmq_close]
+* xref:zmq_setsockopt.adoc[zmq_setsockopt]
 
 
 == AUTHORS

diff --git a/doc/zmq_ctx_term.adoc b/doc/zmq_ctx_term.adoc
@@ -33,7 +33,7 @@ For further details regarding socket linger behaviour refer to the _ZMQ_LINGER_
 option in xref:zmq_setsockopt.adoc[zmq_setsockopt]
 
 This function replaces the deprecated functions xref:zmq_term.adoc[zmq_term] and
-xref:zmq_ctx_destroy.adoc[zmq_ctx_destroy]
+* xref:zmq_ctx_destroy.adoc[zmq_ctx_destroy]
 
 
 == RETURN VALUE
@@ -49,10 +49,10 @@ Termination was interrupted by a signal. It can be restarted if needed.
 
 
 == SEE ALSO
-xref:zmq.adoc[zmq]
-xref:zmq_init.adoc[zmq_init]
-xref:zmq_close.adoc[zmq_close]
-xref:zmq_setsockopt.adoc[zmq_setsockopt]
+* xref:zmq.adoc[zmq]
+* xref:zmq_init.adoc[zmq_init]
+* xref:zmq_close.adoc[zmq_close]
+* xref:zmq_setsockopt.adoc[zmq_setsockopt]
 
 
 == AUTHORS

diff --git a/doc/zmq_curve.adoc b/doc/zmq_curve.adoc
@@ -71,12 +71,12 @@ secret:
 ----
 
 == SEE ALSO
-xref:zmq_z85_encode.adoc[zmq_z85_encode]
-xref:zmq_z85_decode.adoc[zmq_z85_decode]
-xref:zmq_setsockopt.adoc[zmq_setsockopt]
-xref:zmq_null.adoc[zmq_null]
-xref:zmq_plain.adoc[zmq_plain]
-xref:zmq.adoc[zmq]
+* xref:zmq_z85_encode.adoc[zmq_z85_encode]
+* xref:zmq_z85_decode.adoc[zmq_z85_decode]
+* xref:zmq_setsockopt.adoc[zmq_setsockopt]
+* xref:zmq_null.adoc[zmq_null]
+* xref:zmq_plain.adoc[zmq_plain]
+* xref:zmq.adoc[zmq]
 
 
 == AUTHORS

diff --git a/doc/zmq_curve_keypair.adoc b/doc/zmq_curve_keypair.adoc
@@ -37,9 +37,9 @@ assert (rc == 0);
 
 
 == SEE ALSO
-xref:zmq_z85_encode.adoc[zmq_z85_encode]
-xref:zmq_z85_decode.adoc[zmq_z85_decode]
-xref:zmq_curve.adoc[zmq_curve]
+* xref:zmq_z85_encode.adoc[zmq_z85_encode]
+* xref:zmq_z85_decode.adoc[zmq_z85_decode]
+* xref:zmq_curve.adoc[zmq_curve]
 
 
 == AUTHORS

diff --git a/doc/zmq_curve_public.adoc b/doc/zmq_curve_public.adoc
@@ -42,10 +42,10 @@ assert (!strcmp (derived_public, public_key));
 
 
 == SEE ALSO
-xref:zmq_z85_encode.adoc[zmq_z85_encode]
-xref:zmq_z85_decode.adoc[zmq_z85_decode]
-xref:zmq_curve_keypair.adoc[zmq_curve_keypair]
-xref:zmq_curve.adoc[zmq_curve]
+* xref:zmq_z85_encode.adoc[zmq_z85_encode]
+* xref:zmq_z85_decode.adoc[zmq_z85_decode]
+* xref:zmq_curve_keypair.adoc[zmq_curve_keypair]
+* xref:zmq_curve.adoc[zmq_curve]
 
 
 == AUTHORS

diff --git a/doc/zmq_disconnect.adoc b/doc/zmq_disconnect.adoc
@@ -57,9 +57,9 @@ assert (rc == 0);
 ----
 
 == SEE ALSO
-xref:zmq_connect.adoc[zmq_connect]
-xref:zmq_socket.adoc[zmq_socket]
-xref:zmq.adoc[zmq]
+* xref:zmq_connect.adoc[zmq_connect]
+* xref:zmq_socket.adoc[zmq_socket]
+* xref:zmq.adoc[zmq]
 
 
 == AUTHORS