From 749eaf3763c67dca32fbf250ab3e5310e31db433 Mon Sep 17 00:00:00 2001 From: Tommaso Pecorella Date: Sun, 28 Aug 2022 13:17:02 -0500 Subject: [PATCH] core: fix doxygen in ptr.h --- src/core/model/ptr.h | 26 +++++++++++++++++--------- 1 file changed, 17 insertions(+), 9 deletions(-) diff --git a/src/core/model/ptr.h b/src/core/model/ptr.h index 5e906344f..5a3b9fcd4 100644 --- a/src/core/model/ptr.h +++ b/src/core/model/ptr.h @@ -253,7 +253,7 @@ public: * \code * bool f (...) * { - * Ptr<...> P = ...; + * Ptr<...> p = ...; * return (bool)(p); * } * \endcode @@ -326,12 +326,16 @@ bool operator == (T1 const *lhs, Ptr &rhs); template bool operator == (Ptr const &lhs, Ptr const &rhs); +/**@}*/ -/** Specialization for comparison to nullptr */ +/** + * \ingroup ptr + * Specialization for comparison to \c nullptr + * \copydoc operator==(Ptrconst&,Ptrconst&) + */ template typename std::enable_if::value, bool>::type -operator == (Ptr const &lhs, T2 nullPtr); -/**@}*/ +operator == (Ptr const &lhs, T2 rhs); /** * \ingroup ptr @@ -362,12 +366,16 @@ bool operator != (T1 const *lhs, Ptr &rhs); template bool operator != (Ptr const &lhs, Ptr const &rhs); +/**@}*/ -/** Specialization for comparison to nullptr */ +/** + * \ingroup ptr + * Specialization for comparison to \c nullptr + * \copydoc operator==(Ptrconst&,Ptrconst&) +*/ template typename std::enable_if::value, bool>::type -operator != (Ptr const &lhs, T2 nullPtr); -/**@}*/ +operator != (Ptr const &lhs, T2 rhs); /** @@ -541,14 +549,14 @@ operator != (Ptr const &lhs, Ptr const &rhs) template typename std::enable_if::value, bool>::type -operator == (Ptr const &lhs, T2 nullPtr) +operator == (Ptr const &lhs, T2 rhs) { return PeekPointer (lhs) == nullptr; } template typename std::enable_if::value, bool>::type -operator != (Ptr const &lhs, T2 nullPtr) +operator != (Ptr const &lhs, T2 rhs) { return PeekPointer (lhs) != nullptr; }