aboutsummaryrefslogtreecommitdiff
path: root/src/nvim/api/vim.c
diff options
context:
space:
mode:
authorBjörn Linse <bjorn.linse@gmail.com>2019-03-03 12:38:14 +0100
committerBjörn Linse <bjorn.linse@gmail.com>2019-03-12 17:17:58 +0100
commit4ab0dcc4a91621dc73e1d457e480e575af64137b (patch)
tree504f8bf602f6079fbf2b094fd38a3099db1f086d /src/nvim/api/vim.c
parent81e84f2aae7ff174714a68192584da7e3b7358c5 (diff)
downloadrneovim-4ab0dcc4a91621dc73e1d457e480e575af64137b.tar.gz
rneovim-4ab0dcc4a91621dc73e1d457e480e575af64137b.tar.bz2
rneovim-4ab0dcc4a91621dc73e1d457e480e575af64137b.zip
docs: floating windows introduction
Diffstat (limited to 'src/nvim/api/vim.c')
-rw-r--r--src/nvim/api/vim.c2
1 files changed, 2 insertions, 0 deletions
diff --git a/src/nvim/api/vim.c b/src/nvim/api/vim.c
index 955920d6ae..a773234ea0 100644
--- a/src/nvim/api/vim.c
+++ b/src/nvim/api/vim.c
@@ -998,6 +998,8 @@ Buffer nvim_create_buf(Boolean listed, Boolean scratch, Error *err)
/// GUI with the |ui-multigrid| extension. External windows are only supported
/// with multigrid GUIs, and are displayed as separate top-level windows.
///
+/// For a general overview of floats, see |api-floatwin|.
+///
/// Exactly one of `external` and `relative` must be specified.
///
/// @param buffer handle of buffer to be displayed in the window