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_aio_alloc.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_aio_alloc.3.adoc')
| -rw-r--r-- | docs/man/nng_aio_alloc.3.adoc | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/docs/man/nng_aio_alloc.3.adoc b/docs/man/nng_aio_alloc.3.adoc index 71521f47..9e92dd4a 100644 --- a/docs/man/nng_aio_alloc.3.adoc +++ b/docs/man/nng_aio_alloc.3.adoc @@ -34,22 +34,22 @@ NOTE: The callback _callb_ must not perform any blocking operations, and must complete it's execution quickly. If _callb_ does block, this can lead ultimately to an apparent "hang" or deadlock in the application. -Asynchronous I/O operations all take an <<nng_aio.5#,`nng_aio`>> +Asynchronous I/O operations all take an `<<nng_aio.5#,nng_aio>>` handle such as allocated by this function. Such operations are usually started by a function that returns immediately. The operation is then run asynchronously, and completes sometime later. When that operation is complete, the callback supplied here is called, and that callback is able to determine the result of the operation using -<<nng_aio_result.3#,`nng_aio_result()`>>, -<<nng_aio_count.3#,`nng_aio_count()`>>, -and <<nng_aio_get_output.3#,`nng_aio_get_output()`>>. +`<<nng_aio_result.3#,nng_aio_result()>>`, +`<<nng_aio_count.3#,nng_aio_count()>>`, +and `<<nng_aio_get_output.3#,nng_aio_get_output()>>`. It is possible to wait synchronously for an otherwise asynchronous operation -by using the function <<nng_aio_wait.3#,`nng_aio_wait()`>>. +by using the function `<<nng_aio_wait.3#,nng_aio_wait()>>`. In that case, it is permissible for _callb_ and _arg_ to both be `NULL`. Note that if these are `NULL`, then it will not be possible to determine when the operation is complete except by calling the aforementioned -<<nng_aio_wait.3#,`nng_aio_wait()`>>. +`<<nng_aio_wait.3#,nng_aio_wait()>>`. == RETURN VALUES |