Add documentation

This commit is contained in:
Henrik Stickann
2022-04-12 16:33:10 +02:00
parent f09f580f00
commit ccb15a640e
2 changed files with 18 additions and 2 deletions

View File

@@ -1,3 +1,8 @@
/**
* @brief Atomic mutex implementation.
*
* Define **STA_ATOMIC_ENABLE** to enable module.
*/
#ifndef STA_ATOMIC_MUTEX_HPP
#define STA_ATOMIC_MUTEX_HPP
@@ -11,6 +16,9 @@
namespace sta
{
/**
* @brief Implementation of `Mutex` interface using `std::atomic_flag`.
*/
class AtomicMutex : public Mutex
{
public:
@@ -20,7 +28,7 @@ namespace sta
void release() override;
private:
std::atomic_flag lock_;
std::atomic_flag lock_; /**< Atomic flag used as lock */
};
} // namespace sta