mirrors/neovim
1
0
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2025-09-18 17:28:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

api: update doc

Browse Source
This commit is contained in:
Marco Hinz
2019-03-15 18:18:56 +01:00
parent 96edbe7b1d
commit 27c4b6b9bd
2 changed files with 42 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -439,11 +439,15 @@ Boolean nvim_win_is_valid(Window window)
/// types).
///
/// See documentation at |nvim_open_win()|, for the meaning of parameters. Pass
/// in 0 for 'witdh' and 'height' to keep exiting size.
/// in 0 for `width` and `height` to keep existing size.
///
/// When reconfiguring a floating window, absent option keys will not be
/// changed. The following restriction apply: `row`, `col` and `relative`
/// must be reconfigured together. Only changing a subset of these is an error.
///
/// @param window Window handle
/// @param options Dictionary of options
/// @param[out] err Error details, if any
void nvim_win_set_config(Window window, Dictionary options, Error *err)
FUNC_API_SINCE(6)
{
@@ -476,6 +480,8 @@ void nvim_win_set_config(Window window, Dictionary options, Error *err)
/// Return a dictionary containing the same options that can be given to
/// |nvim_open_win()|.
///
/// `relative` will be empty for normal windows.
///
/// @param window Window handle
/// @param[out] err Error details, if any
/// @return Window configuration