doc: add documentation for missing functions and structures

* uv_process_kill, uv_kill
* uv_fs_poll_init
* uv_timespec_t
This commit is contained in:
Saúl Ibarra Corretgé 2014-10-01 09:23:09 +02:00
parent 00df3ec75b
commit e4dc4aaac5
3 changed files with 26 additions and 1 deletions

View File

@ -20,9 +20,20 @@ Data types
Filesystem request type.
.. c:type:: uv_timespec_t
Portable equivalent of ``struct timespec``.
::
typedef struct {
long tv_sec;
long tv_nsec;
} uv_timespec_t;
.. c:type:: uv_stat_t
Portable equivalent of `struct stat`.
Portable equivalent of ``struct stat``.
::

View File

@ -42,6 +42,10 @@ N/A
API
---
.. c:function:: int uv_fs_poll_init(uv_loop_t* loop, uv_fs_poll_t* handle)
Initialize the handle.
.. c:function:: int uv_fs_poll_start(uv_fs_poll_t* handle, uv_fs_poll_cb poll_cb, const char* path, unsigned int interval)
Check the file at `path` for changes every `interval` milliseconds.

View File

@ -212,4 +212,14 @@ API
setgid specified, or not having enough memory to allocate for the new
process.
.. c:function:: int uv_process_kill(uv_process_t* handle, int signum)
Sends the specified signal to the given process handle. Check the documentation
on :c:ref:`signal` for signal support, specially on Windows.
.. c:function:: int uv_kill(int pid, int signum)
Sends the specified signal to the given PID. Check the documentation
on :c:ref:`signal` for signal support, specially on Windows.
.. seealso:: The :c:type:`uv_handle_t` API functions also apply.