diff options
Diffstat (limited to 'src/nvim/api/deprecated.c')
| -rw-r--r-- | src/nvim/api/deprecated.c | 28 |
1 files changed, 14 insertions, 14 deletions
diff --git a/src/nvim/api/deprecated.c b/src/nvim/api/deprecated.c index 767a7a8bc8..cf2aebf274 100644 --- a/src/nvim/api/deprecated.c +++ b/src/nvim/api/deprecated.c @@ -69,7 +69,7 @@ Object nvim_execute_lua(String code, Array args, Arena *arena, Error *err) /// /// @deprecated The buffer number now is equal to the object id /// -/// @param buffer Buffer handle, or 0 for current buffer +/// @param buffer Buffer id, or 0 for current buffer /// @param[out] err Error details, if any /// @return Buffer number Integer nvim_buf_get_number(Buffer buffer, Error *err) @@ -100,7 +100,7 @@ static uint32_t src2ns(Integer *src_id) /// /// @deprecated use |nvim_buf_clear_namespace()|. /// -/// @param buffer Buffer handle, or 0 for current buffer +/// @param buffer Buffer id, or 0 for current buffer /// @param ns_id Namespace to clear, or -1 to clear all. /// @param line_start Start of range of lines to clear /// @param line_end End of range of lines to clear (exclusive) or -1 to clear @@ -131,7 +131,7 @@ void nvim_buf_clear_highlight(Buffer buffer, Integer ns_id, Integer line_start, /// supported for backwards compatibility, new code should use /// |nvim_create_namespace()| to create a new empty namespace. /// -/// @param buffer Buffer handle, or 0 for current buffer +/// @param buffer Buffer id, or 0 for current buffer /// @param ns_id namespace to use or -1 for ungrouped highlight /// @param hl_group Name of the highlight group to use /// @param line Line to highlight (zero-indexed) @@ -207,7 +207,7 @@ Integer nvim_buf_add_highlight(Buffer buffer, Integer ns_id, String hl_group, In /// As a shorthand, `ns_id = 0` can be used to create a new namespace for the /// virtual text, the allocated id is then returned. /// -/// @param buffer Buffer handle, or 0 for current buffer +/// @param buffer Buffer id, or 0 for current buffer /// @param src_id Namespace to use or 0 to create a namespace, /// or -1 for a ungrouped annotation /// @param line Line to annotate with virtual text (zero-indexed) @@ -309,7 +309,7 @@ Dict nvim_get_hl_by_name(String name, Boolean rgb, Arena *arena, Error *err) /// /// @deprecated use nvim_buf_set_lines(buffer, lnum, lnum, true, lines) /// -/// @param buffer Buffer handle +/// @param buffer Buffer id /// @param lnum Insert the lines after `lnum`. If negative, appends to /// the end of the buffer. /// @param lines Array of lines @@ -330,7 +330,7 @@ void buffer_insert(Buffer buffer, Integer lnum, ArrayOf(String) lines, Arena *ar /// for negative indices use /// "nvim_buf_get_lines(buffer, index-1, index, true)" /// -/// @param buffer Buffer handle +/// @param buffer Buffer id /// @param index Line index /// @param[out] err Error details, if any /// @return Line string @@ -357,7 +357,7 @@ String buffer_get_line(Buffer buffer, Integer index, Arena *arena, Error *err) /// for negative indices use /// "nvim_buf_set_lines(buffer, index-1, index, true, [line])" /// -/// @param buffer Buffer handle +/// @param buffer Buffer id /// @param index Line index /// @param line Contents of the new line /// @param[out] err Error details, if any @@ -377,7 +377,7 @@ void buffer_set_line(Buffer buffer, Integer index, String line, Arena *arena, Er /// "nvim_buf_set_lines(buffer, index, index+1, true, [])" /// for negative indices use /// "nvim_buf_set_lines(buffer, index-1, index, true, [])" -/// @param buffer buffer handle +/// @param buffer buffer id /// @param index line index /// @param[out] err Error details, if any void buffer_del_line(Buffer buffer, Integer index, Arena *arena, Error *err) @@ -394,7 +394,7 @@ void buffer_del_line(Buffer buffer, Integer index, Arena *arena, Error *err) /// where newstart = start + int(not include_start) - int(start < 0) /// newend = end + int(include_end) - int(end < 0) /// int(bool) = 1 if bool is true else 0 -/// @param buffer Buffer handle +/// @param buffer Buffer id /// @param start First line index /// @param end Last line index /// @param include_start True if the slice includes the `start` parameter @@ -422,7 +422,7 @@ ArrayOf(String) buffer_get_line_slice(Buffer buffer, /// newend = end + int(include_end) + int(end < 0) /// int(bool) = 1 if bool is true else 0 /// -/// @param buffer Buffer handle, or 0 for current buffer +/// @param buffer Buffer id, or 0 for current buffer /// @param start First line index /// @param end Last line index /// @param include_start True if the slice includes the `start` parameter @@ -444,7 +444,7 @@ void buffer_set_line_slice(Buffer buffer, Integer start, Integer end, Boolean in /// /// @deprecated /// -/// @param buffer Buffer handle, or 0 for current buffer +/// @param buffer Buffer id, or 0 for current buffer /// @param name Variable name /// @param value Variable value /// @param[out] err Error details, if any @@ -468,7 +468,7 @@ Object buffer_set_var(Buffer buffer, String name, Object value, Arena *arena, Er /// /// @deprecated /// -/// @param buffer Buffer handle, or 0 for current buffer +/// @param buffer Buffer id, or 0 for current buffer /// @param name Variable name /// @param[out] err Error details, if any /// @return Old value @@ -641,7 +641,7 @@ Object nvim_get_option(String name, Error *err) /// Gets a buffer option value /// /// @deprecated -/// @param buffer Buffer handle, or 0 for current buffer +/// @param buffer Buffer id, or 0 for current buffer /// @param name Option name /// @param[out] err Error details, if any /// @return Option value @@ -664,7 +664,7 @@ Object nvim_buf_get_option(Buffer buffer, String name, Error *err) /// /// @deprecated /// @param channel_id -/// @param buffer Buffer handle, or 0 for current buffer +/// @param buffer Buffer id, or 0 for current buffer /// @param name Option name /// @param value Option value /// @param[out] err Error details, if any |