Add note in docs about update for UDPC_init(...)

diff --git a/src/UDPC.h b/src/UDPC.h
index 7c73d4f987f5c3b567891e62a4a37647b62b9793..7c87c69fb331b8b4ce959a38cc688bf1f6762143 100644 (file)
--- a/src/UDPC.h
+++ b/src/UDPC.h
@@ -323,6 +323,12 @@ UDPC_EXPORT UDPC_ConnectionId UDPC_create_id_hostname(const char *hostname, uint
  *
  * \warning The received UDPC_HContext must be freed with a call to UDPC_destroy().
  *
+ * \note This function creates a context that does not use a separate thread to
+ * call update periodically. You must call \ref UDPC_update() periodically,
+ * enable threaded update with \ref UDPC_enable_threaded_update or \ref
+ * UDPC_enable_threaded_update_ms, or use \ref UDPC_init_threaded_update or
+ * \ref UDPC_init_threaded_update_ms instead of \ref UDPC_init .
+ *
  * \return A UDPC context
  */
 UDPC_EXPORT UDPC_HContext UDPC_init(UDPC_ConnectionId listenId, int isClient, int isUsingLibsodium);