[vlc-devel] commit: net_Write: improve documentation ( Rémi Denis-Courmont )

[git version control]

vlc | branch: master | Rémi Denis-Courmont <remi at remlab.net> | Sun Feb 14 17:10:05 2010 +0200| [5a5cbadd836de42cb1655e65e2353edfd9241db1] | committer: Rémi Denis-Courmont 

net_Write: improve documentation

> http://git.videolan.org/gitweb.cgi/vlc.git/?a=commit;h=5a5cbadd836de42cb1655e65e2353edfd9241db1
---

 src/network/io.c |   11 ++++++++++-
 1 files changed, 10 insertions(+), 1 deletions(-)

diff --git a/src/network/io.c b/src/network/io.c
index 217d971..ab72eba 100644
--- 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 )
 {