From e4dc4aaac5964a0638198cd0907409e7a2a9a2f3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sa=C3=BAl=20Ibarra=20Corretg=C3=A9?= Date: Wed, 1 Oct 2014 09:23:09 +0200 Subject: [PATCH] doc: add documentation for missing functions and structures * uv_process_kill, uv_kill * uv_fs_poll_init * uv_timespec_t --- docs/src/fs.rst | 13 ++++++++++++- docs/src/fs_poll.rst | 4 ++++ docs/src/process.rst | 10 ++++++++++ 3 files changed, 26 insertions(+), 1 deletion(-) diff --git a/docs/src/fs.rst b/docs/src/fs.rst index c3817f2a..d6a0e6a3 100644 --- a/docs/src/fs.rst +++ b/docs/src/fs.rst @@ -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``. :: diff --git a/docs/src/fs_poll.rst b/docs/src/fs_poll.rst index 2e64bfb7..7459aac0 100644 --- a/docs/src/fs_poll.rst +++ b/docs/src/fs_poll.rst @@ -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. diff --git a/docs/src/process.rst b/docs/src/process.rst index fccfc00c..b0380ddf 100644 --- a/docs/src/process.rst +++ b/docs/src/process.rst @@ -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.