doc: add missing variable name
PR-URL: https://github.com/libuv/libuv/pull/432 Reviewed-By: Saúl Ibarra Corretgé <saghul@gmail.com>
This commit is contained in:
parent
517ade8ab2
commit
e110c46b81
@ -31,7 +31,7 @@ N/A
|
||||
API
|
||||
---
|
||||
|
||||
.. c:function:: int uv_check_init(uv_loop_t*, uv_check_t* check)
|
||||
.. c:function:: int uv_check_init(uv_loop_t* loop, uv_check_t* check)
|
||||
|
||||
Initialize the handle.
|
||||
|
||||
|
||||
@ -39,7 +39,7 @@ N/A
|
||||
API
|
||||
---
|
||||
|
||||
.. c:function:: int uv_idle_init(uv_loop_t*, uv_idle_t* idle)
|
||||
.. c:function:: int uv_idle_init(uv_loop_t* loop, uv_idle_t* idle)
|
||||
|
||||
Initialize the handle.
|
||||
|
||||
|
||||
@ -29,12 +29,12 @@ N/A
|
||||
API
|
||||
---
|
||||
|
||||
.. c:function:: int uv_pipe_init(uv_loop_t*, uv_pipe_t* handle, int ipc)
|
||||
.. c:function:: int uv_pipe_init(uv_loop_t* loop, uv_pipe_t* handle, int ipc)
|
||||
|
||||
Initialize a pipe handle. The `ipc` argument is a boolean to indicate if
|
||||
this pipe will be used for handle passing between processes.
|
||||
|
||||
.. c:function:: int uv_pipe_open(uv_pipe_t*, uv_file file)
|
||||
.. c:function:: int uv_pipe_open(uv_pipe_t* handle, uv_file file)
|
||||
|
||||
Open an existing file descriptor or HANDLE as a pipe.
|
||||
|
||||
|
||||
@ -62,7 +62,7 @@ Public members
|
||||
API
|
||||
---
|
||||
|
||||
.. c:function:: int uv_signal_init(uv_loop_t*, uv_signal_t* signal)
|
||||
.. c:function:: int uv_signal_init(uv_loop_t* loop, uv_signal_t* signal)
|
||||
|
||||
Initialize the handle.
|
||||
|
||||
|
||||
@ -123,7 +123,7 @@ API
|
||||
.. note::
|
||||
`server` and `client` must be handles running on the same loop.
|
||||
|
||||
.. c:function:: int uv_read_start(uv_stream_t*, uv_alloc_cb alloc_cb, uv_read_cb read_cb)
|
||||
.. c:function:: int uv_read_start(uv_stream_t* stream, uv_alloc_cb alloc_cb, uv_read_cb read_cb)
|
||||
|
||||
Read data from an incoming stream. The callback will be made several
|
||||
times until there is no more data to read or :c:func:`uv_read_stop` is called.
|
||||
|
||||
@ -28,11 +28,11 @@ N/A
|
||||
API
|
||||
---
|
||||
|
||||
.. c:function:: int uv_tcp_init(uv_loop_t*, uv_tcp_t* handle)
|
||||
.. c:function:: int uv_tcp_init(uv_loop_t* loop, uv_tcp_t* handle)
|
||||
|
||||
Initialize the handle. No socket is created as of yet.
|
||||
|
||||
.. c:function:: int uv_tcp_init_ex(uv_loop_t*, uv_tcp_t* handle, unsigned int flags)
|
||||
.. c:function:: int uv_tcp_init_ex(uv_loop_t* loop, uv_tcp_t* handle, unsigned int flags)
|
||||
|
||||
Initialize the handle with the specified flags. At the moment the lower 8 bits
|
||||
of the `flags` parameter are used as the socket domain. A socket will be created
|
||||
|
||||
@ -46,7 +46,7 @@ N/A
|
||||
API
|
||||
---
|
||||
|
||||
.. c:function:: int uv_tty_init(uv_loop_t*, uv_tty_t*, uv_file fd, int readable)
|
||||
.. c:function:: int uv_tty_init(uv_loop_t* loop, uv_tty_t* handle, uv_file fd, int readable)
|
||||
|
||||
Initialize a new TTY stream with the given file descriptor. Usually the
|
||||
file descriptor will be:
|
||||
@ -70,7 +70,7 @@ API
|
||||
descriptor that refers to a file returns `UV_EINVAL`
|
||||
on UNIX.
|
||||
|
||||
.. c:function:: int uv_tty_set_mode(uv_tty_t*, uv_tty_mode_t mode)
|
||||
.. c:function:: int uv_tty_set_mode(uv_tty_t* handle, uv_tty_mode_t mode)
|
||||
|
||||
.. versionchanged:: 1.2.0: the mode is specified as a
|
||||
:c:type:`uv_tty_mode_t` value.
|
||||
@ -86,7 +86,7 @@ API
|
||||
code ``UV_EBUSY`` if you call it when execution is inside
|
||||
:c:func:`uv_tty_set_mode`.
|
||||
|
||||
.. c:function:: int uv_tty_get_winsize(uv_tty_t*, int* width, int* height)
|
||||
.. c:function:: int uv_tty_get_winsize(uv_tty_t* handle, int* width, int* height)
|
||||
|
||||
Gets the current Window size. On success it returns 0.
|
||||
|
||||
|
||||
@ -105,12 +105,12 @@ Public members
|
||||
API
|
||||
---
|
||||
|
||||
.. c:function:: int uv_udp_init(uv_loop_t*, uv_udp_t* handle)
|
||||
.. c:function:: int uv_udp_init(uv_loop_t* loop, uv_udp_t* handle)
|
||||
|
||||
Initialize a new UDP handle. The actual socket is created lazily.
|
||||
Returns 0 on success.
|
||||
|
||||
.. c:function:: int uv_udp_init_ex(uv_loop_t*, uv_udp_t* handle, unsigned int flags)
|
||||
.. c:function:: int uv_udp_init_ex(uv_loop_t* loop, uv_udp_t* handle, unsigned int flags)
|
||||
|
||||
Initialize the handle with the specified flags. At the moment the lower 8 bits
|
||||
of the `flags` parameter are used as the socket domain. A socket will be created
|
||||
|
||||
Loading…
Reference in New Issue
Block a user