From 7b6e73f23104a50b898da1065cf9d3bf8b6a3bca Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Sat, 29 Jun 2019 17:26:04 -0700 Subject: more .adoc markup fixes. This is mostly mechanical-ish fixups to adjust markup style for cross references. A bit of care and feeding needed, so we haven't finished the list, but this gets a significant chunk of them. --- docs/man/nng_ctx_recv.3.adoc | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) (limited to 'docs/man/nng_ctx_recv.3.adoc') diff --git a/docs/man/nng_ctx_recv.3.adoc b/docs/man/nng_ctx_recv.3.adoc index 81e4de30..bb3d7cf6 100644 --- a/docs/man/nng_ctx_recv.3.adoc +++ b/docs/man/nng_ctx_recv.3.adoc @@ -24,14 +24,14 @@ void nng_ctx_recv(nng_ctx ctx, nng_aio *aio); == DESCRIPTION -The `nng_ctx_recv()` receives a <> using the -<> _s_ asynchronously. +The `nng_ctx_recv()` receives a xref:nng_msg.5.adoc[message] using the +xref:nng_ctx.5.adoc[context] _s_ asynchronously. When a message is successfully received by the context, it is stored in the _aio_ by an internal call equivalent to -`<>`, then the completion +xref:nng_aio_set_msg.3.adoc[`nng_aio_set_msg()`], then the completion callback on the _aio_ is executed. -In this case, `<>` will +In this case, xref:nng_aio_result.3.adoc[`nng_aio_result()`] will return zero. The callback function is responsible for retrieving the message and disposing of it appropriately. @@ -42,7 +42,7 @@ case can lead to memory leaks. If for some reason the asynchronous receive cannot be completed successfully (including by being canceled or timing out), then the callback will still be executed, -but `<>` will be non-zero. +but xref:nng_aio_result.3.adoc[`nng_aio_result()`] will be non-zero. NOTE: The semantics of what receiving a message means varies from protocol to protocol, so examination of the protocol documentation is encouraged. @@ -64,11 +64,11 @@ None. (The operation completes asynchronously.) == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<>, -<>, -<>, -<> +xref:nng_aio_get_msg.3.adoc[nng_aio_get_msg(3)], +xref:nng_aio_set_msg.3.adoc[nng_aio_set_msg(3)], +xref:nng_msg_alloc.3.adoc[nng_msg_alloc(3)], +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng_aio.5.adoc[nng_aio(5)], +xref:nng_ctx.5.adoc[nng_ctx(5)], +xref:nng_msg.5.adoc[nng_msg(5)], +xref:nng.7.adoc[nng(7)] -- cgit v1.2.3-70-g09d2