rename doc macros

This commit is contained in:
2021-08-04 16:31:32 +03:00
parent 0c7ce272e6
commit 25def958a1
140 changed files with 963 additions and 983 deletions

View File

@@ -1,5 +1,5 @@
/*! \file pispinlock.h
* \brief PISpinlock
/*! @file pispinlock.h
* @brief PISpinlock
*/
/*
PIP - Platform Independent Primitives
@@ -39,12 +39,12 @@ public:
~PISpinlock() {}
//! \brief Lock spinlock
//! @brief Lock spinlock
//! \details If spinlock is unlocked it set to locked state and returns immediate.
//! If spinlock is already locked function blocks until spinlock will be unlocked
void lock() {while (flag.test_and_set(std::memory_order_acquire));}
//! \brief Unlock spinlock
//! @brief Unlock spinlock
//! \details In any case this function returns immediate
void unlock() {flag.clear(std::memory_order_release);}
@@ -54,7 +54,7 @@ private:
};
//! \brief PISpinlockLocker
//! @brief PISpinlockLocker
//! \details
//! When a PISpinlockLocker object is created, it attempts to lock the spinlock it is given, if "condition" true.
//! When control leaves the scope in which the PISpinlockLocker object was created,