Skip to content

Commit e4dc4aa

Browse files
committed
doc: add documentation for missing functions and structures
* uv_process_kill, uv_kill * uv_fs_poll_init * uv_timespec_t
1 parent 00df3ec commit e4dc4aa

File tree

3 files changed

+26
-1
lines changed

3 files changed

+26
-1
lines changed

docs/src/fs.rst

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,20 @@ Data types
2020
2121
Filesystem request type.
2222

23+
.. c:type:: uv_timespec_t
24+
25+
Portable equivalent of ``struct timespec``.
26+
27+
::
28+
29+
typedef struct {
30+
long tv_sec;
31+
long tv_nsec;
32+
} uv_timespec_t;
33+
2334
.. c:type:: uv_stat_t
2435
25-
Portable equivalent of `struct stat`.
36+
Portable equivalent of ``struct stat``.
2637

2738
::
2839

docs/src/fs_poll.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,10 @@ N/A
4242
API
4343
---
4444

45+
.. c:function:: int uv_fs_poll_init(uv_loop_t* loop, uv_fs_poll_t* handle)
46+
47+
Initialize the handle.
48+
4549
.. c:function:: int uv_fs_poll_start(uv_fs_poll_t* handle, uv_fs_poll_cb poll_cb, const char* path, unsigned int interval)
4650
4751
Check the file at `path` for changes every `interval` milliseconds.

docs/src/process.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -212,4 +212,14 @@ API
212212
setgid specified, or not having enough memory to allocate for the new
213213
process.
214214
215+
.. c:function:: int uv_process_kill(uv_process_t* handle, int signum)
216+
217+
Sends the specified signal to the given process handle. Check the documentation
218+
on :c:ref:`signal` for signal support, specially on Windows.
219+
220+
.. c:function:: int uv_kill(int pid, int signum)
221+
222+
Sends the specified signal to the given PID. Check the documentation
223+
on :c:ref:`signal` for signal support, specially on Windows.
224+
215225
.. seealso:: The :c:type:`uv_handle_t` API functions also apply.

0 commit comments

Comments
 (0)