Incorrect use of @onlyfor in toplevel.h doc (PR #26296)
mcorino
wxTopLevelWindow::EnableFullScreenView is incorrectly documented with @OnlyFor{wxosx} as this method is available for all platforms but only actually works on MacOS (as documented).
You can view, comment on, or merge this pull request online at:
https://github.com/wxWidgets/wxWidgets/pull/26296
Commit Summary
- 2bc2ea8 Incorrect use of @onlyfor in toplevel.h doc
File Changes
(1 file)
- M interface/wx/toplevel.h (2)
Patch Links:
- https://github.com/wxWidgets/wxWidgets/pull/26296.patch
- https://github.com/wxWidgets/wxWidgets/pull/26296.diff
—
Reply to this email directly, view it on GitHub, or unsubscribe.
You are receiving this because you are subscribed to this thread.
VZ
vadz left a comment (wxWidgets/wxWidgets#26296)Shouldn't we document that this function doesn't do anything under non-macOS? I'll do this in addition to removing @onlyfor...
—
Reply to this email directly, view it on GitHub, or unsubscribe.
You are receiving this because you are subscribed to this thread.
mcorino
mcorino left a comment (wxWidgets/wxWidgets#26296)—
Reply to this email directly, view it on GitHub, or unsubscribe.
You are receiving this because you are subscribed to this thread.
VZ
vadz left a comment (wxWidgets/wxWidgets#26296)As I said the behaviour on other platforms is already correctly documented
I must be blind, but I just don't see it. Anyhow, adding an explicit note about it shouldn't harm.
—
Reply to this email directly, view it on GitHub, or unsubscribe.
You are receiving this because you are subscribed to this thread.
VZ
—
Reply to this email directly, view it on GitHub, or unsubscribe.
You are receiving this because you are subscribed to this thread.
mcorino
mcorino left a comment (wxWidgets/wxWidgets#26296)As I said the behaviour on other platforms is already correctly documented
I must be blind, but I just don't see it. Anyhow, adding an explicit note about it shouldn't harm.
I would have said this line was clear enough:
This function is currently only implemented in wxOSX and simply returns false in the other ports.
;-)
—
Reply to this email directly, view it on GitHub, or unsubscribe.
You are receiving this because you are subscribed to this thread.
VZ
vadz left a comment (wxWidgets/wxWidgets#26296)Wait, I may be blind but not crazy (I think?). This sentence is part of my commit which added it, it hadn't been there before!
—
Reply to this email directly, view it on GitHub, or unsubscribe.
You are receiving this because you are subscribed to this thread.
mcorino
mcorino left a comment (wxWidgets/wxWidgets#26296)Oh my, lol. You are absolutely right.
The line I saw before was the description of the return value:
@return @true if the button behaviour has been changed, @false if running
under another OS.
I mixed that up with what you added. My bad.
—
Reply to this email directly, view it on GitHub, or unsubscribe.
You are receiving this because you are subscribed to this thread.