diff options
| author | Jonathan Wakely <jwakely@redhat.com> | 2019-05-02 16:46:42 +0100 |
|---|---|---|
| committer | Jonathan Wakely <redi@gcc.gnu.org> | 2019-05-02 16:46:42 +0100 |
| commit | 725708ab752d707937ee26a710235ed45dd4cdd4 (patch) | |
| tree | 8c83dec350e2064b89a8d678cec53e0333a1c3f1 /libstdc++-v3/include/std/shared_mutex | |
| parent | d727fdc42bbf1ea23bfda42b9c0c87c2cb8e93b9 (diff) | |
| download | gcc-725708ab752d707937ee26a710235ed45dd4cdd4.zip gcc-725708ab752d707937ee26a710235ed45dd4cdd4.tar.gz gcc-725708ab752d707937ee26a710235ed45dd4cdd4.tar.bz2 | |
Improve docs for mutexes
* include/bits/unique_lock.h: Fix/improve doxygen markup.
* include/std/mutex: Likewise.
* include/std/shared_mutex: Likewise.
From-SVN: r270812
Diffstat (limited to 'libstdc++-v3/include/std/shared_mutex')
| -rw-r--r-- | libstdc++-v3/include/std/shared_mutex | 8 |
1 files changed, 7 insertions, 1 deletions
diff --git a/libstdc++-v3/include/std/shared_mutex b/libstdc++-v3/include/std/shared_mutex index be64144..ffd93fb 100644 --- a/libstdc++-v3/include/std/shared_mutex +++ b/libstdc++-v3/include/std/shared_mutex @@ -42,7 +42,7 @@ namespace std _GLIBCXX_VISIBILITY(default) _GLIBCXX_BEGIN_NAMESPACE_VERSION /** - * @ingroup mutexes + * @addtogroup mutexes * @{ */ @@ -56,6 +56,8 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION #define __cpp_lib_shared_timed_mutex 201402 class shared_timed_mutex; + /// @cond undocumented + #if _GLIBCXX_USE_PTHREAD_RWLOCK_T #ifdef __gthrw #define _GLIBCXX_GTHRW(name) \ @@ -395,6 +397,7 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION } }; #endif + /// @endcond #if __cplusplus > 201402L /// The standard shared mutex type. @@ -432,11 +435,13 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION }; #endif // C++17 + /// @cond undocumented #if _GLIBCXX_USE_PTHREAD_RWLOCK_T && _GTHREAD_USE_MUTEX_TIMEDLOCK using __shared_timed_mutex_base = __shared_mutex_pthread; #else using __shared_timed_mutex_base = __shared_mutex_cv; #endif + /// @endcond /// The standard shared timed mutex type. class shared_timed_mutex @@ -754,6 +759,7 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION }; /// Swap specialization for shared_lock + /// @relates shared_mutex template<typename _Mutex> void swap(shared_lock<_Mutex>& __x, shared_lock<_Mutex>& __y) noexcept |