]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/scopedptr.tex
fix LaTeX error (escape underscores); don't abuse bold face
[wxWidgets.git] / docs / latex / wx / scopedptr.tex
index ede1e09c17c7e4a2926abf204d3c84e96b473c1e..0e2e980518b71db76d2f837e0c212a97450749f8 100644 (file)
@@ -13,13 +13,19 @@ No base class
 
 \wxheading{Data structures}
 
-{\small \begin{verbatim}
-typedef T element\_type
-\end{verbatim}}
+{\small% 
+\begin{verbatim}
+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}}
@@ -38,12 +44,12 @@ Destructor.
 
 Returns pointer to object or NULL.
 
-\membersection{wxScopedPtr<T>::operator*}\label{wxscopedptrtemplateoperatorptrt}
+\membersection{wxScopedPtr<T>::operator*}\label{wxscopedptrtemplateoperatorreft}
 
 \constfunc{T \&}{operator*}{\void}
 
-Returns pointer to object. If the 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.
 
 \membersection{wxScopedPtr<T>::operator->}\label{wxscopedptrtemplateoperatorderef}
 
@@ -56,7 +62,7 @@ cause an assert in debug mode.
 
 \func{T*}{release}{\void}
 
-Returns pointer to object or NULL.
+Releases the current pointer and returns it.
 
 \membersection{wxScopedPtr<T>::reset}\label{wxscopedptrtemplatereset}