luo980/libuv
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: document uv_timer_start() on an active timer

Browse Source 
Fixes: https://github.com/libuv/libuv/issues/1401
PR-URL: https://github.com/libuv/libuv/pull/1538
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Saúl Ibarra Corretgé <saghul@gmail.com>
Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
This commit is contained in:
Vladimír Čunát 2017-09-11 15:36:19 +02:00 committed by cjihrig
parent 3f8f6dc4c7
commit 9d74b27ad4
No known key found for this signature in database
GPG Key ID: 7434390BDBE9B9C5
1 changed files with 2 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/src/timer.rst
View File

@ -45,6 +45,8 @@ API
.. note:: .. note::
Does not update the event loop's concept of "now". See :c:func:`uv_update_time` for more information. Does not update the event loop's concept of "now". See :c:func:`uv_update_time` for more information.
If the timer is already active, it is simply updated.
.. c:function:: int uv_timer_stop(uv_timer_t* handle) .. c:function:: int uv_timer_stop(uv_timer_t* handle)
Stop the timer, the callback will not be called anymore. Stop the timer, the callback will not be called anymore.