Doc: improve QScopedPointer::reset() documentation

- Fix grammar
- Mention take()

Change-Id: I3bde229755549230ad3d0962da6eeb164a060fb1
Reviewed-by: Andy Shaw <andy.shaw@qt.io>
bb10
Mitch Curtis 2018-03-07 08:43:51 +01:00
parent caa5a20479
commit e5a6e9bb80
1 changed files with 4 additions and 1 deletions

View File

@ -250,9 +250,12 @@ QT_BEGIN_NAMESPACE
/*!
\fn template <typename T, typename Cleanup> void QScopedPointer<T, Cleanup>::reset(T *other = 0)
Deletes the existing object it is pointing to if any, and sets its pointer to
Deletes the existing object it is pointing to (if any), and sets its pointer to
\a other. QScopedPointer now owns \a other and will delete it in its
destructor.
To clear the pointer held without deleting the object it points to (and hence take ownership
of the object), use \l take() instead.
*/
/*!