From 37494cb3360d119f0da8314463ece1a6144f8de6 Mon Sep 17 00:00:00 2001 From: Robert Roebling Date: Sun, 25 Jul 2010 19:45:24 +0000 Subject: [PATCH] Minor correction to smart pointer docs git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@65111 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- interface/wx/scopedptr.h | 25 ++++++++++++------------- interface/wx/sharedptr.h | 4 +++- interface/wx/weakref.h | 5 ++--- 3 files changed, 17 insertions(+), 17 deletions(-) diff --git a/interface/wx/scopedptr.h b/interface/wx/scopedptr.h index 1be9abfd85..8a8d815520 100644 --- a/interface/wx/scopedptr.h +++ b/interface/wx/scopedptr.h @@ -108,22 +108,22 @@ public: This operator gets the pointer stored in the smart pointer or returns @NULL if there is none. */ - const T* get(); + T* get() const; /** This operator works like the standard C++ pointer operator to return the object being pointed to by the pointer. - @note - If the pointer is @NULL or invalid this will crash. + If the internal pointer is @NULL this method will cause an assert in debug mode. */ - const T& operator *(); + T& operator *() const; /** - This operator works like the standard C++ pointer operator to return the pointer - in the smart pointer or @NULL if it is empty. + Smart pointer member access. Returns pointer to its object. + + If the internal pointer is @NULL this method will cause an assert in debug mode. */ - const T* operator ->(); + T* operator ->() const; /** Returns the currently hold pointer and resets the smart pointer object to @@ -234,15 +234,14 @@ public: /** Returns a reference to the object. - @note - If the internal pointer is @NULL this method will cause an assert - in debug mode. + If the internal pointer is @NULL this method will cause an assert in debug mode. */ - T operator*() const; + T& operator*() const; /** - Returns pointer to object. If the pointer is @NULL this method will - cause an assert in debug mode. + Smart pointer member access. Returns pointer to object. + + If the internal pointer is @NULL this method will cause an assert in debug mode. */ T* operator->() const; diff --git a/interface/wx/sharedptr.h b/interface/wx/sharedptr.h index 2b18e2a471..47b73c0d60 100644 --- a/interface/wx/sharedptr.h +++ b/interface/wx/sharedptr.h @@ -61,7 +61,9 @@ public: T operator*() const; /** - Returns pointer to its object or @NULL. + Smart pointer member access. Returns pointer to its object. + + If the internal pointer is @NULL this method will cause an assert in debug mode. */ T* operator->() const; diff --git a/interface/wx/weakref.h b/interface/wx/weakref.h index 17a158f9e7..6e988f0e12 100644 --- a/interface/wx/weakref.h +++ b/interface/wx/weakref.h @@ -156,11 +156,10 @@ public: T& operator*() const; /** - Smart pointer member access. - Returns a pointer to the tracked object. + Smart pointer member access. Returns a pointer to the tracked object. If the internal pointer is @NULL this method will cause an assert in debug mode. */ - T* operator-(); + T* operator->(); /** Releases the currently tracked object and starts tracking @e pobj. -- 2.45.2