From 4ea591e7efdb63c26372af4af9507c5f57b42fcc Mon Sep 17 00:00:00 2001
From: Leena Miettinen <riitta-leena.miettinen@qt.io>
Date: Thu, 4 May 2017 11:09:46 +0200
Subject: [PATCH] Doc: Add info to QWebEngineDownloadItem::downloadProgress
docs
The documentation was not very informative when compared with the
docs for the similar QNetworkReply::downloadProgress signal.
Task-number: QTBUG-56979
Change-Id: Icade60317a7b3fd8aaa37770c60ce8f4f947382b
Reviewed-by: Kai Koehne <kai.koehne@qt.io>
---
src/webenginewidgets/api/qwebenginedownloaditem.cpp | 8 ++++++--
1 file changed, 6 insertions(+), 2 deletions(-)
diff --git a/src/webenginewidgets/api/qwebenginedownloaditem.cpp b/src/webenginewidgets/api/qwebenginedownloaditem.cpp
index 1950221c7..d578bf0e3 100644
--- a/src/webenginewidgets/api/qwebenginedownloaditem.cpp
+++ b/src/webenginewidgets/api/qwebenginedownloaditem.cpp
@@ -224,8 +224,12 @@ quint32 QWebEngineDownloadItem::id() const
/*!
\fn QWebEngineDownloadItem::downloadProgress(qint64 bytesReceived, qint64 bytesTotal)
- This signal is emitted whenever the download's \a bytesReceived or
- \a bytesTotal changes.
+ This signal is emitted to indicate the progress of the download request.
+
+ The \a bytesReceived parameter indicates the number of bytes received, while
+ \a bytesTotal indicates the total number of bytes expected to be downloaded.
+ If the size of the file to be downloaded is not known, \c bytesTotal will be
+ 0.
\sa totalBytes(), receivedBytes()
*/
--
GitLab