/////////////////////////////////////////////////////////////////////////////
// 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
{
};
+
/**
@class wxScopedArray
@wxheader{ptr_scpd.h}
@library{wxbase}
@category{FIXME}
- @seealso
- wxScopedPtr
+ @see wxScopedPtr
*/
class wxScopedArray
{
};
+
/**
@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
};
+
/**
- @class wxScopedPtrT
@wxheader{ptr_scpd.h}
A scoped pointer template class. It is the template version of
@library{wxbase}
@category{FIXME}
- @seealso
- wxSharedPtr, wxWeakRef
+ @see wxSharedPtr, wxWeakRef
*/
class wxScopedPtr<T>
{
*/
void swap(wxScopedPtr<T>& ot);
};
+