fix: replace the XML generator with a reflection-based one#1151
fix: replace the XML generator with a reflection-based one#1151gennaroprota wants to merge 3 commits intocppalliance:developfrom
Conversation
ℹ️ InfoNote Commit ✨ Highlights
🧾 Changes by Scope
🔝 Top Files
|
|
An automated preview of the documentation is available at https://1151.mrdocs.prtest2.cppalliance.org/index.html If more commits are pushed to the pull request, the docs will rebuild at the same URL. 2026-01-21 17:01:42 UTC |
|
I think we should be removing way more code than including for this PR to make sense. The test outputs haven't even changed. This should be a bug fix, not a refactor. The biggest problem with this generator is that it's not in sync with the metadata. And the reason this generator is out of sync is that we didn't have reflection, and manually keeping it in sync was too expensive and fragile. So what we want to do is let reflection handle the whole thing, and the whole generator will have only one or two functions that recursively iterate over everything to generate the metadata. 🥳 This means the XML outputs will change completely, as they now reflect everything in the metadata, which is what this generator was meant for. Our intention is not to recreate the broken version, but to recreate it with reflection. If we don't fix it, reflection would mean more code rather than less, as we now have to force reflection to recreate the errors we had without it (which is even harder than just keeping the original errors). And that's going to be extra code just to maintain it broken. I think another issue here is that we should probably address the other issue first, where we should remove those small workarounds from reflection to make it reflect into different key names. Only canonical names should be used. All generators should have access to the same fields with the same names. Making this happen is basically just the finalization of the previous issue we already merged. And maybe the @meta field is required to make that happen, since ambiguity might arise. Only after establishing the canonical field names can we use them to generate XML. 😅 |
|
What happened to this PR? I thought it would become more active after #1153 🚀 |
|
I removed the commit before pulling, after merging #1153, and GitHub closed it. I shouldn't have used the |
|
Oh 😅 |
gennaroprota
changed the title
gennaroprota
changed the title
Codecov Report❌ Patch coverage is ❌ Your patch check has failed because the patch coverage (89.91%) is below the target coverage (90.00%). You can increase the patch coverage or adjust the target coverage. Additional details and impacted files@@ Coverage Diff @@
## develop #1151 +/- ##
===========================================
- Coverage 86.49% 76.70% -9.79%
===========================================
Files 326 311 -15
Lines 23840 29110 +5270
Branches 0 5783 +5783
===========================================
+ Hits 20620 22329 +1709
- Misses 3220 4554 +1334
- Partials 0 2227 +2227 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
gennaroprota
force-pushed
the
develop
branch
3 times, most recently
from
0186462 to
2d636aa
Compare
This fixes the XML generator, which was out of sync with our metadata, by replacing it with a reflection-based implementation. The XML output structure changes completely, but contains equivalent information.
Reason: See the new code comment in codecov.yml.
gennaroprota
force-pushed
the
develop
branch
3 times, most recently
from
e7ce8e5 to
3ab54ea
Compare
This adds support for all five admonition types, with corresponding tests, plus tests for type-based friend declarations and pointers to members.
gennaroprota
force-pushed
the
develop
branch
from
3ab54ea to
e4c2097
Compare
3 participants
@alandefreitas: Please let me know what you think and... if I have commented it too much :-).