From f4ed1aa1362278d7cf6ab02909e0d7f9b945d567 Mon Sep 17 00:00:00 2001
From: Stephen Seo <seo.disparate@gmail.com>
Date: Mon, 1 Jan 2024 12:25:04 +0900
Subject: [PATCH] Note in documentation about thread safety

Basically, all functions should be thread-safe unless mentioned
otherwise.
---
 src/UDPC.h | 11 +++--------
 1 file changed, 3 insertions(+), 8 deletions(-)

diff --git a/src/UDPC.h b/src/UDPC.h
index 81c985b..fca1b6c 100644
--- a/src/UDPC.h
+++ b/src/UDPC.h
@@ -6,6 +6,9 @@
 /*!
  * \file UDPC.h
  * \brief Public API for UDPConnection
+ *
+ * Note that all functions are thread-safe unless mentioned otherwise in the
+ * function's documentation.
  */
 
 #ifndef UDPC_CONNECTION_H
@@ -861,8 +864,6 @@ UDPC_EXPORT const char *UDPC_atostr(UDPC_HContext ctx, UDPC_IPV6_ADDR_TYPE addr)
  * \warning The returned pointer must be freed with free(), or
  * UDPC_atostr_unsafe_free(), or UDPC_atostr_unsafe_free_ptr().
  *
- * This function is thread-safe.
- *
  * UDPC internally uses UDPC_atostr() for logging. This means that while UDPC
  * is running, a string created with UDPC_atostr() may be overwritten
  * eventually by UDPC. To avoid this situation, UDPC_atostr_unsafe() or
@@ -879,8 +880,6 @@ UDPC_EXPORT const char *UDPC_atostr_unsafe(UDPC_IPV6_ADDR_TYPE addr);
  * \warning The returned pointer must be freed with free(), or
  * UDPC_atostr_unsafe_free(), or UDPC_atostr_unsafe_free_ptr().
  *
- * This function is thread-safe.
- *
  * UDPC internally uses UDPC_atostr() for logging. This means that while UDPC
  * is running, a string created with UDPC_atostr() may be overwritten
  * eventually by UDPC. To avoid this situation, UDPC_atostr_unsafe() or
@@ -891,8 +890,6 @@ UDPC_EXPORT const char *UDPC_atostr_unsafe_cid(UDPC_ConnectionId cid);
 
 /*!
  * \brief Free an addr string created with UDPC_atostr_unsafe().
- *
- * This function is thread-safe.
  */
 UDPC_EXPORT void UDPC_atostr_unsafe_free(const char *addrBuf);
 
@@ -900,8 +897,6 @@ UDPC_EXPORT void UDPC_atostr_unsafe_free(const char *addrBuf);
  * \brief Free an addr string created with UDPC_atostr_unsafe() and zeroes the
  * pointer.
  *
- * This function is thread-safe.
- *
  * \code{.c}
  * UDPC_ConnectionId aConnectionId = ...;
  * const char *addrString = UDPC_atostr_unsafe_cid(aConnectionId);