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 <[email protected]>
nrfconnect · Dec 11, 2024 · baaa9aa · baaa9aa
1 parent ffa08e9
commit baaa9aa
Showing 1 changed file with 2 additions and 0 deletions.
diff --git 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);