From: Robert Roebling <robert@roebling.de>
Date: Mon, 7 Jan 2008 12:10:14 +0000 (+0000)
Subject: Commit correct docs for wxwxScopedPtr
X-Git-Url: https://git.saurik.com/wxWidgets.git/commitdiff_plain/6d0f32ddb8e1aec3b8707db31ed244758c242672?ds=inline

Commit correct docs for wxwxScopedPtr

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

diff --git a/docs/latex/wx/scopedptr.tex b/docs/latex/wx/scopedptr.tex
new file mode 100644
index 0000000000..ede1e09c17
--- /dev/null
+++ b/docs/latex/wx/scopedptr.tex
@@ -0,0 +1,73 @@
+\section{\class{wxScopedPtr<T>}}\label{wxscopedptrtemplate}
+
+A scoped pointer template class. It is the template version of
+the old-style \helpref{scoped pointer macros}{wxscopedptr}.
+
+\wxheading{Derived from}
+
+No base class
+
+\wxheading{Include files}
+
+<ptr\_scpd.h>
+
+\wxheading{Data structures}
+
+{\small \begin{verbatim}
+typedef T element\_type
+\end{verbatim}}
+
+\latexignore{\rtfignore{\wxheading{Members}}}
+
+
+\membersection{wxScopedPtr<T>::wxScopedPtr<T>}\label{wxscopedptrtemplatewxscopedptrtemplate}
+
+\func{wxEXPLICIT}{wxScopedPtr<T>}{\param{T * }{ptr = NULL}}
+
+Constructor.
+
+\membersection{wxScopedPtr<T>::\destruct{wxScopedPtr<T>}}\label{wxscopedptrtemplatedtor}
+
+\func{}{\destruct{wxScopedPtr<T>}}{\void}
+
+Destructor.
+
+\membersection{wxScopedPtr<T>::get}\label{wxscopedptrtemplateget}
+
+\constfunc{T *}{get}{\void}
+
+Returns pointer to object or NULL.
+
+\membersection{wxScopedPtr<T>::operator*}\label{wxscopedptrtemplateoperatorptrt}
+
+\constfunc{T \&}{operator*}{\void}
+
+Returns pointer to object. If the pointer is NULL this method will 
+cause an assert in debug mode.
+
+\membersection{wxScopedPtr<T>::operator->}\label{wxscopedptrtemplateoperatorderef}
+
+\constfunc{T *}{operator->}{\void}
+
+Returns pointer to object. If the pointer is NULL this method will 
+cause an assert in debug mode.
+
+\membersection{wxScopedPtr<T>::release}\label{wxscopedptrtemplaterelease}
+
+\func{T*}{release}{\void}
+
+Returns pointer to object or NULL.
+
+\membersection{wxScopedPtr<T>::reset}\label{wxscopedptrtemplatereset}
+
+\func{void}{reset}{\param{T * }{ptr = NULL}}
+
+Reset pointer. Afterwards the caller is responsible for deleting
+the data contained in the scoped pointer before.
+
+\membersection{wxScopedPtr<T>::swap}\label{wxscopedptrtemplateswap}
+
+\func{void}{swap}{\param{wxScopedPtr<T> \& }{ot}}
+
+Swaps pointers.
+