diff options
| author | Justin M. Keyes <justinkz@gmail.com> | 2019-04-22 21:34:46 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-04-22 21:34:46 +0200 |
| commit | eada8f5aaae0c072571c87b6dbd3c7992541d698 (patch) | |
| tree | 8749bbdf6219618d0b37044aa525b7ad8e9627c8 /src/nvim/api/buffer.c | |
| parent | d0fd66ba82c4ea6d83e2a635eeddb7c7175e02c9 (diff) | |
| parent | c1887f465de3f1dd4b99046512eb108e75548c5f (diff) | |
| download | rneovim-eada8f5aaae0c072571c87b6dbd3c7992541d698.tar.gz rneovim-eada8f5aaae0c072571c87b6dbd3c7992541d698.tar.bz2 rneovim-eada8f5aaae0c072571c87b6dbd3c7992541d698.zip | |
Merge pull request #9871 from justinmk/doc
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, |