net_Write: improve documentation

diff --git a/src/network/io.c b/src/network/io.c
index 217d971f1f6fa01670f481f4170addb4635622f3..ab72ebae5dddf4edd52626a06ace90dd6e8efa37 100644 (file)
--- a/src/network/io.c
+++ b/src/network/io.c
@@ -409,7 +409,16 @@ silent:
 }
 
 #undef net_Write
-/* Write exact amount requested */
+/**
+ * Writes data to a file descriptor.
+ * This blocks until all data is written or an error occurs.
+ *
+ * This function is a cancellation point if p_vs is NULL.
+ * This function is not cancellation-safe if p_vs is not NULL.
+ *
+ * @return the total number of bytes written, or -1 if an error occurs
+ * before any data is written.
+ */
 ssize_t net_Write( vlc_object_t *p_this, int fd, const v_socket_t *p_vs,
                    const void *restrict p_data, size_t i_data )
 {