]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/ptr_scpd.h
more utils.h fixes
[wxWidgets.git] / interface / ptr_scpd.h
index 24300e8ddade6f5903c86d07796b4348bdc3939b..830ede02a362dc624ca8adb762f6aa04b36e67d1 100644 (file)
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        ptr_scpd.h
-// Purpose:     documentation for wxScopedPtr class
+// Purpose:     interface of wxScopedPtr
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -15,7 +15,7 @@
     use macros instead.
 
     Since wxWidgets 2.9.0 there is also a templated version of this class
-    with the same name. See wxScopedPtrT.
+    with the same name. See wxScopedPtrT().
 
     A smart pointer holds a pointer to an object. The memory used by the object is
     deleted when the smart pointer goes out of scope. This class is different from
@@ -26,8 +26,7 @@
     @library{wxbase}
     @category{FIXME}
 
-    @seealso
-    wxScopedArray
+    @see wxScopedArray
 */
 class wxScopedPtr
 {
@@ -84,6 +83,7 @@ public:
 };
 
 
+
 /**
     @class wxScopedArray
     @wxheader{ptr_scpd.h}
@@ -95,8 +95,7 @@ public:
     @library{wxbase}
     @category{FIXME}
 
-    @seealso
-    wxScopedPtr
+    @see wxScopedPtr
 */
 class wxScopedArray
 {
@@ -134,6 +133,7 @@ public:
 };
 
 
+
 /**
     @class wxScopedTiedPtr
     @wxheader{ptr_scpd.h}
@@ -171,6 +171,7 @@ public:
 };
 
 
+
 /**
     @class wxScopedPtrT
     @wxheader{ptr_scpd.h}
@@ -181,8 +182,7 @@ public:
     @library{wxbase}
     @category{FIXME}
 
-    @seealso
-    wxSharedPtr, wxWeakRef
+    @see wxSharedPtr, wxWeakRef
 */
 class wxScopedPtr<T>
 {
@@ -200,7 +200,7 @@ public:
     /**
         Returns pointer to object or @NULL.
     */
-    T* get();
+    T* get() const;
 
     /**
         Conversion to a boolean expression (in a variant which is not
@@ -208,19 +208,19 @@ public:
         contains a valid pointer it will return @e @true, if it contains
         a @NULL pointer it will return @e @false.
     */
-    operator unspecified_bool_type();
+    operator unspecified_bool_type() const;
 
     /**
         Returns a reference to the object. If the internal pointer is @NULL
         this method will cause an assert in debug mode.
     */
-    T operator*();
+    T operator*() const;
 
     /**
         Returns pointer to object. If the pointer is @NULL this method will
         cause an assert in debug mode.
     */
-    T* operator-();
+    T* operator-() const;
 
     /**
         Releases the current pointer and returns it.
@@ -240,3 +240,4 @@ public:
     */
     void swap(wxScopedPtr<T>& ot);
 };
+