iochannel: Document modified pa_iochannel_write return value

diff --git a/src/pulsecore/iochannel.h b/src/pulsecore/iochannel.h
index f809f473e61e1ed58e172678427f262bb69d9551..ee3cd67d7cd97d202c4c68b5ec0079a0459ee614 100644 (file)
--- a/src/pulsecore/iochannel.h
+++ b/src/pulsecore/iochannel.h
@@ -48,6 +48,8 @@ channel specify -1 for the other direction. */
 pa_iochannel* pa_iochannel_new(pa_mainloop_api*m, int ifd, int ofd);
 void pa_iochannel_free(pa_iochannel*io);
 
+/* Returns: length written on success, 0 if a retry is needed, negative value
+ * on error. */
 ssize_t pa_iochannel_write(pa_iochannel*io, const void*data, size_t l);
 ssize_t pa_iochannel_read(pa_iochannel*io, void*data, size_t l);