From b5b234fab2f12417aab848463e14bee0fda02791 Mon Sep 17 00:00:00 2001
From: Sergey Lyubka <valenok@gmail.com>
Date: Sun, 19 May 2013 08:00:12 +0100
Subject: [PATCH] Improved docstring for mg_read()

---
 mongoose.h | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/mongoose.h b/mongoose.h
index 60cfc3c2c..58e484b08 100644
--- a/mongoose.h
+++ b/mongoose.h
@@ -239,6 +239,10 @@ void mg_send_file(struct mg_connection *conn, const char *path);
 
 
 // Read data from the remote end, return number of bytes read.
+// Return:
+//   0     connection has been closed by peer. No more data could be read.
+//   < 0   read error. No more data could be read from the connection.
+//   > 0   number of bytes read into the buffer.
 int mg_read(struct mg_connection *, void *buf, size_t len);
 
 
-- 
GitLab