Skip to content

Commit 4983e1a

Browse files
committed
Fixed typos in documentation
1 parent 79bdce3 commit 4983e1a

File tree

1 file changed

+12
-14
lines changed

1 file changed

+12
-14
lines changed

include/oup/observable_unique_ptr.hpp

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1570,8 +1570,8 @@ class basic_enable_observer_from_this :
15701570
/**
15711571
* \brief Perform a `static_cast` for an @ref basic_observable_ptr.
15721572
* \param ptr The pointer to cast
1573-
* \note Ownership will be transfered to the returned pointer.
1574-
If the input pointer is null, the output pointer will also be null.
1573+
* \note Ownership will be transferred to the returned pointer.
1574+
* If the input pointer is null, the output pointer will also be null.
15751575
*/
15761576
template<typename U, typename T, typename D, typename P>
15771577
basic_observable_ptr<U, D, P> static_pointer_cast(basic_observable_ptr<T, D, P>&& ptr) {
@@ -1582,7 +1582,7 @@ basic_observable_ptr<U, D, P> static_pointer_cast(basic_observable_ptr<T, D, P>&
15821582
* \brief Perform a `static_cast` for a @ref basic_observer_ptr.
15831583
* \param ptr The pointer to cast
15841584
* \note A new observer is returned, the input observer is not modified.
1585-
If the input pointer is null, the output pointer will also be null.
1585+
* If the input pointer is null, the output pointer will also be null.
15861586
*/
15871587
template<typename U, typename T, typename Policy>
15881588
basic_observer_ptr<U, Policy> static_pointer_cast(const basic_observer_ptr<T, Policy>& ptr) {
@@ -1594,7 +1594,7 @@ basic_observer_ptr<U, Policy> static_pointer_cast(const basic_observer_ptr<T, Po
15941594
* \brief Perform a `static_cast` for a @ref basic_observer_ptr.
15951595
* \param ptr The pointer to cast
15961596
* \note A new observer is returned, the input observer is set to null.
1597-
If the input pointer is null, the output pointer will also be null.
1597+
* If the input pointer is null, the output pointer will also be null.
15981598
*/
15991599
template<typename U, typename T, typename Policy>
16001600
basic_observer_ptr<U, Policy> static_pointer_cast(basic_observer_ptr<T, Policy>&& ptr) {
@@ -1605,8 +1605,8 @@ basic_observer_ptr<U, Policy> static_pointer_cast(basic_observer_ptr<T, Policy>&
16051605
/**
16061606
* \brief Perform a `const_cast` for an @ref basic_observable_ptr.
16071607
* \param ptr The pointer to cast
1608-
* \note Ownership will be transfered to the returned pointer.
1609-
If the input pointer is null, the output pointer will also be null.
1608+
* \note Ownership will be transferred to the returned pointer.
1609+
* If the input pointer is null, the output pointer will also be null.
16101610
*/
16111611
template<typename U, typename T, typename D, typename P>
16121612
basic_observable_ptr<U, D, P> const_pointer_cast(basic_observable_ptr<T, D, P>&& ptr) {
@@ -1617,7 +1617,7 @@ basic_observable_ptr<U, D, P> const_pointer_cast(basic_observable_ptr<T, D, P>&&
16171617
* \brief Perform a `const_cast` for a @ref basic_observer_ptr.
16181618
* \param ptr The pointer to cast
16191619
* \note A new observer is returned, the input observer is not modified.
1620-
If the input pointer is null, the output pointer will also be null.
1620+
* If the input pointer is null, the output pointer will also be null.
16211621
*/
16221622
template<typename U, typename T, typename Policy>
16231623
basic_observer_ptr<U, Policy> const_pointer_cast(const basic_observer_ptr<T, Policy>& ptr) {
@@ -1629,7 +1629,7 @@ basic_observer_ptr<U, Policy> const_pointer_cast(const basic_observer_ptr<T, Pol
16291629
* \brief Perform a `const_cast` for a @ref basic_observer_ptr.
16301630
* \param ptr The pointer to cast
16311631
* \note A new observer is returned, the input observer is set to null.
1632-
If the input pointer is null, the output pointer will also be null.
1632+
* If the input pointer is null, the output pointer will also be null.
16331633
*/
16341634
template<typename U, typename T, typename Policy>
16351635
basic_observer_ptr<U, Policy> const_pointer_cast(basic_observer_ptr<T, Policy>&& ptr) {
@@ -1640,7 +1640,7 @@ basic_observer_ptr<U, Policy> const_pointer_cast(basic_observer_ptr<T, Policy>&&
16401640
/**
16411641
* \brief Perform a `dynamic_cast` for a @ref basic_observable_ptr.
16421642
* \param ptr The pointer to cast
1643-
* \note Ownership will be transfered to the returned pointer unless the cast
1643+
* \note Ownership will be transferred to the returned pointer unless the cast
16441644
* fails, in which case ownership remains in the original pointer, std::bad_cast
16451645
* is thrown, and no memory is leaked. If the input pointer is null,
16461646
* the output pointer will also be null.
@@ -1659,8 +1659,7 @@ basic_observable_ptr<U, D, P> dynamic_pointer_cast(basic_observable_ptr<T, D, P>
16591659
* \brief Perform a `dynamic_cast` for a @ref basic_observer_ptr.
16601660
* \param ptr The pointer to cast
16611661
* \note A new observer is returned, the input observer is not modified.
1662-
If the input pointer is null, or if the cast fails, the output pointer
1663-
will be null.
1662+
* If the input pointer is null, or if the cast fails, the output pointer will be null.
16641663
*/
16651664
template<typename U, typename T, typename Policy>
16661665
basic_observer_ptr<U, Policy> dynamic_pointer_cast(const basic_observer_ptr<T, Policy>& ptr) {
@@ -1672,8 +1671,7 @@ basic_observer_ptr<U, Policy> dynamic_pointer_cast(const basic_observer_ptr<T, P
16721671
* \brief Perform a `dynamic_cast` for a @ref basic_observer_ptr.
16731672
* \param ptr The pointer to cast
16741673
* \note A new observer is returned, the input observer is set to null.
1675-
If the input pointer is null, or if the cast fails, the output pointer
1676-
will be null.
1674+
* If the input pointer is null, or if the cast fails, the output pointer will be null.
16771675
*/
16781676
template<typename U, typename T, typename Policy>
16791677
basic_observer_ptr<U, Policy> dynamic_pointer_cast(basic_observer_ptr<T, Policy>&& ptr) {
@@ -1747,7 +1745,7 @@ using observable_unique_ptr = basic_observable_ptr<T, Deleter, unique_policy>;
17471745
* If you need to create an @ref observer_ptr from a `this` pointer,
17481746
* consider making the object inheriting from @ref enable_observer_from_this_sealed.
17491747
* Compared to @ref enable_observer_from_this_unique, this has some additional
1750-
* limitations. Please consult the documenation for @ref enable_observer_from_this_sealed
1748+
* limitations. Please consult the documentation for @ref enable_observer_from_this_sealed
17511749
* for more information.
17521750
*
17531751
* Other notable points (either limitations imposed by the current

0 commit comments

Comments
 (0)