mirrors/neovim
1
0
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2025-12-01 14:33:11 +00:00
Code Issues Packages Projects Releases Wiki Activity

api/documentation: Add a warning that nil may mean v:null

Browse Source
This commit is contained in:
ZyX
2016-02-21 05:17:20 +03:00
parent 2f67786796
commit 7cdd01983a
4 changed files with 16 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
src/nvim/api/buffer.c
View File

@@ -429,7 +429,10 @@ Object buffer_get_var(Buffer buffer, String name, Error *err)
/// @param name The variable name /// @param name The variable name
/// @param value The variable value /// @param value The variable value
/// @param[out] err Details of an error that may have occurred /// @param[out] err Details of an error that may have occurred
/// @return The old value /// @return The old value or nil if there was no previous value.
///
/// @warning It may return nil if there was no previous value
/// or if previous value was `v:null`.
Object buffer_set_var(Buffer buffer, String name, Object value, Error *err) Object buffer_set_var(Buffer buffer, String name, Object value, Error *err)
{ {
buf_T *buf = find_buffer_by_handle(buffer, err); buf_T *buf = find_buffer_by_handle(buffer, err);

5
src/nvim/api/tabpage.c
View File

@@ -60,7 +60,10 @@ Object tabpage_get_var(Tabpage tabpage, String name, Error *err)
/// @param name The variable name /// @param name The variable name
/// @param value The variable value /// @param value The variable value
/// @param[out] err Details of an error that may have occurred /// @param[out] err Details of an error that may have occurred
/// @return The tab page handle /// @return The old value or nil if there was no previous value.
///
/// @warning It may return nil if there was no previous value
/// or if previous value was `v:null`.
Object tabpage_set_var(Tabpage tabpage, String name, Object value, Error *err) Object tabpage_set_var(Tabpage tabpage, String name, Object value, Error *err)
{ {
tabpage_T *tab = find_tab_by_handle(tabpage, err); tabpage_T *tab = find_tab_by_handle(tabpage, err);

5
src/nvim/api/vim.c
View File

@@ -336,7 +336,10 @@ Object vim_get_var(String name, Error *err)
/// @param name The variable name /// @param name The variable name
/// @param value The variable value /// @param value The variable value
/// @param[out] err Details of an error that may have occurred /// @param[out] err Details of an error that may have occurred
/// @return the old value if any /// @return The old value or nil if there was no previous value.
///
/// @warning It may return nil if there was no previous value
/// or if previous value was `v:null`.
Object vim_set_var(String name, Object value, Error *err) Object vim_set_var(String name, Object value, Error *err)
{ {
return dict_set_value(&globvardict, name, value, false, err); return dict_set_value(&globvardict, name, value, false, err);

5
src/nvim/api/window.c
View File

@@ -203,7 +203,10 @@ Object window_get_var(Window window, String name, Error *err)
/// @param name The variable name /// @param name The variable name
/// @param value The variable value /// @param value The variable value
/// @param[out] err Details of an error that may have occurred /// @param[out] err Details of an error that may have occurred
/// @return The old value /// @return The old value or nil if there was no previous value.
///
/// @warning It may return nil if there was no previous value
/// or if previous value was `v:null`.
Object window_set_var(Window window, String name, Object value, Error *err) Object window_set_var(Window window, String name, Object value, Error *err)
{ {
win_T *win = find_window_by_handle(window, err); win_T *win = find_window_by_handle(window, err);