diff options
author | Fedor Indutny <fedor@indutny.com> | 2016-05-27 23:55:12 -0400 |
---|---|---|
committer | Fedor Indutny <fedor@indutny.com> | 2016-05-27 23:55:12 -0400 |
commit | e331502d3d6af324dd6da8277a742fab85a8b666 (patch) | |
tree | e7f9306063d9e81537f0a3359c2eead291b58fee /docs | |
parent | 5b0ecb73df1dabb12e26b6be71928e1f5023d182 (diff) | |
download | uv_link_t-e331502d3d6af324dd6da8277a742fab85a8b666.tar.gz |
docs: improvement
Diffstat (limited to 'docs')
-rw-r--r-- | docs/api.md | 68 |
1 files changed, 25 insertions, 43 deletions
diff --git a/docs/api.md b/docs/api.md index a1a58e8..4a1a80b 100644 --- a/docs/api.md +++ b/docs/api.md @@ -1,49 +1,31 @@ # uv_link_t -## Types - -### uv_link_t +## uv_link_t The base unit of all APIs. Pointer to this structure is what needs to be passed to the most of the methods. -### uv_link_methods_t - -TODO(indutny) - -### uv_link_source_t - -TODO(indutny) - -### uv_link_observer_t - -TODO(indutny) - -## Methods - -### uv_link_t - -#### int uv_link_init(...) -#### void uv_link_close(...) -#### int uv_link_chain(...) -#### int uv_link_unchain(...) -#### void uv_link_propagate_alloc_cb(...) -#### void uv_link_propagate_read_cb(...) -#### int uv_link_propagate_write(...) -#### int uv_link_propagate_shutdown(...) -#### void uv_link_propagate_close(...) -#### int uv_link_read_start(...) -#### int uv_link_read_stop(...) -#### int uv_link_write(...) -#### int uv_link_try_write(...) -#### int uv_link_shutdown(...) - -### uv_link_source_t - -#### int uv_link_source_init(...) -#### int uv_link_observer_init(...) - -### uv_link_observer_t - -#### int uv_link_observer_init(...) -#### .observer_read_cb +### int uv_link_init(...) +### void uv_link_close(...) +### int uv_link_chain(...) +### int uv_link_unchain(...) +### void uv_link_propagate_alloc_cb(...) +### void uv_link_propagate_read_cb(...) +### int uv_link_propagate_write(...) +### int uv_link_propagate_shutdown(...) +### void uv_link_propagate_close(...) +### int uv_link_read_start(...) +### int uv_link_read_stop(...) +### int uv_link_write(...) +### int uv_link_try_write(...) +### int uv_link_shutdown(...) + +## uv_link_source_t + +### int uv_link_source_init(...) +### int uv_link_observer_init(...) + +## uv_link_observer_t + +### int uv_link_observer_init(...) +### .observer_read_cb |