Document how to recognize an invalid QTimeZone::OffsetData

It's mentioned in some of the functions, but the type's documentation
should also mention it.

Change-Id: Ia8ceb21ff30df1b5933782ae7d8bebe9f436404c
Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
This commit is contained in:
Edward Welbourne 2022-11-17 21:45:33 +01:00
parent 930f1cef78
commit 992b92d8c4

View File

@ -256,8 +256,12 @@ Q_GLOBAL_STATIC(QTimeZoneSingleton, global_tz);
\class QTimeZone::OffsetData
\inmodule QtCore
The time zone offset data for a given moment in time, i.e. the time zone
offsets and abbreviation to use at that moment in time.
The time zone offset data for a given moment in time.
This provides the time zone offsets and abbreviation to use at that moment
in time. When a function returns this type, it may use an invalid datetime
to indicate that the query it is answering has no valid answer, so check
\c{atUtc.isValid()} before using the results.
\list
\li OffsetData::atUtc The datetime of the offset data in UTC time.