Skip to content

Commit bae27a3

Browse files
committed
Clean up documentation of basic_observer_ptr constructors
1 parent 08f687f commit bae27a3

File tree

1 file changed

+10
-12
lines changed

1 file changed

+10
-12
lines changed

include/oup/observable_unique_ptr.hpp

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -969,7 +969,10 @@ class basic_observer_ptr final {
969969
}
970970
}
971971

972-
/// Create an observer pointer from an owning pointer.
972+
/**
973+
* \brief Create an observer pointer from an owning pointer of a convertible type.
974+
* \param owner The owner pointer to observe (can be null)
975+
*/
973976
template<
974977
typename U,
975978
typename D,
@@ -1010,12 +1013,9 @@ class basic_observer_ptr final {
10101013
* \brief Copy an existing @ref basic_observer_ptr instance with explicit casting
10111014
* \param manager The observer pointer to copy the observed data from
10121015
* \param value The casted pointer value to observe
1013-
* \note After this smart pointer is created, the source
1014-
* pointer is set to null and looses ownership. The deleter
1015-
* is default constructed. The raw pointer `value` may or may
1016-
* not be related to the raw pointer observed by `manager`.
1017-
* This could be a pointer to any other object which is known to
1018-
* have the same lifetime.
1016+
* \note The raw pointer `value` may or may not be related to the raw pointer
1017+
* observed by `manager`. This could be a pointer to any other object which is known
1018+
* to have the same lifetime.
10191019
*/
10201020
template<typename U>
10211021
basic_observer_ptr(const basic_observer_ptr<U, Policy>& manager, T* value) noexcept :
@@ -1054,11 +1054,9 @@ class basic_observer_ptr final {
10541054
* \brief Move from an existing @ref basic_observer_ptr instance with explicit casting
10551055
* \param manager The observer pointer to copy the observed data from
10561056
* \param value The casted pointer value to observe
1057-
* \note After this smart pointer is created, the source
1058-
* pointer is set to null and looses ownership. The deleter
1059-
* is default constructed. The raw pointer `value` may or may
1060-
* not be related to the raw pointer observed by `manager`.
1061-
* This could be a pointer to any other object which is known to
1057+
* \note After this smart pointer is created, the source pointer `manager` is set to
1058+
* null. The raw pointer `value` may or may not be related to the raw pointer observed
1059+
* by `manager`. This could be a pointer to any other object which is known to
10621060
* have the same lifetime.
10631061
*/
10641062
template<typename U>

0 commit comments

Comments
 (0)