Document that wxDateTime::UNow() returns time in local time zone

This is its actual behaviour and it's the right thing to do, as it's
consistent with Now() -- even though the documentation wrongly stated
otherwise (since 324ab5e2db).

Also add a unit test checking that UNow() == Now(), except for the
milliseconds.

See #14148.

Closes #18524.

Closes https://github.com/wxWidgets/wxWidgets/pull/1594
This commit is contained in:
Vadim Zeitlin
2019-10-06 17:08:53 +02:00
parent 29781b1752
commit c92f9e0a17
2 changed files with 34 additions and 4 deletions

View File

@@ -1527,7 +1527,7 @@ public:
static bool IsWestEuropeanCountry(Country country = Country_Default);
/**
Returns the object corresponding to the current time.
Returns the object corresponding to the current time in local time zone.
Example:
@@ -1572,11 +1572,11 @@ public:
static wxDateTime Today();
/**
Returns the object corresponding to the current UTC time including the
Returns the object corresponding to the current time including the
milliseconds.
Notice that unlike Now(), this method creates a wxDateTime object
corresponding to UTC, not local, time.
Like Now(), this method creates the wxDateTime object corresponding to
the current moment in local time.
@see Now(), wxGetUTCTimeMillis()
*/