diff options
| author | Topi Reinio <topi.reinio@qt.io> | 2021-06-30 14:04:31 +0200 |
|---|---|---|
| committer | Topi Reinio <topi.reinio@qt.io> | 2021-07-01 14:50:42 +0200 |
| commit | c248844b3b8ee004800606d1a6c6e6d6bee31738 (patch) | |
| tree | e5c9d05a1f59f725d79279f8dbc5cb75136d118a /src/core/api/qwebenginedownloadrequest.cpp | |
| parent | 57eb73f933e3c1499a969b2023073c3c01bb9a1f (diff) | |
| download | qtwebengine-c248844b3b8ee004800606d1a6c6e6d6bee31738.tar.gz | |
Doc: Fix documentation issues for Qt WebEngine
API and documentation changes since 5.15 caused multiple warnings from
QDoc; this change addresses most of them. Some warnings indicate
missing documentation, those issues still remain.
Pick-to: 6.2
Change-Id: I96be38b7daac37a7e35c149b4b3ec3f18c4415c9
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
Diffstat (limited to 'src/core/api/qwebenginedownloadrequest.cpp')
| -rw-r--r-- | src/core/api/qwebenginedownloadrequest.cpp | 27 |
1 files changed, 11 insertions, 16 deletions
diff --git a/src/core/api/qwebenginedownloadrequest.cpp b/src/core/api/qwebenginedownloadrequest.cpp index 57823a7c9..7e3abed28 100644 --- a/src/core/api/qwebenginedownloadrequest.cpp +++ b/src/core/api/qwebenginedownloadrequest.cpp @@ -234,7 +234,7 @@ void QWebEngineDownloadRequestPrivate::setFinished() into the \l DownloadInProgress state and the downloading will begin. If the item is in any other state, then nothing will happen. - \sa finished(), stateChanged() + \sa isFinished, stateChanged() */ void QWebEngineDownloadRequest::accept() @@ -259,7 +259,7 @@ void QWebEngineDownloadRequest::accept() If the item is in any other state, then it will transition into the \l DownloadCancelled state without further effect. - \sa finished(), stateChanged() + \sa isFinished, stateChanged() */ void QWebEngineDownloadRequest::cancel() @@ -337,19 +337,11 @@ quint32 QWebEngineDownloadRequest::id() const } /*! - \fn void QWebEngineDownloadRequest::finished() + \fn void QWebEngineDownloadRequest::isPausedChanged() - This signal is emitted when the download finishes. + This signal is emitted whenever isPaused changes. - \sa state(), isFinished() -*/ - -/*! - \fn void QWebEngineDownloadRequest::isPausedChanged(bool isPaused) - - This signal is emitted whenever \a isPaused changes. - - \sa pause(), isPaused() + \sa pause(), isPaused */ /*! @@ -579,9 +571,11 @@ QString QWebEngineDownloadRequest::suggestedFileName() const } /*! - Returns whether this download is finished (completed, cancelled, or non-resumable interrupted state). + \property QWebEngineDownloadRequest::isFinished + \brief Whether this download is finished (completed, cancelled, + or non-resumable interrupted state). - \sa finished(), state(), + \sa state() */ bool QWebEngineDownloadRequest::isFinished() const @@ -591,7 +585,8 @@ bool QWebEngineDownloadRequest::isFinished() const } /*! - Returns whether this download is paused. + \property QWebEngineDownloadRequest::isPaused + \brief Whether this download is paused. \sa pause(), resume() */ |