Aksal/nuttx
3
1
Fork 1
mirror of https://github.com/apache/nuttx.git synced 2026-08-01 20:28:58 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

nuttx/mutex: correct documentation for nxmutex_destroy

Browse source 
Correct and clarify the documentation note for nxmutex_destroy function
to properly document behavior and safety considerations in OS context.

Signed-off-by: makejian <makejian@xiaomi.com>
This commit is contained in:
makejian 2025-08-04 16:34:21 +08:00 • committed by GUIDINGLI
parent e074c865bc
commit 35886c18ab
1 changed files with 4 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

8
include/nuttx/mutex.h
View file

@ -461,10 +461,10 @@ static inline_function bool nxmutex_is_locked(FAR mutex_t *mutex)
* Name: nxmutex_destroy
*
* Description:
* This function initializes the UNNAMED mutex. Following a
* successful call to nxmutex_init(), the mutex may be used in subsequent
* calls to nxmutex_lock(), nxmutex_unlock(), and nxmutex_trylock(). The
* mutex remains usable until it is destroyed.
* This function destroys the specified mutex. After a successful call,
* the mutex is no longer valid and must not be used in subsequent calls
* to nxmutex_lock(), nxmutex_unlock(), or nxmutex_trylock() unless it is
* reinitialized with nxmutex_init().
*
* Parameters:
* mutex - Semaphore to be destroyed