X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/7c913512a4c9f36e11e07ea707002fab1608d324..b02f1c862d1a3fcd714aef37e67decaa9d67b611:/interface/ptr_scpd.h

diff --git a/interface/ptr_scpd.h b/interface/ptr_scpd.h
index 13e6202ad5..830ede02a3 100644
--- a/interface/ptr_scpd.h
+++ b/interface/ptr_scpd.h
@@ -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
 {
@@ -36,7 +35,7 @@ public:
         Creates the smart pointer with the given pointer or none if @NULL.  On
         compilers that support it, this uses the explicit keyword.
     */
-    explicit wxScopedPtr(type T = @NULL);
+    explicit wxScopedPtr(type T = NULL);
 
     /**
         Destructor frees the pointer help by this object if it is not @NULL.
@@ -67,14 +66,14 @@ public:
         @NULL. After a call to this function the caller is responsible for
         deleting the pointer.
     */
-    T * release();
+    T* release();
 
     /**
-        Deletes the currently held pointer and sets it to @e p or to @NULL if no
+        Deletes the currently held pointer and sets it to @a p or to @NULL if no
         arguments are specified. This function does check to make sure that the
         pointer you are assigning is not the same pointer that is already stored.
     */
-    reset(T p  = @NULL);
+    reset(T p  = NULL);
 
     /**
         Swap the pointer inside the smart pointer with @e other. The pointer being
@@ -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
 {
@@ -105,7 +104,7 @@ public:
         Creates the smart pointer with the given pointer or none if @NULL.  On
         compilers that support it, this uses the explicit keyword.
     */
-    wxScopedArray(type T = @NULL);
+    wxScopedArray(type T = NULL);
 
     /**
         This operator gets the pointer stored in the smart pointer or returns @NULL if
@@ -124,7 +123,7 @@ public:
         arguments are specified. This function does check to make sure that the
         pointer you are assigning is not the same pointer that is already stored.
     */
-    reset(T p  = @NULL);
+    reset(T p  = NULL);
 
     /**
         Swap the pointer inside the smart pointer with 'ot'. The pointer being swapped
@@ -134,6 +133,7 @@ public:
 };
 
 
+
 /**
     @class wxScopedTiedPtr
     @wxheader{ptr_scpd.h}
@@ -153,17 +153,16 @@ class wxScopedTiedPtr
 {
 public:
     /**
-        Constructor creates a smart pointer initialized with @e ptr and stores
-        @e ptr in the location specified by @e ppTie which must not be
+        Constructor creates a smart pointer initialized with @a ptr and stores
+        @a ptr in the location specified by @a ppTie which must not be
         @NULL.
     */
-    wxScopedTiedPtr(T ** ppTie, T * ptr);
+    wxScopedTiedPtr(T** ppTie, T* ptr);
 
     /**
         Destructor frees the pointer help by this object and restores the value stored
         at the tied location (as specified in the @ref ctor() constructor)
         to the old value.
-        
         Warning: this location may now contain an uninitialized value if it hadn't been
         initialized previously, in particular don't count on it magically being
         @NULL!
@@ -172,6 +171,7 @@ public:
 };
 
 
+
 /**
     @class wxScopedPtrT
     @wxheader{ptr_scpd.h}
@@ -182,8 +182,7 @@ public:
     @library{wxbase}
     @category{FIXME}
 
-    @seealso
-    wxSharedPtr, wxWeakRef
+    @see wxSharedPtr, wxWeakRef
 */
 class wxScopedPtr<T>
 {
@@ -191,7 +190,7 @@ public:
     /**
         Constructor.
     */
-    wxScopedPtrT(T * ptr = @NULL);
+    wxScopedPtrT(T* ptr = NULL);
 
     /**
         Destructor.
@@ -201,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
@@ -209,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.
@@ -234,10 +233,11 @@ public:
         Reset pointer to the value of @e ptr. The
         previous pointer will be deleted.
     */
-    void reset(T * ptr = @NULL);
+    void reset(T* ptr = NULL);
 
     /**
         Swaps pointers.
     */
-    void swap(wxScopedPtr<T> & ot);
+    void swap(wxScopedPtr<T>& ot);
 };
+