-refined semantics for STREAM_write

diff --git a/src/include/gnunet_stream_lib.h b/src/include/gnunet_stream_lib.h
index d3c4e16531c8ade3fa44408de062ba8c672958a1..7ac0f5d96a68e4c4acfdcb3001c63c3d0c7082d8 100644 (file)
--- a/src/include/gnunet_stream_lib.h
+++ b/src/include/gnunet_stream_lib.h
@@ -220,7 +220,7 @@ struct GNUNET_STREAM_IOHandle;
  * @param timeout the timeout period
  * @param write_cont the function to call upon writing some bytes into the stream
  * @param write_cont_cls the closure
- * @return handle to cancel the operation
+ * @return handle to cancel the operation; NULL if a previous write is pending
  */
 struct GNUNET_STREAM_IOHandle *
 GNUNET_STREAM_write (struct GNUNET_STREAM_Socket *socket,