wstream: document default value for 'maxmem'

This commit is contained in:
Thiago de Arruda
2014-06-26 13:15:25 -03:00
parent b92630c2ff
commit 5d9c73ce70

View File

@@ -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)
{