From 3da03b3b7b906d3991a991a54a59d7fe3a8e6caf Mon Sep 17 00:00:00 2001 From: Vadim Zeitlin Date: Tue, 12 Jan 2021 03:14:18 +0100 Subject: [PATCH] Clarify values returned by wxWebRequest progress methods Make it clear which values change and which remain constant. --- interface/wx/webrequest.h | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) diff --git a/interface/wx/webrequest.h b/interface/wx/webrequest.h index 15abd01074..db900dabb7 100644 --- a/interface/wx/webrequest.h +++ b/interface/wx/webrequest.h @@ -367,13 +367,26 @@ public: */ State GetState() const; - /// Returns the number of bytes sent to the server. + /** + Returns the number of bytes sent to the server. + + This value grows monotonically from 0 to GetBytesExpectedToSend(). + */ wxFileOffset GetBytesSent() const; - /// Returns the number of bytes expected to be sent to the server. + /** + Returns the total number of bytes expected to be sent to the server. + + This value stays unchanged throughout the request duration. + */ wxFileOffset GetBytesExpectedToSend() const; - /// Returns the number of bytes received from the server. + /** + Returns the number of bytes received from the server. + + This value grows monotonically from 0 to GetBytesExpectedToReceive() + (unless it is unknown). + */ wxFileOffset GetBytesReceived() const; /**