diff options
| author | Ben Noordhuis <info@bnoordhuis.nl> | 2017-07-24 10:58:25 +0200 |
|---|---|---|
| committer | Ben Noordhuis <info@bnoordhuis.nl> | 2017-07-27 17:54:45 +0200 |
| commit | 19e51ae51fc8844b0eb47fb81ea67a562128713c (patch) | |
| tree | 181d20c1aea281a6e8070df4817a6c4471992b6d /docs/src | |
| parent | cbcf13af6ac6973ffdce798936bc0e2e46d4d58e (diff) | |
| download | libuv-19e51ae51fc8844b0eb47fb81ea67a562128713c.tar.gz libuv-19e51ae51fc8844b0eb47fb81ea67a562128713c.zip | |
doc: document uv_async_(init|send) return values
Fixes: https://github.com/libuv/libuv/issues/576
PR-URL: https://github.com/libuv/libuv/pull/1435
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Saúl Ibarra Corretgé <saghul@gmail.com>
Diffstat (limited to 'docs/src')
| -rw-r--r-- | docs/src/async.rst | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/docs/src/async.rst b/docs/src/async.rst index 5c400458..02e6a58e 100644 --- a/docs/src/async.rst +++ b/docs/src/async.rst @@ -35,12 +35,16 @@ API Initialize the handle. A NULL callback is allowed. + :returns: 0 on success, or an error code < 0 on failure. + .. note:: Unlike other handle initialization functions, it immediately starts the handle. .. c:function:: int uv_async_send(uv_async_t* async) - Wakeup the event loop and call the async handle's callback. + Wake up the event loop and call the async handle's callback. + + :returns: 0 on success, or an error code < 0 on failure. .. note:: It's safe to call this function from any thread. The callback will be called on the |