Update xrc_format.h (PR #26719)
Yannick Duchêne
Fixes #26718
You can view, comment on, or merge this pull request online at:
https://github.com/wxWidgets/wxWidgets/pull/26719
Commit Summary
- 63f9068 Update xrc_format.h
File Changes
(1 file)
Patch Links:
- https://github.com/wxWidgets/wxWidgets/pull/26719.patch
- https://github.com/wxWidgets/wxWidgets/pull/26719.diff
—
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.
VZ
vadz left a comment (wxWidgets/wxWidgets#26719)Thanks, and I don't really mind applying this, but do you understand why is the current code wrong?
Also, doesn't @c map to <code> tag rather than <tt>?
—
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.
Yannick Duchêne
Hibou57 left a comment (wxWidgets/wxWidgets#26719)but do you understand why is the current code wrong?
The current code is not wrong, it assumes what is specified in Doxygen’s doc, but what is done is not as specified. It seems there are bugs in Dowygen. In the previous case about the unclosed #doc-content, some things shown it was Ok in wxWidgets, but not in Doxygen, which is nice but needs some fix.
Also, doesn't @c map to
tag rather than ?
Yes, but <tt> could map to <code> too, and I don’t know why it does not. Instead, it maps to a same CSS rendering only.
May though about having a look at Doxygen source, but it would take a lot of time, especially that I forget C++ since long. Also, the version used by wxWidgets is not the mos up to date. That said, it makes me think about trying with the last version, just to see it it’s different.
—
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.
Yannick Duchêne
Hibou57 left a comment (wxWidgets/wxWidgets#26719)I agree the solution is not perfect, but at least it is not a hack, it is clean. The same as with the solution to #26716
Or if wxWidgets is not to be with Doxygen 1.15 all the time, then it will need more investigations in Doxygen sources to find a fix there and suggest them to apply it.
—
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.
VZ
vadz left a comment (wxWidgets/wxWidgets#26719)Yes, but
<tt>could map to<code>too, and I don’t know why it does not. Instead, it maps to a same CSS rendering only.<tt>is mentioned in the doc for@c.
Sorry, I don't understand this. What I meant was: why do you use <tt> in your patch instead of <code>? Should I change it to use the latter?
—
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.
Yannick Duchêne
Hibou57 left a comment (wxWidgets/wxWidgets#26719)Sorry, I don't understand this. What I meant was: why do you use
<tt>in your patch instead of<code>? Should I change it to use the latter?
Well, it is not instead of code it is instead of @c. Both are semantically the same, the only difference is syntactic. @c accepts a single word, while <tt> accepts multiple words. So with a single word, @c is shorter in sources which helps readability (@c word vs <tt>word</tt>). Although @c and <tt> should do the same, they don’t and they don’t in a way which additionally seems strange to me, for the reason explained before: either both should output <code> or both should output <span class="tt">. To output <code> is better, because it preserves the semantic in HTML.
A justification
https://www.doxygen.nl/manual/commands.html#cmdc says:
\c <word>Displays the argument
<word>using a typewriter font. Use this to refer to a word of code. Equivalent to<tt>word[</tt>.
[…]
[…] To have multiple words in typewriter font use multiple words.
When they say “a typewriter font”, they mean a mono-spaced font, like typically used to style a <code> element.
—
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.
VZ
vadz left a comment (wxWidgets/wxWidgets#26719)Sorry, I don't understand your reply. You seem to be agreeing that using <code> is better but at the same time object to using it.
I've included a commit fixing this in the way I proposed in #26714, please test it and let me know if you see any problems with it.
—
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.
Yannick Duchêne
Hibou57 left a comment (wxWidgets/wxWidgets#26719)I have not objected using <code>, I just wanted to use Doxygen command like the original source did, to stay close to its intent and style.
Yes, will test it
Thanks for your regards
—
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.
Yannick Duchêne
Hibou57 left a comment (wxWidgets/wxWidgets#26719)It’s fine, to me at least.
Just a pedantic comment. In overview_xrcformat.html , all the names listed in the “Property” columns seems should be the same. But since the <code>word</code> notation is heavy and a correctly working @c word notation would have been better, it may be better to leave it as-is.
—
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.