aboutsummaryrefslogtreecommitdiff
path: root/src/nvim/api/buffer.c
diff options
context:
space:
mode:
authorJustin M. Keyes <justinkz@gmail.com>2017-11-06 02:00:39 +0100
committerJustin M. Keyes <justinkz@gmail.com>2017-11-06 04:51:34 +0100
commit280943d9b938e95fcf77ef5290576630b84511fb (patch)
tree9afbf06aaa972109fb218f56e6f3ba06ba7cd6d3 /src/nvim/api/buffer.c
parent7e59b897c150e4d43af223aa47da115ee8beb653 (diff)
downloadrneovim-280943d9b938e95fcf77ef5290576630b84511fb.tar.gz
rneovim-280943d9b938e95fcf77ef5290576630b84511fb.tar.bz2
rneovim-280943d9b938e95fcf77ef5290576630b84511fb.zip
doc: API (generated)
Diffstat (limited to 'src/nvim/api/buffer.c')
-rw-r--r--src/nvim/api/buffer.c13
1 files changed, 7 insertions, 6 deletions
diff --git a/src/nvim/api/buffer.c b/src/nvim/api/buffer.c
index f592f44f0e..4b6a88e5fa 100644
--- a/src/nvim/api/buffer.c
+++ b/src/nvim/api/buffer.c
@@ -439,6 +439,7 @@ Object nvim_buf_get_var(Buffer buffer, String name, Error *err)
/// Gets a changed tick of a buffer
///
/// @param[in] buffer Buffer handle.
+/// @param[out] err Error details, if any
///
/// @return `b:changedtick` value.
Integer nvim_buf_get_changedtick(Buffer buffer, Error *err)
@@ -453,14 +454,14 @@ Integer nvim_buf_get_changedtick(Buffer buffer, Error *err)
return buf->b_changedtick;
}
-/// Get a list of dictionaries describing buffer-local mappings
-/// Note that the buffer key in the dictionary will represent the buffer
-/// handle where the mapping is present
+/// Gets a list of dictionaries describing buffer-local mappings.
+/// The "buffer" key in the returned dictionary reflects the buffer
+/// handle where the mapping is present.
///
-/// @param mode The abbreviation for the mode
-/// @param buffer_id Buffer handle
+/// @param mode Mode short-name ("n", "i", "v", ...)
+/// @param buffer Buffer handle
/// @param[out] err Error details, if any
-/// @returns An array of maparg() like dictionaries describing mappings
+/// @returns Array of maparg()-like dictionaries describing mappings
ArrayOf(Dictionary) nvim_buf_get_keymap(Buffer buffer, String mode, Error *err)
FUNC_API_SINCE(3)
{