]> sigrok.org Git - libsigrok.git/commitdiff
tcp: Fix documentation of sr_tcp_dev_inst_free()
authorMarc Schink <redacted>
Wed, 20 Mar 2024 08:12:24 +0000 (09:12 +0100)
committerSoeren Apel <redacted>
Sat, 17 Aug 2024 20:59:47 +0000 (22:59 +0200)
Signed-off-by: Marc Schink <redacted>
src/tcp.c

index 0870420ced51f540d3bb672d6620ce62f65883fe..3a018c7c6f3cbd48c63318f906412a1d3b833018 100644 (file)
--- a/src/tcp.c
+++ b/src/tcp.c
@@ -150,10 +150,8 @@ SR_PRIV struct sr_tcp_dev_inst *sr_tcp_dev_inst_new(
 /**
  * Release a TCP communication instance.
  *
- * @param[in] host_addr The host name or IP address (a string).
- * @param[in] tcp_port The TCP port number.
- *
- * @return A @ref sr_tcp_dev_inst structure on success. #NULL otherwise.
+ * @param[in] tcp TCP connection instance to free. If NULL, the function will do
+ *                nothing.
  *
  * @since 6.0
  */