IntenseFinance/neovim
3
0
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2025-02-25 18:55:25 -06:00
Code Issues Packages Projects Releases Wiki Activity

doc/api: nvim_out_write() and friends

Browse Source 
References #7178
This commit is contained in:
Justin M. Keyes 2017-08-17 23:30:28 +02:00
parent af046a3a81
commit b13070ec01
2 changed files with 16 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
runtime/doc/api.txt
View File

@ -171,8 +171,8 @@ nvim_replace_termcodes({str}, {from_part}, {do_lt}, {special})
Parameters:~ Parameters:~
{str} String to be converted. {str} String to be converted.
{from_part} Legacy Vim parameter. Usually true. {from_part} Legacy Vim parameter. Usually true.
{do_lt} Also translate <lt>. Does nothing if {do_lt} Also translate <lt>. Ignored if `special` is
`special` is false. false.
{special} Replace |keycodes|, e.g. <CR> becomes a "\n" {special} Replace |keycodes|, e.g. <CR> becomes a "\n"
char. char.
@ -309,20 +309,24 @@ nvim_set_option({name}, {value}) *nvim_set_option()*
{value} New option value {value} New option value
nvim_out_write({str}) *nvim_out_write()* nvim_out_write({str}) *nvim_out_write()*
Writes a message to vim output buffer Writes a message to the Vim output buffer. Does not append
"\n", the message is buffered (won't display) until a linefeed
is written.
Parameters:~ Parameters:~
{str} Message {str} Message
nvim_err_write({str}) *nvim_err_write()* nvim_err_write({str}) *nvim_err_write()*
Writes a message to vim error buffer Writes a message to the Vim error buffer. Does not append
"\n", the message is buffered (won't display) until a linefeed
is written.
Parameters:~ Parameters:~
{str} Message {str} Message
nvim_err_writeln({str}) *nvim_err_writeln()* nvim_err_writeln({str}) *nvim_err_writeln()*
Writes a message to vim error buffer. Appends a linefeed to Writes a message to the Vim error buffer. Appends "\n", so the
ensure all contents are written. buffer is flushed (and displayed).
Parameters:~ Parameters:~
{str} Message {str} Message

10
src/nvim/api/vim.c
View File

@ -484,7 +484,8 @@ void nvim_set_option(String name, Object value, Error *err)
set_option_to(NULL, SREQ_GLOBAL, name, value, err); set_option_to(NULL, SREQ_GLOBAL, name, value, err);
} }
/// Writes a message to vim output buffer /// Writes a message to the Vim output buffer. Does not append "\n", the
/// message is buffered (won't display) until a linefeed is written.
/// ///
/// @param str Message /// @param str Message
void nvim_out_write(String str) void nvim_out_write(String str)
@ -493,7 +494,8 @@ void nvim_out_write(String str)
write_msg(str, false); write_msg(str, false);
} }
/// Writes a message to vim error buffer /// Writes a message to the Vim error buffer. Does not append "\n", the
/// message is buffered (won't display) until a linefeed is written.
/// ///
/// @param str Message /// @param str Message
void nvim_err_write(String str) void nvim_err_write(String str)
@ -502,8 +504,8 @@ void nvim_err_write(String str)
write_msg(str, true); write_msg(str, true);
} }
/// Writes a message to vim error buffer. Appends a linefeed to ensure all /// Writes a message to the Vim error buffer. Appends "\n", so the buffer is
/// contents are written. /// flushed (and displayed).
/// ///
/// @param str Message /// @param str Message
/// @see nvim_err_write() /// @see nvim_err_write()