Update custom Doxygen header and footer to match std ones closer (PR #26714)
VZ
Minimize discrepancies between the standard Doxygen version of these files and our ones.
Add useful clipboard.js which allows copying the contents of various snippets to clipboard.
Update HTTP links to use HTTPS.
Still keep our customizations, notably the custom header appearance and removal of the separating hr element before the footer.
This also removes an unnecessary #page_container div element which was never closed resulting, fixing the problem with invalid HTML output.
Closes #26710.
@Hibou57 This should fix the problem you reported, please let me know if you still see it.
@tierra Do you see anything wrong with these changes? TIA!
You can view, comment on, or merge this pull request online at:
https://github.com/wxWidgets/wxWidgets/pull/26714
Commit Summary
- 418bb5c Update custom Doxygen header and footer to match std ones closer
File Changes
(2 files)
Patch Links:
- https://github.com/wxWidgets/wxWidgets/pull/26714.patch
- https://github.com/wxWidgets/wxWidgets/pull/26714.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.
Yannick Duchêne
Hibou57 left a comment (wxWidgets/wxWidgets#26714)Yes, it should fix the issues (would have never though about removing the container).
I just to have to end building the documentation to check two other fixes for two other cases of invalid output.
—
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.
Bryan Petty
tierra left a comment (wxWidgets/wxWidgets#26714)I probably should have done this update with the Doxygen upgrade, but thanks for getting to it now.
Looks all good to me.
—
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#26714)Please, wait about three quarter of an hour, the time I rebuild the doc and do a check (I suspect an tiny error in the solution to the issue I opened).
—
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 pushed 2 commits.
- 0a5a0f6 Use standard "_blank" target in HTML instead of "_new"
- 6a7b644 Quote "target" attribute value everywhere for consistency
—
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#26714)Thanks, but I've run tidy on Doxygen HTML output and discovered many more errors, so I won't merge this for now and will try to fix them later (I'm pushing the fix for just one of them).
For the record, I used
$ tidy -q -e --mute MISSING_ATTRIBUTE --mute TRIM_EMPTY_ELEMENT $fileto avoid 2 errors in the header/footer respectively that appear in all files.
—
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#26714)Yes, there are more errors, that’s why I submitted two other issues with two other proposed fix. The tiny error I saw here, is a lack of understanding.
This is not #page_container which was never closed, this is #page-content. #page_container was opened and closes by wxWidgets sources. #page-content is opened by Doxygen and never closed. The hidden error of understanding is in saying the #page_container container was removed because never closed. It was not remove, only it's open tag was removed, not it's close tag. It's close tag is left and that's this close tag which now is closing the non-closed #page-content. However, there is a difference. In the patch I proposed, the location where #page-content was closed, was carefully choose. But it is not a big issue, this is just that the bottom bar is probably included in #page-content while it should not, because it does not include the top bar. These bars are typically considered as asides, not as part of page content.
—
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#26714)Oops, my apologies, I have not seen you added a comment which makes the thing clear:
</div><!-- doc-content -->
That’s Ok, I’m sorry.
The bottom bar (“Generated on ....”) is indeed included in it, but that's not important.
—
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 pushed 2 commits.
- 0a10934 Fix HTML generated by custom "appearance" and related aliases
- 6699441 Fix invalid HTML generated by Doxygen for "@c" inside "@itemdef"
—
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#26714)Fixes #26710 , #26716 , #26718 .
—
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.