Document local_shared_ptr::owner_equals

This commit is contained in:
Peter Dimov
2020-06-01 01:59:40 +03:00
parent 91f3aa0386
commit 6f5b9c7b37

View File

@@ -124,7 +124,7 @@ namespace boost {
template<class Y> void reset(local_shared_ptr<Y> && r, element_type * p) noexcept; template<class Y> void reset(local_shared_ptr<Y> && r, element_type * p) noexcept;
// accessors // accessors
T & operator*() const noexcept; // only valid when T is not an array type T & operator*() const noexcept; // only valid when T is not an array type
T * operator->() const noexcept; // only valid when T is not an array type T * operator->() const noexcept; // only valid when T is not an array type
@@ -143,12 +143,16 @@ namespace boost {
template<class Y> operator weak_ptr<Y>() const noexcept; template<class Y> operator weak_ptr<Y>() const noexcept;
// swap // swap
void swap(local_shared_ptr & b) noexcept; void swap(local_shared_ptr & b) noexcept;
// owner_before // owner_before
template<class Y> bool owner_before(local_shared_ptr<Y> const & rhs) const noexcept; template<class Y> bool owner_before(local_shared_ptr<Y> const & r) const noexcept;
// owner_equals
template<class Y> bool owner_equals(local_shared_ptr<Y> const & r) const noexcept;
}; };
// comparisons // comparisons
@@ -546,14 +550,24 @@ Effects::
### owner_before ### owner_before
``` ```
template<class Y> bool owner_before(local_shared_ptr<Y> const & rhs) const noexcept; template<class Y> bool owner_before(local_shared_ptr<Y> const & r) const noexcept;
``` ```
[none] [none]
* {blank} * {blank}
+ +
Effects:: Returns::
See the description of `operator<`. See the description of `operator<`.
### owner_equals
```
template<class Y> bool owner_equals(local_shared_ptr<Y> const & r) const noexcept;
```
[none]
* {blank}
+
Returns::
`true` if and only if `*this` and `r` share ownership or are both empty.
## Free Functions ## Free Functions
### comparison ### comparison