Skip to content
This repository was archived by the owner on Mar 22, 2023. It is now read-only.

Commit a34da91

Browse files
author
Pawel Karczewski
committed
[doc] Add links to cpprefenence in synchronization primitives
1 parent 9a64acf commit a34da91

File tree

4 files changed

+15
-11
lines changed

4 files changed

+15
-11
lines changed

include/libpmemobj++/condition_variable.hpp

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,9 @@ namespace obj
2626
* Persistent memory resident condition variable.
2727
*
2828
* This class is an implementation of a PMEM-resident condition
29-
* variable which mimics in behavior the C++11 std::condition_variable. The
30-
* typical usage example would be:
29+
* variable which mimics in behavior the C++11
30+
* [std::condition_variable](https://en.cppreference.com/w/cpp/thread/condition_variable).
31+
* The typical usage example would be:
3132
* @snippet mutex/mutex.cpp cond_var_example
3233
* @ingroup synchronization
3334
*/

include/libpmemobj++/mutex.hpp

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,10 @@ namespace obj
2323
* Persistent memory resident mutex implementation.
2424
*
2525
* This class is an implementation of a PMEM-resident mutex
26-
* which mimics in behavior the C++11 std::mutex. This class
27-
* satisfies all requirements of the Mutex and StandardLayoutType
28-
* concepts. The typical usage example would be:
26+
* which mimics in behavior the C++11
27+
* [std::mutex](https://en.cppreference.com/w/cpp/thread/mutex). This class
28+
* satisfies all requirements of the Mutex and StandardLayoutType concepts. The
29+
* typical usage example would be:
2930
* @snippet mutex/mutex.cpp unique_guard_example
3031
* @ingroup synchronization
3132
*/

include/libpmemobj++/shared_mutex.hpp

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,10 @@ namespace obj
2222
* Persistent memory resident shared_mutex implementation.
2323
*
2424
* This class is an implementation of a PMEM-resident shared_mutex
25-
* which mimics in behavior the C++11 std::mutex. This class
26-
* satisfies all requirements of the SharedMutex and StandardLayoutType
27-
* concepts. The typical usage would be:
25+
* which mimics in behavior the C++11
26+
* [std::shared_mutex](https://en.cppreference.com/w/cpp/thread/shared_mutex).
27+
* This class satisfies all requirements of the SharedMutex and
28+
* StandardLayoutType concepts. The typical usage would be:
2829
* @snippet mutex/mutex.cpp shared_mutex_example
2930
* @ingroup synchronization
3031
*/

include/libpmemobj++/timed_mutex.hpp

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,10 @@ namespace obj
2424
* Persistent memory resident timed_mutex implementation.
2525
*
2626
* This class is an implementation of a PMEM-resident timed_mutex
27-
* which mimics in behavior the C++11 std::timed_mutex. This class
28-
* satisfies all requirements of the TimedMutex and StandardLayoutType
29-
* concepts. The typical usage example would be:
27+
* which mimics in behavior the C++11
28+
* [std::timed_mutex](https://en.cppreference.com/w/cpp/thread/timed_mutex).
29+
* This class satisfies all requirements of the TimedMutex and
30+
* StandardLayoutType concepts. The typical usage example would be:
3031
* @snippet mutex/mutex.cpp timed_mutex_example
3132
* @ingroup synchronization
3233
*/

0 commit comments

Comments
 (0)