aboutsummaryrefslogtreecommitdiff
path: root/runtime
diff options
context:
space:
mode:
authorTommy Allen <tommy@esdf.io>2017-03-01 11:55:34 -0500
committerJustin M. Keyes <justinkz@gmail.com>2017-03-01 17:55:34 +0100
commit4e4c7850635dfa3218f2461b50a0b2b2c84d7242 (patch)
tree71014e67f84b7c4dde981df2ad0066258d936c87 /runtime
parent504693ce66e61e2976b0af2930177a07bafbe6f3 (diff)
downloadrneovim-4e4c7850635dfa3218f2461b50a0b2b2c84d7242.tar.gz
rneovim-4e4c7850635dfa3218f2461b50a0b2b2c84d7242.tar.bz2
rneovim-4e4c7850635dfa3218f2461b50a0b2b2c84d7242.zip
scripts: Annotate API functions in generated docs (#6199)
Diffstat (limited to 'runtime')
-rw-r--r--runtime/doc/api-funcs.txt21
1 files changed, 18 insertions, 3 deletions
diff --git a/runtime/doc/api-funcs.txt b/runtime/doc/api-funcs.txt
index 706941fd12..14c86306c6 100644
--- a/runtime/doc/api-funcs.txt
+++ b/runtime/doc/api-funcs.txt
@@ -38,6 +38,9 @@ nvim_input({keys}) *nvim_input()*
and the call is not deferred. This is the most reliable way to
emulate real user input.
+ Attributes:~
+ {async}
+
Parameters:~
{keys} to be typed
@@ -256,6 +259,9 @@ nvim_get_color_map() *nvim_get_color_map()*
nvim_get_api_info() *nvim_get_api_info()*
TODO: Documentation
+ Attributes:~
+ {async}
+
nvim_call_atomic({calls}) *nvim_call_atomic()*
Call many api methods atomically
@@ -345,11 +351,20 @@ nvim_buf_get_var({buffer}, {name}) *nvim_buf_get_var()*
Gets a buffer-scoped (b:) variable.
Parameters:~
- {buffer} Buffer handle
- {name} Variable name
+ {buffer} The buffer handle
+ {name} The variable name
Return:~
- Variable value
+ The variable value
+
+nvim_buf_get_changedtick({buffer}) *nvim_buf_get_changedtick()*
+ Gets a changed tick of a buffer
+
+ Parameters:~
+ {buffer} The buffer handle.
+
+ Return:~
+ b:changedtickvalue.
nvim_buf_set_var({buffer}, {name}, {value}) *nvim_buf_set_var()*
Sets a buffer-scoped (b:) variable