diff options
| author | Mitch Curtis <mitch.curtis@qt.io> | 2018-03-07 08:43:51 +0100 |
|---|---|---|
| committer | Mitch Curtis <mitch.curtis@qt.io> | 2018-03-08 07:40:26 +0000 |
| commit | e5a6e9bb80fb2427228f70488b8839b4aa0b4261 (patch) | |
| tree | 388be47485f2c548d73959ebd4f85e3d4ebfc5ac /src/corelib/tools/qscopedpointer.cpp | |
| parent | caa5a20479bd58fda4380181691f772a1f3c1da4 (diff) | |
Doc: improve QScopedPointer::reset() documentation
- Fix grammar
- Mention take()
Change-Id: I3bde229755549230ad3d0962da6eeb164a060fb1
Reviewed-by: Andy Shaw <andy.shaw@qt.io>
Diffstat (limited to 'src/corelib/tools/qscopedpointer.cpp')
| -rw-r--r-- | src/corelib/tools/qscopedpointer.cpp | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/src/corelib/tools/qscopedpointer.cpp b/src/corelib/tools/qscopedpointer.cpp index 6c24e19bfa..769a18f9e0 100644 --- a/src/corelib/tools/qscopedpointer.cpp +++ b/src/corelib/tools/qscopedpointer.cpp @@ -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. */ /*! |