[vlc-commits] https: move some documentation to header file

[Rémi Denis-Courmont]

vlc | branch: master | Rémi Denis-Courmont <remi at remlab.net> | Wed Dec 16 18:23:26 2015 +0200| [8c490ccff63938cf2965bd9b55085422d3feaa83] | committer: Rémi Denis-Courmont

https: move some documentation to header file

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

 modules/access/http/transport.c |   12 ------------
 modules/access/http/transport.h |   15 +++++++++++++++
 2 files changed, 15 insertions(+), 12 deletions(-)

diff --git a/modules/access/http/transport.c b/modules/access/http/transport.c
index 2f70dd4..c6bfeea 100644
--- a/modules/access/http/transport.c
+++ b/modules/access/http/transport.c
@@ -36,13 +36,6 @@
 
 #include "transport.h"
 
-/**
- * Receives TLS data.
- *
- * Receives bytes from the peer through a TLS session.
- * @note This may be a cancellation point.
- * The caller is responsible for serializing reads on a given connection.
- */
 ssize_t vlc_https_recv(vlc_tls_t *tls, void *buf, size_t len)
 {
     struct pollfd ufd;
@@ -99,11 +92,6 @@ ssize_t vlc_http_recv(int fd, void *buf, size_t len)
     return count;
 }
 
-/**
- * Sends bytes to a connection.
- * @note This may be a cancellation point.
- * The caller is responsible for serializing writes on a given connection.
- */
 ssize_t vlc_https_send(vlc_tls_t *tls, const void *buf, size_t len)
 {
     struct pollfd ufd;
diff --git a/modules/access/http/transport.h b/modules/access/http/transport.h
index 9873aae..9f57785 100644
--- a/modules/access/http/transport.h
+++ b/modules/access/http/transport.h
@@ -28,8 +28,23 @@ struct vlc_tls;
 struct vlc_tls_creds;
 
 ssize_t vlc_http_recv(int fd, void *buf, size_t len);
+
+/**
+ * Receives TLS data.
+ *
+ * Receives bytes from the peer through a TLS session.
+ * @note This may be a cancellation point.
+ * The caller is responsible for serializing reads on a given connection.
+ */
 ssize_t vlc_https_recv(struct vlc_tls *tls, void *buf, size_t len);
+
 ssize_t vlc_http_send(int fd, const void *buf, size_t len);
+
+/**
+ * Sends bytes to a connection.
+ * @note This may be a cancellation point.
+ * The caller is responsible for serializing writes on a given connection.
+ */
 ssize_t vlc_https_send(struct vlc_tls *tls, const void *buf, size_t len);
 
 struct vlc_tls *vlc_https_connect(struct vlc_tls_creds *creds,