net: lib: mqtt_helper: Fix mqtt_helper_connect() documentation

jtguggedal · jukkar · commit baaa9aaa5523 · 2024-12-11T16:34:30.000+02:00
Add information about positive return value in case of DNS error.

Signed-off-by: Jan Tore Guggedal &lt;jantore.guggedal@nordicsemi.no&gt;
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);

Original file line number	Diff line number	Diff line change
`@@ -103,6 +103,8 @@ int mqtt_helper_init(struct mqtt_helper_cfg *cfg);`
`103`	`103`	`*`
`104`	`104`	`* @retval 0 if successful.`
`105`	`105`	`* @retval -EOPNOTSUPP if operation is not supported in the current state.`
	`106`	+ * @return A positive error code in case of DNS error, corresponding to ``getaddrinfo()`` return
	`107`	`+ * values.`
`106`	`108`	`* @return Otherwise a negative error code.`
`107`	`109`	`*/`
`108`	`110`	`int mqtt_helper_connect(struct mqtt_helper_conn_params *conn_params);`