GUACAMOLE-337: Document that socket-ssl.h is not guaranteed to be present.

2017-07-01 18:55:20 -07:00 · 2017-07-01 18:55:20 -07:00 · 60141175dd
commit 60141175dd
parent f504b1a5e8
1 changed files with 7 additions and 0 deletions
--- a/src/libguac/guacamole/socket-ssl.h
+++ b/src/libguac/guacamole/socket-ssl.h
@ -21,6 +21,13 @@
 #ifndef __GUACD_SOCKET_SSL_H
 #define __GUACD_SOCKET_SSL_H

+/**
+ * Provides an SSL/TLS implementation of guac_socket. This header will only be
+ * available if libguac was built with SSL support.
+ *
+ * @file socket-ssl.h
+ */
+
 #include "socket-types.h"

 #include <openssl/ssl.h>