From baaa9aaa55239a0b36ac27f2f3a6a11eb3692f8b Mon Sep 17 00:00:00 2001 From: Jan Tore Guggedal Date: Wed, 11 Dec 2024 08:19:30 +0100 Subject: [PATCH] net: lib: mqtt_helper: Fix mqtt_helper_connect() documentation Add information about positive return value in case of DNS error. Signed-off-by: Jan Tore Guggedal --- include/net/mqtt_helper.h | 2 ++ 1 file changed, 2 insertions(+) diff --git a/include/net/mqtt_helper.h b/include/net/mqtt_helper.h index 42d61d64b0e8..7a91f3133e5c 100644 --- a/include/net/mqtt_helper.h +++ b/include/net/mqtt_helper.h @@ -103,6 +103,8 @@ int mqtt_helper_init(struct mqtt_helper_cfg *cfg); * * @retval 0 if successful. * @retval -EOPNOTSUPP if operation is not supported in the current state. + * @return A positive error code in case of DNS error, corresponding to ``getaddrinfo()`` return + * values. * @return Otherwise a negative error code. */ int mqtt_helper_connect(struct mqtt_helper_conn_params *conn_params);