From: Robert Roebling <robert@roebling.de>
Date: Tue, 8 Jan 2008 12:26:48 +0000 (+0000)
Subject: docs
X-Git-Url: https://git.saurik.com/wxWidgets.git/commitdiff_plain/72636c1509db52918996658c17e5e948b64fa5dc

docs

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@51105 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
---

diff --git a/docs/latex/wx/scopedptr.tex b/docs/latex/wx/scopedptr.tex
index 952c0d451f..0e2e980518 100644
--- a/docs/latex/wx/scopedptr.tex
+++ b/docs/latex/wx/scopedptr.tex
@@ -19,9 +19,13 @@ typedef T element_type
 \end{verbatim}
 }%
 
-\latexignore{\rtfignore{\wxheading{Members}}}
+\wxheading{See also}
+
+\helpref{wxSharedPtr}{wxsharedptr}, \helpref{wxWeakRef}{wxweakref}
 
 
+\latexignore{\rtfignore{\wxheading{Members}}}
+
 \membersection{wxScopedPtr<T>::wxScopedPtr<T>}\label{wxscopedptrtemplatewxscopedptrtemplate}
 
 \func{wxEXPLICIT}{wxScopedPtr<T>}{\param{T * }{ptr = NULL}}
@@ -58,7 +62,7 @@ cause an assert in debug mode.
 
 \func{T*}{release}{\void}
 
-Releases the current pointer and returns NULL.
+Releases the current pointer and returns it.
 
 \membersection{wxScopedPtr<T>::reset}\label{wxscopedptrtemplatereset}
 
diff --git a/docs/latex/wx/sharedptr.tex b/docs/latex/wx/sharedptr.tex
index fb6b9d84bd..840b54cba2 100644
--- a/docs/latex/wx/sharedptr.tex
+++ b/docs/latex/wx/sharedptr.tex
@@ -1,6 +1,9 @@
 \section{\class{wxSharedPtr<T>}}\label{wxsharedptr}
 
-A smart pointer with non-intrusive reference counting.
+A smart pointer with non-intrusive reference counting. It is modeled
+after {\bf boost::shared\_ptr<>} and can be used with STL containers 
+and \helpref{wxVector<>}{wxvector} - unlike {\bf std::auto\_ptr<>}
+and \helpref{wxScopedPtr<>}{wxscopedptrtemplate}.
 
 \wxheading{Derived from}
 
@@ -18,6 +21,11 @@ typedef T element_type
 \end{verbatim}
 }%
 
+\wxheading{See also}
+
+\helpref{wxScopedPtr}{wxscopedptrtemplate}, \helpref{wxWeakRef}{wxweakref}
+
+
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
@@ -58,7 +66,15 @@ Returns pointer to its object or NULL.
 
 \func{wxSharedPtr<T>\& operator}{operator=}{\param{const wxSharedPtr<T>\& }{tocopy}}
 
-Assignment operator.
+Assignment operator. Releases any previously held pointer
+and creates a reference to same object as {\it topcopy}.
+
+\membersection{wxSharedPtr<T>::operator=}\label{wxsharedptroperatorassign2}
+
+\func{wxSharedPtr<T>\& operator}{operator=}{\param{T *}{ptr}}
+
+Assignment operator. Releases any previously held pointer
+and creates a reference to {\it ptr}.
 
 \membersection{wxSharedPtr<T>::unique}\label{wxsharedptrunique}
 
diff --git a/docs/latex/wx/weakref.tex b/docs/latex/wx/weakref.tex
index 35e965c334..16298ea5df 100644
--- a/docs/latex/wx/weakref.tex
+++ b/docs/latex/wx/weakref.tex
@@ -3,8 +3,7 @@
 {\bf wxWeakRef} is a template class for weak references to wxWidgets objects, 
 such as {\bf wxEvtHandler}, {\bf wxWindow} and {\bf wxObject}. A weak 
 reference behaves much like an ordinary pointer, but when the object pointed 
-to goes out of scope (is destroyed), the weak reference is automatically 
-reset to a NULL pointer. 
+is destroyed, the weak reference is automatically reset to a NULL pointer. 
 
 wxWeakref<T> can be used whenever one must keep a pointer to an object 
 that does not directly own, and that may be destroyed before the object 
@@ -31,9 +30,10 @@ wxWeakref<T> is a small object and the mechanism behind it is fast
     wxASSERT( wr==NULL );
 \end{verbatim}
 
-wxWeakref<T> works for any objects that are derived from {\bf wxTrackableBase} 
-or {\bf wxTrackable}. By default, wxEvtHandler and wxWindow derive from 
-wxTrackableBase. However, wxObject does not, so types like {\bf wxFont} and 
+wxWeakref<T> works for any objects that are derived from 
+\helpref{wxTrackableBase}{wxtrackablebase} or \helpref{wxTrackable}{wxtrackable}.
+By default, wxEvtHandler and wxWindow derive from wxTrackableBase. However, 
+wxObject does not, so types like {\bf wxFont} and 
 {\bf wxColour} are not trackable. The example below shows how to create a 
 wxObject derived class that is trackable: 
 
@@ -71,6 +71,13 @@ wxTrackerNode
 
 \wxheading{Data structures}
 
+{\small% 
+\begin{verbatim}
+typedef T element_type
+\end{verbatim}
+}%
+
+
 \latexignore{\rtfignore{\wxheading{Members}}}