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

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

View File

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