api/*.c: Comment cleanup

- @justinmk: Clarify comments
- Match verbiage used in other api/*.c files
- Fix a few typos/missing words
This commit is contained in:
Michael Reed
2015-01-11 20:05:26 -05:00
committed by Justin M. Keyes
parent 6425627c3f
commit 75a1006a20
4 changed files with 28 additions and 28 deletions

View File

@@ -9,11 +9,11 @@
#include "nvim/memory.h"
#include "nvim/window.h"
/// Gets the number of windows in a tabpage
/// Gets the windows in a tabpage
///
/// @param tabpage The tabpage
/// @param[out] err Details of an error that may have occurred
/// @return The number of windows in `tabpage`
/// @return The windows in `tabpage`
ArrayOf(Window) tabpage_get_windows(Tabpage tabpage, Error *err)
{
Array rv = ARRAY_DICT_INIT;
@@ -37,7 +37,7 @@ ArrayOf(Window) tabpage_get_windows(Tabpage tabpage, Error *err)
return rv;
}
/// Gets a tabpage variable
/// Gets a tab-scoped (t:) variable
///
/// @param tabpage The tab page handle
/// @param name The variable name
@@ -54,7 +54,7 @@ Object tabpage_get_var(Tabpage tabpage, String name, Error *err)
return dict_get_value(tab->tp_vars, name, err);
}
/// Sets a tabpage variable. Passing 'nil' as value deletes the variable.
/// Sets a tab-scoped (t:) variable. 'nil' value deletes the variable.
///
/// @param tabpage handle
/// @param name The variable name