Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Minor correction to smart pointer docs

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@65111 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Robert Roebling
2010-07-25 19:45:24 +00:00
parent a36bceb633
commit 37494cb336
3 changed files with 17 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
interface/wx/scopedptr.h
View File

@@ -108,22 +108,22 @@ public:
This operator gets the pointer stored in the smart pointer or returns This operator gets the pointer stored in the smart pointer or returns
@NULL if there is none. @NULL if there is none.
*/ */
const T* get(); T* get() const;
/** /**
This operator works like the standard C++ pointer operator to return the object This operator works like the standard C++ pointer operator to return the object
being pointed to by the pointer. being pointed to by the pointer.
@note If the internal pointer is @NULL this method will cause an assert in debug mode.
If the pointer is @NULL or invalid this will crash.
*/ */
const T& operator *(); T& operator *() const;
/** /**
This operator works like the standard C++ pointer operator to return the pointer Smart pointer member access. Returns pointer to its object.
in the smart pointer or @NULL if it is empty.
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 Returns the currently hold pointer and resets the smart pointer object to
@@ -234,15 +234,14 @@ public:
/** /**
Returns a reference to the object. 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 Smart pointer member access. Returns pointer to object.
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;

4
interface/wx/sharedptr.h
View File

@@ -61,7 +61,9 @@ public:
T operator*() const; 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; T* operator->() const;

5
interface/wx/weakref.h
View File

@@ -156,11 +156,10 @@ public:
T& operator*() const; T& operator*() const;
/** /**
Smart pointer member access. Smart pointer member access. Returns a pointer to the tracked object.
Returns a pointer to the tracked object.
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-(); T* operator->();
/** /**
Releases the currently tracked object and starts tracking @e pobj. Releases the currently tracked object and starts tracking @e pobj.