aboutsummaryrefslogtreecommitdiff
path: root/src/nvim/api/buffer.c
diff options
context:
space:
mode:
authorJustin M. Keyes <justinkz@gmail.com>2017-03-01 17:18:03 +0100
committerJustin M. Keyes <justinkz@gmail.com>2017-03-01 23:14:45 +0100
commit985bc6c6e055785e9cee22c1fd70127f82cdbffb (patch)
treef12383a05912d568645ca83f6db84a123b6a9be6 /src/nvim/api/buffer.c
parent2c408c0c94915b6c38c1eccdb68b2645829130c2 (diff)
downloadrneovim-985bc6c6e055785e9cee22c1fd70127f82cdbffb.tar.gz
rneovim-985bc6c6e055785e9cee22c1fd70127f82cdbffb.tar.bz2
rneovim-985bc6c6e055785e9cee22c1fd70127f82cdbffb.zip
doc/api.txt: Merge with api-funcs.txt
It's important that users have a single, easy-to-remember place for reading about the API. So this commit changes gen_api_vimdoc.py so that the generated section is appended to api.txt instead of creating a separate document. Also remove the section numbering and ToC: it's a maintenance cost, and it will be unnecessary when #5169 is integrated.
Diffstat (limited to 'src/nvim/api/buffer.c')
-rw-r--r--src/nvim/api/buffer.c10
1 files changed, 5 insertions, 5 deletions
diff --git a/src/nvim/api/buffer.c b/src/nvim/api/buffer.c
index 7f6e1093ed..c667732f7d 100644
--- a/src/nvim/api/buffer.c
+++ b/src/nvim/api/buffer.c
@@ -411,10 +411,10 @@ end:
/// Gets a buffer-scoped (b:) variable.
///
-/// @param buffer The buffer handle
-/// @param name The variable name
-/// @param[out] err Details of an error that may have occurred
-/// @return The variable value
+/// @param buffer Buffer handle
+/// @param name Variable name
+/// @param[out] err Error details, if any
+/// @return Variable value
Object nvim_buf_get_var(Buffer buffer, String name, Error *err)
{
buf_T *buf = find_buffer_by_handle(buffer, err);
@@ -428,7 +428,7 @@ Object nvim_buf_get_var(Buffer buffer, String name, Error *err)
/// Gets a changed tick of a buffer
///
-/// @param[in] buffer The buffer handle.
+/// @param[in] buffer Buffer handle.
///
/// @return `b:changedtick` value.
Integer nvim_buf_get_changedtick(Buffer buffer, Error *err)