fixes to wxSharedPtr<T> docs
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52646 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
@@ -7,29 +7,31 @@
|
|||||||
/////////////////////////////////////////////////////////////////////////////
|
/////////////////////////////////////////////////////////////////////////////
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@class wxSharedPtrT
|
|
||||||
@wxheader{ptr_shrd.h}
|
@wxheader{ptr_shrd.h}
|
||||||
|
|
||||||
A smart pointer with non-intrusive reference counting. It is modeled
|
A smart pointer with non-intrusive reference counting. It is modeled after
|
||||||
after @b boost::shared_ptr and can be used with STL containers
|
@c boost::shared_ptr and can be used with STL containers and wxVector<T> -
|
||||||
and wxVector() - unlike @b std::auto_ptr
|
unlike @c std::auto_ptr and wxScopedPtr<T>.
|
||||||
and wxScopedPtr().
|
|
||||||
|
|
||||||
@library{wxbase}
|
@library{wxbase}
|
||||||
@category{FIXME}
|
@category{smartpointers}
|
||||||
|
|
||||||
@see wxScopedPtr, wxWeakRef, wxObjectDataPtr
|
@see wxScopedPtr<T>, wxWeakRef<T>, wxObjectDataPtr
|
||||||
*/
|
*/
|
||||||
|
template<typename T>
|
||||||
class wxSharedPtr<T>
|
class wxSharedPtr<T>
|
||||||
{
|
{
|
||||||
public:
|
public:
|
||||||
//@{
|
|
||||||
/**
|
/**
|
||||||
Constructors.
|
Constructor.
|
||||||
|
|
||||||
|
Creates shared pointer from the raw pointer @a ptr and takes ownership
|
||||||
|
of it.
|
||||||
*/
|
*/
|
||||||
wxSharedPtrT(T* ptr = NULL);
|
wxSharedPtr(T* ptr = NULL);
|
||||||
wxSharedPtrT(const wxSharedPtr<T>& tocopy);
|
|
||||||
//@}
|
/// Copy constructor.
|
||||||
|
wxSharedPtr(const wxSharedPtr<T>& tocopy);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
Destructor.
|
Destructor.
|
||||||
@@ -50,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
|
Returns a reference to the object. If the internal pointer is @NULL
|
||||||
method will cause an assert in debug mode.
|
this method will cause an assert in debug mode.
|
||||||
*/
|
*/
|
||||||
T operator*() const;
|
T operator*() const;
|
||||||
|
|
||||||
|
Reference in New Issue
Block a user