GUACAMOLE-337: Document that socket-ssl.h is not guaranteed to be present.
Project: http://git-wip-us.apache.org/repos/asf/incubator-guacamole-server/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-guacamole-server/commit/60141175 Tree: http://git-wip-us.apache.org/repos/asf/incubator-guacamole-server/tree/60141175 Diff: http://git-wip-us.apache.org/repos/asf/incubator-guacamole-server/diff/60141175 Branch: refs/heads/master Commit: 60141175ddb2a7ced91a154232eca314efdf8a2d Parents: f504b1a Author: Michael Jumper <[email protected]> Authored: Sat Jul 1 18:55:20 2017 -0700 Committer: Michael Jumper <[email protected]> Committed: Sat Jul 1 18:55:20 2017 -0700 ---------------------------------------------------------------------- src/libguac/guacamole/socket-ssl.h | 7 +++++++ 1 file changed, 7 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-guacamole-server/blob/60141175/src/libguac/guacamole/socket-ssl.h ---------------------------------------------------------------------- diff --git a/src/libguac/guacamole/socket-ssl.h b/src/libguac/guacamole/socket-ssl.h index c7a14df..7c72695 100644 --- 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>
