[#1661] Extended HandshakeHandler description

diff --git a/src/lib/http/client.h b/src/lib/http/client.h
index 20ec30947e39b7aea75576a3496cd177d543b86c..f4eeb18eb1c7ebd258414dbc4d565b2c2a1952ad 100644 (file)
--- a/src/lib/http/client.h
+++ b/src/lib/http/client.h
@@ -104,6 +104,11 @@ public:
     /// @brief Optional handler invoked when client performs the TLS handshake
     /// with the server.
     ///
+    /// It is called when the TLS handshake completes:
+    /// - if the handshake succeeds it is called with error code 0
+    /// - if the handshake fails it is called with error code != 0
+    /// - if TLS is not enabled, it is not called at all
+    ///
     /// Returned boolean value indicates whether the client should continue
     /// connecting to the server (if true) or not (false).
     /// @note The second argument is not used.