diff options
| author | Ben Noordhuis <info@bnoordhuis.nl> | 2020-04-28 20:06:55 +0200 |
|---|---|---|
| committer | Ben Noordhuis <info@bnoordhuis.nl> | 2020-04-28 20:06:55 +0200 |
| commit | 25368e2db1debb5ffa99041ac543e6d8539e461e (patch) | |
| tree | ef4e06d426c3d530767b0eaf8c9959afe4079a6a /docs/src | |
| parent | be0e957f1802064cb7eca850f6a39900289b4da3 (diff) | |
| download | libuv-25368e2db1debb5ffa99041ac543e6d8539e461e.tar.gz libuv-25368e2db1debb5ffa99041ac543e6d8539e461e.zip | |
doc: check/idle/prepare functions always succeed
Make the documentation reflect that the init/start/stop functions
for check/idle/prepare handles always succeed.
PR-URL: https://github.com/libuv/libuv/pull/2803
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
Diffstat (limited to 'docs/src')
| -rw-r--r-- | docs/src/check.rst | 12 | ||||
| -rw-r--r-- | docs/src/idle.rst | 12 | ||||
| -rw-r--r-- | docs/src/prepare.rst | 12 |
3 files changed, 30 insertions, 6 deletions
diff --git a/docs/src/check.rst b/docs/src/check.rst index 36c93cf0..33aab551 100644 --- a/docs/src/check.rst +++ b/docs/src/check.rst @@ -33,14 +33,22 @@ API .. c:function:: int uv_check_init(uv_loop_t* loop, uv_check_t* check) - Initialize the handle. + Initialize the handle. This function always succeeds. + + :returns: 0 .. c:function:: int uv_check_start(uv_check_t* check, uv_check_cb cb) - Start the handle with the given callback. + Start the handle with the given callback. This function always succeeds, + except when `cb` is `NULL`. + + :returns: 0 on success, or `UV_EINVAL` when `cb == NULL`. .. c:function:: int uv_check_stop(uv_check_t* check) Stop the handle, the callback will no longer be called. + This function always succeeds. + + :returns: 0 .. seealso:: The :c:type:`uv_handle_t` API functions also apply. diff --git a/docs/src/idle.rst b/docs/src/idle.rst index 1f51c4a1..b7a0507b 100644 --- a/docs/src/idle.rst +++ b/docs/src/idle.rst @@ -41,14 +41,22 @@ API .. c:function:: int uv_idle_init(uv_loop_t* loop, uv_idle_t* idle) - Initialize the handle. + Initialize the handle. This function always succeeds. + + :returns: 0 .. c:function:: int uv_idle_start(uv_idle_t* idle, uv_idle_cb cb) - Start the handle with the given callback. + Start the handle with the given callback. This function always succeeds, + except when `cb` is `NULL`. + + :returns: 0 on success, or `UV_EINVAL` when `cb == NULL`. .. c:function:: int uv_idle_stop(uv_idle_t* idle) Stop the handle, the callback will no longer be called. + This function always succeeds. + + :returns: 0 .. seealso:: The :c:type:`uv_handle_t` API functions also apply. diff --git a/docs/src/prepare.rst b/docs/src/prepare.rst index aca58155..5e0d2476 100644 --- a/docs/src/prepare.rst +++ b/docs/src/prepare.rst @@ -33,14 +33,22 @@ API .. c:function:: int uv_prepare_init(uv_loop_t* loop, uv_prepare_t* prepare) - Initialize the handle. + Initialize the handle. This function always succeeds. + + :returns: 0 .. c:function:: int uv_prepare_start(uv_prepare_t* prepare, uv_prepare_cb cb) - Start the handle with the given callback. + Start the handle with the given callback. This function always succeeds, + except when `cb` is `NULL`. + + :returns: 0 on success, or `UV_EINVAL` when `cb == NULL`. .. c:function:: int uv_prepare_stop(uv_prepare_t* prepare) Stop the handle, the callback will no longer be called. + This function always succeeds. + + :returns: 0 .. seealso:: The :c:type:`uv_handle_t` API functions also apply. |