mutex: added additional docstrings

This commit is contained in:
bunnei 2014-05-26 22:47:47 -04:00
parent a432dc8f39
commit 93cd5a0691

View file

@ -13,6 +13,7 @@ namespace Kernel {
/** /**
* Releases a mutex * Releases a mutex
* @param handle Handle to mutex to release * @param handle Handle to mutex to release
* @return Result of operation, 0 on success, otherwise error code
*/ */
Result ReleaseMutex(Handle handle); Result ReleaseMutex(Handle handle);
@ -20,6 +21,7 @@ Result ReleaseMutex(Handle handle);
* Creates a mutex * Creates a mutex
* @param handle Reference to handle for the newly created mutex * @param handle Reference to handle for the newly created mutex
* @param initial_locked Specifies if the mutex should be locked initially * @param initial_locked Specifies if the mutex should be locked initially
* @return Handle to newly created object
*/ */
Handle CreateMutex(bool initial_locked); Handle CreateMutex(bool initial_locked);