rename doc macros
This commit is contained in:
@@ -1,5 +1,5 @@
|
||||
/*! \file pimutex.h
|
||||
* \brief PIMutex, PIMutexLocker
|
||||
/*! @file pimutex.h
|
||||
* @brief PIMutex, PIMutexLocker
|
||||
*/
|
||||
/*
|
||||
PIP - Platform Independent Primitives
|
||||
@@ -39,16 +39,16 @@ public:
|
||||
~PIMutex();
|
||||
|
||||
|
||||
//! \brief Lock mutex
|
||||
//! @brief Lock mutex
|
||||
//! \details If mutex is unlocked it set to locked state and returns immediate.
|
||||
//! If mutex is already locked function blocks until mutex will be unlocked
|
||||
void lock();
|
||||
|
||||
//! \brief Unlock mutex
|
||||
//! @brief Unlock mutex
|
||||
//! \details In any case this function returns immediate
|
||||
void unlock() ;
|
||||
|
||||
//! \brief Try to lock mutex
|
||||
//! @brief Try to lock mutex
|
||||
//! \details If mutex is unlocked it set to locked state and returns "true" immediate.
|
||||
//! If mutex is already locked function returns immediate an returns "false"
|
||||
bool tryLock();
|
||||
@@ -64,7 +64,7 @@ private:
|
||||
};
|
||||
|
||||
|
||||
//! \brief PIMutexLocker
|
||||
//! @brief PIMutexLocker
|
||||
//! \details Same as std::lock_guard<std::mutex>.
|
||||
//! When a PIMutexLocker object is created, it attempts to lock the mutex it is given, if "condition" true.
|
||||
//! When control leaves the scope in which the PIMutexLocker object was created,
|
||||
|
||||
Reference in New Issue
Block a user