diff options
| author | Martin Smith <martin.smith@qt.io> | 2017-08-03 13:21:07 +0200 |
|---|---|---|
| committer | Martin Smith <martin.smith@qt.io> | 2017-12-02 09:38:12 +0000 |
| commit | 1ca60025d962a12be9d5b4f2003368cbda59a798 (patch) | |
| tree | 5d5ac07e5617ec56c73544fd58bb1ff1a13e32ee /src/corelib/thread/qfuturesynchronizer.qdoc | |
| parent | e2cdfd54c960a32b19a5faf76a68fb2e051d547a (diff) | |
doc: Add missing template text and parameters
This update corrects many qdoc warnings in the documentation
for the QFuture classes caused by incomplete \fn commands.
Template text and parameters was added.
Change-Id: I360c9db191230b19a9b174a43468d3de1eb24549
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
Diffstat (limited to 'src/corelib/thread/qfuturesynchronizer.qdoc')
| -rw-r--r-- | src/corelib/thread/qfuturesynchronizer.qdoc | 20 |
1 files changed, 10 insertions, 10 deletions
diff --git a/src/corelib/thread/qfuturesynchronizer.qdoc b/src/corelib/thread/qfuturesynchronizer.qdoc index 580eae6982..c9c402ff87 100644 --- a/src/corelib/thread/qfuturesynchronizer.qdoc +++ b/src/corelib/thread/qfuturesynchronizer.qdoc @@ -68,13 +68,13 @@ */ /*! - \fn QFutureSynchronizer::QFutureSynchronizer() + \fn template <typename T> QFutureSynchronizer<T>::QFutureSynchronizer() Constructs a QFutureSynchronizer. */ /*! - \fn QFutureSynchronizer::QFutureSynchronizer(const QFuture<T> &future) + \fn template <typename T> QFutureSynchronizer<T>::QFutureSynchronizer(const QFuture<T> &future) Constructs a QFutureSynchronizer and begins watching \a future by calling addFuture(). @@ -83,7 +83,7 @@ */ /*! - \fn QFutureSynchronizer::~QFutureSynchronizer() + \fn template <typename T> QFutureSynchronizer<T>::~QFutureSynchronizer() Calls waitForFinished() function to ensure that all futures have finished before destroying this QFutureSynchronizer. @@ -92,7 +92,7 @@ */ /*! - \fn void QFutureSynchronizer::setFuture(const QFuture<T> &future) + \fn template <typename T> void QFutureSynchronizer<T>::setFuture(const QFuture<T> &future) Sets \a future to be the only future managed by this QFutureSynchronizer. This is a convenience function that calls waitForFinished(), @@ -102,7 +102,7 @@ */ /*! - \fn void QFutureSynchronizer::addFuture(const QFuture<T> &future) + \fn template <typename T> void QFutureSynchronizer<T>::addFuture(const QFuture<T> &future) Adds \a future to the list of managed futures. @@ -110,7 +110,7 @@ */ /*! - \fn void QFutureSynchronizer::waitForFinished() + \fn template <typename T> void QFutureSynchronizer<T>::waitForFinished() Waits for all futures to finish. If cancelOnWait() returns \c true, each future is canceled before waiting for them to finish. @@ -119,7 +119,7 @@ */ /*! - \fn void QFutureSynchronizer::clearFutures() + \fn template <typename T> void QFutureSynchronizer<T>::clearFutures() Removes all managed futures from this QFutureSynchronizer. @@ -127,7 +127,7 @@ */ /*! - \fn QList<QFuture<T> > QFutureSynchronizer::futures() const + \fn template <typename T> QList<QFuture<T> > QFutureSynchronizer<T>::futures() const Returns a list of all managed futures. @@ -135,7 +135,7 @@ */ /*! - \fn void QFutureSynchronizer::setCancelOnWait(bool enabled) + \fn template <typename T> void QFutureSynchronizer<T>::setCancelOnWait(bool enabled) Enables or disables the cancel-on-wait feature based on the \a enabled argument. If \a enabled is true, the waitForFinished() function will cancel @@ -145,7 +145,7 @@ */ /*! - \fn bool QFutureSynchronizer::cancelOnWait() const + \fn template <typename T> bool QFutureSynchronizer<T>::cancelOnWait() const Returns \c true if the cancel-on-wait feature is enabled; otherwise returns false. If cancel-on-wait is enabled, the waitForFinished() function will |