api: Add warnings about the returned value to \*del_var functions

This commit is contained in:
ZyX
2016-03-17 23:31:31 +03:00
parent 4f8b686435
commit 25bb08dad9
5 changed files with 16 additions and 5 deletions

View File

@@ -80,7 +80,10 @@ Object tabpage_set_var(Tabpage tabpage, String name, Object value, Error *err)
/// @param tabpage handle
/// @param name The variable name
/// @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_del_var(Tabpage tabpage, String name, Error *err)
{
tabpage_T *tab = find_tab_by_handle(tabpage, err);