[vlc-commits] tls: document vlc_tls_SocketOpenTCP parameters

[Rémi Denis-Courmont]

vlc | branch: master | Rémi Denis-Courmont <remi at remlab.net> | Sat Dec 12 15:11:04 2020 +0200| [8b71a40554d0cf57ba59cbc61c502287296fcb92] | committer: Rémi Denis-Courmont

tls: document vlc_tls_SocketOpenTCP parameters

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

 include/vlc_tls.h | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/include/vlc_tls.h b/include/vlc_tls.h
index 18dbcd09ec..976e670d05 100644
--- a/include/vlc_tls.h
+++ b/include/vlc_tls.h
@@ -457,6 +457,10 @@ VLC_API vlc_tls_t *vlc_tls_SocketOpenAddrInfo(const struct addrinfo *ai,
  * This function resolves a hostname, and attempts to establish a TCP/IP
  * connection to the specified host and port number.
  *
+ * @param obj optional object to log errors (may be NULL)
+ * @param hostname remote host name or IP address literal to connect to
+ * @param port remote TCP port number to connect to
+ *
  * @note The function currently iterates through the addrinfo linked list.
  * Future versions may implement different behaviour (e.g. RFC6555).
  *