diff options
author | ZyX <kp-pav@ya.ru> | 2014-05-10 00:53:36 +0400 |
---|---|---|
committer | Thiago de Arruda <tpadilha84@gmail.com> | 2014-06-02 11:04:04 -0300 |
commit | 880957ad4e3fc0ff681025f5e29c5eccf797c564 (patch) | |
tree | c222654d93e73760c98a0aca92411942ca94237a /src/nvim/api/window.h | |
parent | 52a9a5b0b0c53a1481d901f39ed0d1e7e86c3853 (diff) | |
download | rneovim-880957ad4e3fc0ff681025f5e29c5eccf797c564.tar.gz rneovim-880957ad4e3fc0ff681025f5e29c5eccf797c564.tar.bz2 rneovim-880957ad4e3fc0ff681025f5e29c5eccf797c564.zip |
Move documentation from function declarations to definitions
Uses a perl script to move it (scripts/movedocs.pl)
Diffstat (limited to 'src/nvim/api/window.h')
-rw-r--r-- | src/nvim/api/window.h | 77 |
1 files changed, 0 insertions, 77 deletions
diff --git a/src/nvim/api/window.h b/src/nvim/api/window.h index 4c036ff5d7..694558fca8 100644 --- a/src/nvim/api/window.h +++ b/src/nvim/api/window.h @@ -6,109 +6,32 @@ #include "nvim/api/private/defs.h" -/// Gets the current buffer in a window -/// -/// @param window The window handle -/// @param[out] err Details of an error that may have occurred -/// @return The buffer handle Buffer window_get_buffer(Window window, Error *err); -/// Gets the cursor position in the window -/// -/// @param window The window handle -/// @param[out] err Details of an error that may have occurred -/// @return the (row, col) tuple Position window_get_cursor(Window window, Error *err); -/// Sets the cursor position in the window -/// -/// @param window The window handle -/// @param pos the (row, col) tuple representing the new position -/// @param[out] err Details of an error that may have occurred void window_set_cursor(Window window, Position pos, Error *err); -/// Gets the window height -/// -/// @param window The window handle -/// @param[out] err Details of an error that may have occurred -/// @return the height in rows Integer window_get_height(Window window, Error *err); -/// Sets the window height. This will only succeed if the screen is split -/// horizontally. -/// -/// @param window The window handle -/// @param height the new height in rows -/// @param[out] err Details of an error that may have occurred void window_set_height(Window window, Integer height, Error *err); -/// Gets the window width -/// -/// @param window The window handle -/// @param[out] err Details of an error that may have occurred -/// @return the width in columns Integer window_get_width(Window window, Error *err); -/// Sets the window width. This will only succeed if the screen is split -/// vertically. -/// -/// @param window The window handle -/// @param width the new width in columns -/// @param[out] err Details of an error that may have occurred void window_set_width(Window window, Integer width, Error *err); -/// Gets a window variable -/// -/// @param window The window handle -/// @param name The variable name -/// @param[out] err Details of an error that may have occurred -/// @return The variable value Object window_get_var(Window window, String name, Error *err); -/// Sets a window variable. Passing 'nil' as value deletes the variable. -/// -/// @param window The window handle -/// @param name The variable name -/// @param value The variable value -/// @param[out] err Details of an error that may have occurred -/// @return The old value Object window_set_var(Window window, String name, Object value, Error *err); -/// Gets a window option value -/// -/// @param window The window handle -/// @param name The option name -/// @param[out] err Details of an error that may have occurred -/// @return The option value Object window_get_option(Window window, String name, Error *err); -/// Sets a window option value. Passing 'nil' as value deletes the option(only -/// works if there's a global fallback) -/// -/// @param window The window handle -/// @param name The option name -/// @param value The option value -/// @param[out] err Details of an error that may have occurred void window_set_option(Window window, String name, Object value, Error *err); -/// Gets the window position in display cells. First position is zero. -/// -/// @param window The window handle -/// @param[out] err Details of an error that may have occurred -/// @return The (row, col) tuple with the window position Position window_get_position(Window window, Error *err); -/// Gets the window tab page -/// -/// @param window The window handle -/// @param[out] err Details of an error that may have occurred -/// @return The tab page that contains the window Tabpage window_get_tabpage(Window window, Error *err); -/// Checks if a window is valid -/// -/// @param window The window handle -/// @return true if the window is valid, false otherwise Boolean window_is_valid(Window window); #endif // NVIM_API_WINDOW_H |