Merge branch 'bugfix/tcp_transport_documentation' into 'master'

tcp_transport: Fix documentation for connect functions

See merge request espressif/esp-idf!17270

components/tcp_transport/include/esp_transport.h

@@ -1,16 +1,8 @@
-// Copyright 2015-2018 Espressif Systems (Shanghai) PTE LTD
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-
-//     http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
+/*
+ * SPDX-FileCopyrightText: 2015-2022 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
 
 #ifndef _ESP_TRANSPORT_H_
 #define _ESP_TRANSPORT_H_
@@ -146,7 +138,7 @@ esp_err_t esp_transport_set_default_port(esp_transport_handle_t t, int port);
  * @param[in]  timeout_ms  The timeout milliseconds (-1 indicates wait forever)
  *
  * @return
- * - socket for will use by this transport
+ * - 0 in case of successful connection
  * - (-1) if there are any errors, should check errno
  */
 int esp_transport_connect(esp_transport_handle_t t, const char *host, int port, int timeout_ms);
@@ -160,8 +152,10 @@ int esp_transport_connect(esp_transport_handle_t t, const char *host, int port,
  * @param[in]  timeout_ms  The timeout milliseconds (-1 indicates wait forever)
  *
  * @return
- * - socket for will use by this transport
- * - (-1) if there are any errors, should check errno
+ *             - -1      If connection establishment fails.
+ *             -  0      If connection establishment is in progress.
+ *             -  1      If connection establishment is successful.
+ *
  */
 int esp_transport_connect_async(esp_transport_handle_t t, const char *host, int port, int timeout_ms);
 

tools/ci/check_copyright_ignore.txt

@@ -1611,7 +1611,6 @@ components/spi_flash/test/test_out_of_bounds_write.c
 components/spi_flash/test/test_partition_ext.c
 components/spi_flash/test/test_partitions.c
 components/spi_flash/test/test_spi_flash.c
-components/tcp_transport/include/esp_transport.h
 components/tcp_transport/include/esp_transport_ssl.h
 components/tcp_transport/include/esp_transport_tcp.h
 components/tcp_transport/include/esp_transport_ws.h