aboutsummaryrefslogtreecommitdiff
path: root/support/Mutex.h
diff options
context:
space:
mode:
authorAlex Gilday <alexander.gilday@arm.com>2018-03-21 13:54:09 +0000
committerAnthony Barbier <anthony.barbier@arm.com>2018-11-02 16:49:16 +0000
commitc357c47be8a3f210f9eee9a05cc13f1051b036d3 (patch)
treea88ac857150da970a0862a3479b78c616d8aa1d3 /support/Mutex.h
parent724079d6fce3bf6a05cd6c7b4884b132b27e9e90 (diff)
downloadComputeLibrary-c357c47be8a3f210f9eee9a05cc13f1051b036d3.tar.gz
COMPMID-1008: Fix Doxygen issues
Change-Id: Ie73d8771f85d1f5b059f3a56f1bbd73c98e94a38 Reviewed-on: https://eu-gerrit-1.euhpc.arm.com/124723 Reviewed-by: Michalis Spyrou <michalis.spyrou@arm.com> Tested-by: Jenkins <bsgcomp@arm.com>
Diffstat (limited to 'support/Mutex.h')
-rw-r--r--support/Mutex.h12
1 files changed, 10 insertions, 2 deletions
diff --git a/support/Mutex.h b/support/Mutex.h
index 6d0a387678..d70dd7595b 100644
--- a/support/Mutex.h
+++ b/support/Mutex.h
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2017 ARM Limited.
+ * Copyright (c) 2017-2018 ARM Limited.
*
* SPDX-License-Identifier: MIT
*
@@ -29,6 +29,7 @@
namespace arm_compute
{
#ifndef NO_MULTI_THREADING
+/** Wrapper of Mutex data-object */
using Mutex = std::mutex;
#else /* NO_MULTI_THREADING */
/** Wrapper implementation of Mutex data-object */
@@ -36,13 +37,20 @@ class Mutex
{
public:
/** Default constructor */
- Mutex() = default;
+ Mutex() = default;
+ /** Default destructor */
~Mutex() = default;
+ /** Lock */
void lock() {};
+ /** Unlock */
void unlock() {};
+ /** Try the lock.
+ *
+ * @return true.
+ */
bool try_lock()
{
return true;