From: Marc Schink <redacted>
Date: Wed, 20 Mar 2024 08:12:24 +0000 (+0100)
Subject: tcp: Fix documentation of sr_tcp_dev_inst_free()
X-Git-Url: https://sigrok.org/gitaction?a=commitdiff_plain;h=839607fbb2a2dc617fd1ee50d54390ad72029555;p=libsigrok.git

tcp: Fix documentation of sr_tcp_dev_inst_free()

Signed-off-by: Marc Schink <redacted>
---

diff --git a/src/tcp.c b/src/tcp.c
index 0870420c..3a018c7c 100644
--- 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
  */