added native GTK implementation of wxCalendarCtrl (modified patch 1925439)

[wxWidgets.git] / interface / ptr_shrd.h

diff --git a/interface/ptr_shrd.h b/interface/ptr_shrd.h
index 52ad2b2c93ba6633b87153cffb9990755d204f83..e6fc1dbf03c8f889b355408e9c8a4d837c073f85 100644 (file)
--- a/interface/ptr_shrd.h
+++ b/interface/ptr_shrd.h
@@ -1,36 +1,37 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        ptr_shrd.h
 /////////////////////////////////////////////////////////////////////////////
 // Name:        ptr_shrd.h

-// Purpose:     documentation for wxSharedPtr<T> class
+// Purpose:     interface of wxSharedPtr<T>

 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 
 /**
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 
 /**

-    @class wxSharedPtrT

     @wxheader{ptr_shrd.h}
 
     @wxheader{ptr_shrd.h}
 

-    A smart pointer with non-intrusive reference counting. It is modeled
-    after @b boost::shared_ptr and can be used with STL containers
-    and wxVector - unlike @b std::auto_ptr
-    and wxScopedPtr.
+    A smart pointer with non-intrusive reference counting. It is modeled after
+    @c boost::shared_ptr and can be used with STL containers and wxVector<T> -
+    unlike @c std::auto_ptr and wxScopedPtr<T>.

 
     @library{wxbase}
 
     @library{wxbase}

-    @category{FIXME}
+    @category{smartpointers}

 
 

-    @seealso
-    wxScopedPtr, wxWeakRef, wxObjectDataPtr
+    @see wxScopedPtr<T>, wxWeakRef<T>, wxObjectDataPtr

 */
 */

+template<typename T>

 class wxSharedPtr<T>
 {
 public:
 class wxSharedPtr<T>
 {
 public:

-    //@{

     /**
     /**

-        Constructors.
+        Constructor.
+
+        Creates shared pointer from the raw pointer @a ptr and takes ownership
+        of it.

     */
     */

-    wxSharedPtrT(T* ptr = NULL);
-    wxSharedPtrT(const wxSharedPtr<T>& tocopy);
-    //@}
+    wxSharedPtr(T* ptr = NULL);
+
+    /// Copy constructor.
+    wxSharedPtr(const wxSharedPtr<T>& tocopy);

 
     /**
         Destructor.
 
     /**
         Destructor.


@@ -51,8 +52,8 @@ public:
     operator unspecified_bool_type() const;
 
     /**
     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.
+        Returns a reference to the object. If the internal pointer is @NULL
+        this method will cause an assert in debug mode.

     */
     T operator*() const;
 
     */
     T operator*() const;
 


@@ -83,3 +84,4 @@ public:
     */
     long use_count() const;
 };
     */
     long use_count() const;
 };

+