]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/ptr_scpd.h
Intial review of calctrl.h.
[wxWidgets.git] / interface / ptr_scpd.h
index cdb46b60746b60c207f8627a8a267973a02f13d9..be9d29299d5e5d0c51435ba87c24e1ec9810e861 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
     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
     the @c std::auto_ptr in so far as it doesn't provide copy constructor
     nor assignment operator. This limits what you can do with it but is much less
-    surprizing than the "destructive copy'' behaviour of the standard class.
+    surprizing than the "destructive copy" behaviour of the standard class.
 
     @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,12 +133,13 @@ public:
 };
 
 
+
 /**
     @class wxScopedTiedPtr
     @wxheader{ptr_scpd.h}
 
     This is a variation on the topic of wxScopedPtr. This
-    class is also a smart pointer but in addition it "ties'' the pointer value to
+    class is also a smart pointer but in addition it "ties" the pointer value to
     another variable. In other words, during the life time of this class the value
     of that variable is set to be the same as the value of the pointer itself and
     it is reset to its old value when the object is destroyed. This class is
@@ -171,8 +171,8 @@ public:
 };
 
 
+
 /**
-    @class wxScopedPtrT
     @wxheader{ptr_scpd.h}
 
     A scoped pointer template class. It is the template version of
@@ -181,8 +181,7 @@ public:
     @library{wxbase}
     @category{FIXME}
 
-    @seealso
-    wxSharedPtr, wxWeakRef
+    @see wxSharedPtr, wxWeakRef
 */
 class wxScopedPtr<T>
 {
@@ -240,3 +239,4 @@ public:
     */
     void swap(wxScopedPtr<T>& ot);
 };
+