final update to documentation before version release

This commit is contained in:
Noah Laptop 2019-08-14 11:19:56 -07:00
parent 26e054bd76
commit c157c00f69
3 changed files with 22 additions and 18 deletions

View file

@ -292,7 +292,10 @@ public:
/**
* @brief Add a client certificate and enable support for mutual auth
*
* This function must be called BEFORE making an SSL connection.
* Please ensure that the values in `params` are valid for the lifetime
* of SSLClient. You may want to make them global constants.
*
* @pre SSLClient has not already started an SSL connection.
*/
void setMutualAuthParams(const SSLClientParameters* params) { return set_mutual_impl(params); }