Skip to content

Commit 85695ce

Browse files
jaredponnAshish285
authored andcommitted
fix(esp_tls_conn_new_sync): Fix esp_tls_conn_new_sync's doc to reflect its implementation
Closes espressif#17652 Closes espressif#17598
1 parent 8574a0a commit 85695ce

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

components/esp-tls/esp_tls.h

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -396,10 +396,12 @@ esp_tls_t *esp_tls_conn_http_new(const char *url, const esp_tls_cfg_t *cfg) __at
396396
* @param[in] hostname Hostname of the host.
397397
* @param[in] hostlen Length of hostname.
398398
* @param[in] port Port number of the host.
399-
* @param[in] cfg TLS configuration as esp_tls_cfg_t. If you wish to open
400-
* non-TLS connection, keep this NULL. For TLS connection,
401-
* a pass pointer to esp_tls_cfg_t. At a minimum, this
402-
* structure should be zero-initialized.
399+
* @param[in] cfg TLS configuration as esp_tls_cfg_t. For a TLS
400+
* connection, pass a pointer to a esp_tls_cfg_t. For a
401+
* plain TCP connection, pass a pointer to a
402+
* esp_tls_cfg_t with is_plain_tcp set to true. At a
403+
* minimum, this pointer should be not NULL and the
404+
* structure should be zero-initialized
403405
* @param[in] tls Pointer to esp-tls as esp-tls handle.
404406
*
405407
* @return

0 commit comments

Comments
 (0)