-
Notifications
You must be signed in to change notification settings - Fork 8k
Fixes for reference pages (IDFGH-16714) #17803
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
I noticed a few structs where the flags didn't show up correctly in the docs. Naming the flag struct makes the individual flags appear properly in the nested struct. This should fix the corresponding reference pages. Please double-check the generated output.
👋 Hello VaiaPatta1985, we appreciate your contribution to this project! 📘 Please review the project's Contributions Guide for key guidelines on code, documentation, testing, and more. 🖊️ Please also make sure you have read and signed the Contributor License Agreement for this project. Click to see more instructions ...
Review and merge process you can expect ...
|
|
sha=0d008057c37403de087be761899ce5742420dab0 |
|
Thanks for contribution again, changes have been merged with ef4f475 |
Description
I noticed a few structs where the flags didn't show up correctly in the docs. Naming the flag struct makes the individual flags appear properly in the nested struct, so this should fix the corresponding reference pages. I also added a few comments for consistency.
Related
Fixes #17804
Testing
So far I haven't been able to get my Doxygen setup to work with this repo. I'm working on it and I'll update the description once I've managed to check the generated output. Please check if you can.
Checklist
Before submitting a Pull Request, please ensure the following:
Note
Names previously anonymous nested
flagsstructs across MCPWM, PARLIO TX, and GDMA HAL headers to fix flag rendering in docs, and cleans up the CI public headers exceptions list.flagsstructs to concrete types for clearer docs in:mcpwm_capture_timer_config_t(mcpwm_cap.h),mcpwm_comparator_config_t(mcpwm_cmpr.h),mcpwm_gpio_fault_config_t(mcpwm_fault.h),mcpwm_generator_config_t(mcpwm_gen.h),mcpwm_operator_config_t(mcpwm_oper.h),mcpwm_timer_sync_src_config_tandmcpwm_gpio_sync_src_config_t(mcpwm_sync.h),mcpwm_timer_config_t(mcpwm_timer.h).parlio_tx_unit_config_t(parlio_tx.h).gdma_hal_config_t(gdma_hal.h).tools/ci/check_public_headers_exceptions.txtby removing several obsolete exception entries.Written by Cursor Bugbot for commit 0d00805. This will update automatically on new commits. Configure here.