summaryrefslogtreecommitdiff
path: root/include/osl/mutex.h
diff options
context:
space:
mode:
authorChris Sherlock <chris.sherlock79@gmail.com>2017-06-23 06:08:00 +1000
committerChris Sherlock <chris.sherlock79@gmail.com>2017-06-23 06:28:04 +1000
commitba4831629e93bd6957ed8cfce9cec25f4f8ce5e4 (patch)
tree9d5f6c7d6841290529cbe7356e319e09e1da9929 /include/osl/mutex.h
parent2b88f432f14e617ad27e6a3f560f85c18603697a (diff)
osl: doxygen fixes for headers
Change-Id: I3f30b5ab985c2ff709116568905b941c5d50fd1a
Diffstat (limited to 'include/osl/mutex.h')
-rw-r--r--include/osl/mutex.h6
1 files changed, 6 insertions, 0 deletions
diff --git a/include/osl/mutex.h b/include/osl/mutex.h
index 6cbfba15f026..8761f33737f7 100644
--- a/include/osl/mutex.h
+++ b/include/osl/mutex.h
@@ -33,11 +33,13 @@ struct _oslMutexImpl;
typedef struct _oslMutexImpl * oslMutex;
/** Create a mutex.
+
@return 0 if the mutex could not be created, otherwise a handle to the mutex.
*/
SAL_DLLPUBLIC oslMutex SAL_CALL osl_createMutex(void);
/** Release the OS-structures and free mutex data-structure.
+
@param Mutex the mutex-handle
*/
SAL_DLLPUBLIC void SAL_CALL osl_destroyMutex(oslMutex Mutex);
@@ -49,18 +51,22 @@ SAL_DLLPUBLIC void SAL_CALL osl_destroyMutex(oslMutex Mutex);
SAL_DLLPUBLIC sal_Bool SAL_CALL osl_acquireMutex(oslMutex Mutex);
/** Try to acquire the mutex without blocking.
+
@param Mutex handle to a created mutex.
+
@retval False if it could not be acquired.
*/
SAL_DLLPUBLIC sal_Bool SAL_CALL osl_tryToAcquireMutex(oslMutex Mutex);
/** Release the mutex.
+
@param Mutex handle to a created mutex.
@retval False if system-call fails.
*/
SAL_DLLPUBLIC sal_Bool SAL_CALL osl_releaseMutex(oslMutex Mutex);
/** Returns a unique and global mutex.
+
@return the global mutex.
*/
SAL_DLLPUBLIC oslMutex * SAL_CALL osl_getGlobalMutex(void);