[vlc-commits] tls: fix documentation to match reality

[Rémi Denis-Courmont]

vlc | branch: master | Rémi Denis-Courmont <remi at remlab.net> | Wed Jan 13 19:04:42 2016 +0200| [6f79b0b0a63514cab9fa093e6dfaba3b2f8cbbb3] | committer: Rémi Denis-Courmont

tls: fix documentation to match reality

Anonymous key exchange is not supported currently.

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

 include/vlc_tls.h |    7 +++----
 1 file changed, 3 insertions(+), 4 deletions(-)

diff --git a/include/vlc_tls.h b/include/vlc_tls.h
index 9807975..02e3c18 100644
--- a/include/vlc_tls.h
+++ b/include/vlc_tls.h
@@ -168,10 +168,9 @@ VLC_API vlc_tls_creds_t *vlc_tls_ClientCreate (vlc_object_t *);
 /**
  * Allocates server TLS credentials.
  *
- * @param cert required (Unicode) path to an x509 certificate,
- *             if NULL, anonymous key exchange will be used.
- * @param key (UTF-8) path to the PKCS private key for the certificate,
- *            if NULL; cert will be used.
+ * @param cert path to an x509 certificate (required)
+ * @param key path to the PKCS private key for the certificate,
+ *            or NULL to use cert path
  *
  * @return TLS credentials object, or NULL on error.
  */