Add note in docs about update for UDPC_init(...)
All checks were successful
Publish doxygen documentation to seodisparate.com / doxygen-gen-and-publish (push) Successful in 0s
All checks were successful
Publish doxygen documentation to seodisparate.com / doxygen-gen-and-publish (push) Successful in 0s
This commit is contained in:
parent
894a564774
commit
02651c793e
1 changed files with 6 additions and 0 deletions
|
@ -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);
|
||||
|
|
Loading…
Reference in a new issue