diff options
| author | Justin M. Keyes <justinkz@gmail.com> | 2019-04-09 03:14:27 +0200 |
|---|---|---|
| committer | Justin M. Keyes <justinkz@gmail.com> | 2019-04-22 20:56:16 +0200 |
| commit | eabe7d95f89b9673640a39fb60d5783efd88db57 (patch) | |
| tree | 1c616d2588730ac0b6a0a554f25a8381c0ddbb2f /src/nvim/api/buffer.c | |
| parent | 4d97abe805ce7153f29a40c3614a960a7d6e8371 (diff) | |
| download | rneovim-eabe7d95f89b9673640a39fb60d5783efd88db57.tar.gz rneovim-eabe7d95f89b9673640a39fb60d5783efd88db57.tar.bz2 rneovim-eabe7d95f89b9673640a39fb60d5783efd88db57.zip | |
doc: UI
Diffstat (limited to 'src/nvim/api/buffer.c')
| -rw-r--r-- | src/nvim/api/buffer.c | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/src/nvim/api/buffer.c b/src/nvim/api/buffer.c index e27c85cd4f..da4db60ad6 100644 --- a/src/nvim/api/buffer.c +++ b/src/nvim/api/buffer.c @@ -97,7 +97,7 @@ String buffer_get_line(Buffer buffer, Integer index, Error *err) return rv; } -/// Activate updates from this buffer to the current channel. +/// Activates buffer-update events on the channel. /// /// @param channel_id /// @param buffer Buffer handle, or 0 for current buffer @@ -106,7 +106,7 @@ String buffer_get_line(Buffer buffer, Integer index, Error *err) /// `nvim_buf_lines_event`. Otherwise, the first notification will be /// a `nvim_buf_changedtick_event` /// @param opts Optional parameters. Reserved for future use. -/// @param[out] err Details of an error that may have occurred +/// @param[out] err Error details, if any /// @return False when updates couldn't be enabled because the buffer isn't /// loaded or `opts` contained an invalid key; otherwise True. Boolean nvim_buf_attach(uint64_t channel_id, @@ -129,12 +129,12 @@ Boolean nvim_buf_attach(uint64_t channel_id, return buf_updates_register(buf, channel_id, send_buffer); } -// -/// Deactivate updates from this buffer to the current channel. + +/// Deactivates buffer-update events on the channel. /// /// @param channel_id /// @param buffer Buffer handle, or 0 for current buffer -/// @param[out] err Details of an error that may have occurred +/// @param[out] err Error details, if any /// @return False when updates couldn't be disabled because the buffer /// isn't loaded; otherwise True. Boolean nvim_buf_detach(uint64_t channel_id, |