aboutsummaryrefslogtreecommitdiff
path: root/src/nvim/api/ui.c
diff options
context:
space:
mode:
authorDaniel Hahler <git@thequod.de>2019-09-09 08:34:40 +0200
committerJustin M. Keyes <justinkz@gmail.com>2019-09-10 23:27:00 -0700
commit1adbdb397df3509f3b9b3ed8f6a81dd044d278d9 (patch)
treef3cf5162569805ca08256d9966527e62c753da55 /src/nvim/api/ui.c
parentb735583377bf5c15a7bd5e910e4ae9fa833c1e42 (diff)
downloadrneovim-1adbdb397df3509f3b9b3ed8f6a81dd044d278d9.tar.gz
rneovim-1adbdb397df3509f3b9b3ed8f6a81dd044d278d9.tar.bz2
rneovim-1adbdb397df3509f3b9b3ed8f6a81dd044d278d9.zip
doc: nvim_ui_pum_set_height [ci skip]
Diffstat (limited to 'src/nvim/api/ui.c')
-rw-r--r--src/nvim/api/ui.c9
1 files changed, 3 insertions, 6 deletions
diff --git a/src/nvim/api/ui.c b/src/nvim/api/ui.c
index 9ff2a529ae..ada26a2a07 100644
--- a/src/nvim/api/ui.c
+++ b/src/nvim/api/ui.c
@@ -314,14 +314,11 @@ void nvim_ui_try_resize_grid(uint64_t channel_id, Integer grid, Integer width,
ui_grid_resize((handle_T)grid, (int)width, (int)height, err);
}
-/// Tell Nvim the number of element displayed in popumenu. The amount of
-/// movement by <PageUp> or <PageDown> is determined by the value set by this.
-///
-/// If the ext_popupmenu option is false or the height is 0 or less, fails
-/// with error.
+/// Tells Nvim the number of elements displaying in the popumenu, to decide
+/// <PageUp> and <PageDown> movement.
///
/// @param channel_id
-/// @param height The popupmenu height.
+/// @param height Popupmenu height, must be greater than zero.
/// @param[out] err Error details, if any
void nvim_ui_pum_set_height(uint64_t channel_id, Integer height, Error *err)
FUNC_API_SINCE(6) FUNC_API_REMOTE_ONLY