Add api doc to _dbus_platform_c|rmutex_new()

The documentation has been added to the header to avoid duplication as
these functions are implemented platform specific.

Cherry-picked from merge request dbus/dbus!243

Reviewed-by: @smcv

Signed-off-by: Ralf Habacker <ralf.habacker@freenet.de>
This commit is contained in:
Ralf Habacker 2022-02-21 16:07:48 +01:00
parent 20f623c79b
commit 9b426c7916

View file

@ -73,11 +73,24 @@ void _dbus_condvar_free_at_location (DBusCondVar **location_p);
/* Private to threading implementations and dbus-threads.c */
/**
* Creates a new mutex which is recursive if possible
*
* This mutex is used to avoid deadlocking if we hold them while
* calling user code.
*
* @return mutex instance or #NULL on OOM
*/
DBusRMutex *_dbus_platform_rmutex_new (void);
void _dbus_platform_rmutex_free (DBusRMutex *mutex);
void _dbus_platform_rmutex_lock (DBusRMutex *mutex);
void _dbus_platform_rmutex_unlock (DBusRMutex *mutex);
/**
* Creates a new mutex suitable for use with condition variables
*
* @return mutex instance or #NULL on OOM
*/
DBusCMutex *_dbus_platform_cmutex_new (void);
void _dbus_platform_cmutex_free (DBusCMutex *mutex);
void _dbus_platform_cmutex_lock (DBusCMutex *mutex);