aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorThiago de Arruda <tpadilha84@gmail.com>2014-06-26 13:15:25 -0300
committerThiago de Arruda <tpadilha84@gmail.com>2014-07-17 11:30:01 -0300
commit5d9c73ce70420321b92519d56c1c9e03fea94ecc (patch)
tree45470d79e18b8a49ce094c8933d21f028cfcef0e
parentb92630c2fff7950141630f0d62b11404d0589ece (diff)
downloadrneovim-5d9c73ce70420321b92519d56c1c9e03fea94ecc.tar.gz
rneovim-5d9c73ce70420321b92519d56c1c9e03fea94ecc.tar.bz2
rneovim-5d9c73ce70420321b92519d56c1c9e03fea94ecc.zip
wstream: document default value for 'maxmem'
-rw-r--r--src/nvim/os/wstream.c3
1 files changed, 2 insertions, 1 deletions
diff --git a/src/nvim/os/wstream.c b/src/nvim/os/wstream.c
index 3c4b5b6171..20aa5ddeb2 100644
--- a/src/nvim/os/wstream.c
+++ b/src/nvim/os/wstream.c
@@ -42,7 +42,8 @@ typedef struct {
/// Creates a new WStream instance. A WStream encapsulates all the boilerplate
/// necessary for writing to a libuv stream.
///
-/// @param maxmem Maximum amount memory used by this `WStream` instance.
+/// @param maxmem Maximum amount memory used by this `WStream` instance. If 0,
+/// a default value of 10mb will be used.
/// @return The newly-allocated `WStream` instance
WStream * wstream_new(size_t maxmem)
{