updated docs

256dpi · Feb 5, 2023 · e37ed1d · e37ed1d
1 parent fa0840d
commit e37ed1d
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/include/lwmqtt.h b/include/lwmqtt.h
@@ -294,7 +294,8 @@ void lwmqtt_set_callback(lwmqtt_client_t *client, void *ref, lwmqtt_callback_t c
 void lwmqtt_drop_overflow(lwmqtt_client_t *client, bool enabled, uint32_t *counter);
 
 /**
- * Will send a connect packet and wait for a connack response and set the return code.
+ * Will send a connect packet and wait for a connack response. If options are provided they are used for the
+ * connection attempt and the return code and whether a session was present is stored in it.
  *
  * The network object must already be connected to the server. An error is returned if the broker rejects the
  * connection.