Type inconsistency in the documentation? (Issue #26696)

14 views
Skip to first unread message

Yannick Duchêne

unread,
Jul 14, 2026, 1:08:19 PM (23 hours ago) Jul 14
to wx-...@googlegroups.com, Subscribed
Hibou57 created an issue (wxWidgets/wxWidgets#26696)

I am so much surprised, I may be wrong, but it is confirmed indirectly (more on this confirmation later)

Here is one of the overloading of GetCentury: https://docs.wxwidgets.org/3.2/classwx_date_time.html#a7646edf22af11b72e503046c0bff3e17

Type argument tz is said to be a reference to a TimeZone instance, which is a class: https://docs.wxwidgets.org/3.2/classwx_date_time_1_1_time_zone.html . Its default value is said to be Local which is a member of the TZ enumeration, which is, an enum: https://docs.wxwidgets.org/3.2/classwx_date_time.html#a4db12283a6c06cea4c92528fbb7f88bba44955e1d9b9cb1259580226af61d33d8

I always assumed the Doxygen documentations are generated from the C++ source. But if it really is, either it should not compile, because there is a type mismatch, in in some way I never heard about, Local is implicitly used to make a TimeZone object? At least, the TimeZone class indeed has a constructor which gets a TZ argument.

Please, tell me what it is? The documentation not really generated from the source or a TimeZone implicitly created from a TZ?

For the funny story, I discovered this in Python. It is well known to not be type, but aside, there is MyPy to type--check it. It does this using definitions which are in files called stubs, and MyPy saw an error with an argument whose TimeZone and whose default is of class TZ.


Reply to this email directly, view it on GitHub, or unsubscribe.
Triage notifications, keep track of coding agent tasks and review pull requests on the go with GitHub Mobile for iOS and Android. Download it today!
You are receiving this because you are subscribed to this thread.Message ID: <wxWidgets/wxWidgets/issues/26696@github.com>

paulcor

unread,
Jul 14, 2026, 1:47:57 PM (23 hours ago) Jul 14
to wx-...@googlegroups.com, Subscribed

Closed #26696 as completed.


Reply to this email directly, view it on GitHub, or unsubscribe.
Triage notifications, keep track of coding agent tasks and review pull requests on the go with GitHub Mobile for iOS and Android. Download it today!

You are receiving this because you are subscribed to this thread.Message ID: <wxWidgets/wxWidgets/issue/26696/issue_event/27976987074@github.com>

paulcor

unread,
Jul 14, 2026, 1:47:59 PM (23 hours ago) Jul 14
to wx-...@googlegroups.com, Subscribed
paulcor left a comment (wxWidgets/wxWidgets#26696)

The TimeZone(TZ) constructor is implicitly called.


Reply to this email directly, view it on GitHub, or unsubscribe.
Triage notifications, keep track of coding agent tasks and review pull requests on the go with GitHub Mobile for iOS and Android. Download it today!

You are receiving this because you are subscribed to this thread.Message ID: <wxWidgets/wxWidgets/issues/26696/4972260314@github.com>

wsu

unread,
Jul 14, 2026, 10:12:22 PM (14 hours ago) Jul 14
to wx-dev
On Tuesday, July 14, 2026 at 1:08:19 PM UTC-4 Yannick Duchêne wrote:
Hibou57 created an issue (wxWidgets/wxWidgets#26696)

I always assumed the Doxygen documentations are generated from the C++ source. But if it really is, either it should not compile, because there is a type mismatch, in in some way I never heard about, Local is implicitly used to make a TimeZone object? At least, the TimeZone class indeed has a constructor which gets a TZ argument.

I will assume paulcor is correct when he says that there is no documentation error in this specific case, but if you look at the history of pull requests, you can find some PRs that fix mistakes in the documentation.  My understanding is that the Doxygen documentation is based on the files in .../wxWidgets/interface, which represents the public API.  The files in .../wxWidgets/include are implementation details.
Reply all
Reply to author
Forward
0 new messages