diff options
| author | Topi Reinio <topi.reinio@qt.io> | 2018-10-31 13:49:14 +0100 |
|---|---|---|
| committer | Jani Heikkinen <jani.heikkinen@qt.io> | 2018-11-06 12:43:26 +0000 |
| commit | ec1548ae122af2febfc61c0242025ee52c8cbc30 (patch) | |
| tree | 12b4afa9886ad4065ca672e5927f6814ff2412cf /src/corelib/tools/qshareddata.cpp | |
| parent | 8828993c4405a8aa98f11318151a74b352eb5521 (diff) | |
Doc: Fix various documentation warnings
These include typos, marking functions as \internal, documenting
trivial things, and fixing the function signatures passed to the
\fn command.
Task-number: QTBUG-71502
Change-Id: I24a9e1f7e1cdb39e5c31b99202bdd593c6b789ff
Reviewed-by: Martin Smith <martin.smith@qt.io>
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Reviewed-by: Edward Welbourne <edward.welbourne@qt.io>
Diffstat (limited to 'src/corelib/tools/qshareddata.cpp')
| -rw-r--r-- | src/corelib/tools/qshareddata.cpp | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/src/corelib/tools/qshareddata.cpp b/src/corelib/tools/qshareddata.cpp index bc4291e20f..c334f71fa0 100644 --- a/src/corelib/tools/qshareddata.cpp +++ b/src/corelib/tools/qshareddata.cpp @@ -579,6 +579,13 @@ QT_BEGIN_NAMESPACE the shared data object if the reference count became 0. */ +/*! \fn template <class T> T *QExplicitlySharedDataPointer<T>::take() + \since 5.12 + + Returns a pointer to the shared object, and resets \e this to be null. + That is, this function sets the \e{d pointer} of \e this to \c nullptr. + */ + /*! \fn template <class T> QExplicitlySharedDataPointer<T>::operator bool () const Returns \c true if the \e{d pointer} of \e this is \e not null. */ |