Skip to content

Conversation

@VaiaPatta1985
Copy link
Contributor

@VaiaPatta1985 VaiaPatta1985 commented Oct 31, 2025

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:

  • 🚨 This PR does not introduce breaking changes.
  • All CI checks (GH Actions) pass.
  • Documentation is updated as needed.
  • Tests are updated or added as necessary.
  • Code is well-commented, especially in complex areas.
  • Git history is clean — commits are squashed to the minimum necessary.

Note

Names previously anonymous nested flags structs across MCPWM, PARLIO TX, and GDMA HAL headers to fix flag rendering in docs, and cleans up the CI public headers exceptions list.

  • Public headers (drivers/HAL):
    • Name nested flags structs to concrete types for clearer docs in:
      • MCPWM: 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_t and mcpwm_gpio_sync_src_config_t (mcpwm_sync.h), mcpwm_timer_config_t (mcpwm_timer.h).
      • PARLIO TX: parlio_tx_unit_config_t (parlio_tx.h).
      • GDMA HAL: gdma_hal_config_t (gdma_hal.h).
    • Add brief comments describing these flag groups for consistency.
  • CI:
    • Trim tools/ci/check_public_headers_exceptions.txt by removing several obsolete exception entries.

Written by Cursor Bugbot for commit 0d00805. This will update automatically on new commits. Configure here.

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.
@CLAassistant
Copy link

CLAassistant commented Oct 31, 2025

CLA assistant check
All committers have signed the CLA.

@github-actions
Copy link

github-actions bot commented Oct 31, 2025

Messages
📖 🎉 Good Job! All checks are passing!

👋 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 ...


This automated output is generated by the PR linter DangerJS, which checks if your Pull Request meets the project's requirements and helps you fix potential issues.

DangerJS is triggered with each push event to a Pull Request and modify the contents of this comment.

Please consider the following:
- Danger mainly focuses on the PR structure and formatting and can't understand the meaning behind your code or changes.
- Danger is not a substitute for human code reviews; it's still important to request a code review from your colleagues.
- To manually retry these Danger checks, please navigate to the Actions tab and re-run last Danger workflow.

Review and merge process you can expect ...


We do welcome contributions in the form of bug reports, feature requests and pull requests via this public GitHub repository.

This GitHub project is public mirror of our internal git repository

1. An internal issue has been created for the PR, we assign it to the relevant engineer.
2. They review the PR and either approve it or ask you for changes or clarifications.
3. Once the GitHub PR is approved, we synchronize it into our internal git repository.
4. In the internal git repository we do the final review, collect approvals from core owners and make sure all the automated tests are passing.
- At this point we may do some adjustments to the proposed change, or extend it by adding tests or documentation.
5. If the change is approved and passes the tests it is merged into the default branch.
5. On next sync from the internal git repository merged change will appear in this public GitHub repository.

Generated by 🚫 dangerJS against 0d00805

@github-actions github-actions bot changed the title Fixes for reference pages Fixes for reference pages (IDFGH-16714) Oct 31, 2025
@espressif-bot espressif-bot added the Status: Opened Issue is new label Oct 31, 2025
@suda-morris
Copy link
Collaborator

sha=0d008057c37403de087be761899ce5742420dab0

@suda-morris suda-morris added the PR-Sync-Merge Pull request sync as merge commit label Nov 3, 2025
@espressif-bot espressif-bot added Status: In Progress Work is in progress and removed Status: Opened Issue is new labels Nov 3, 2025
@espressif-bot espressif-bot added Status: Done Issue is done internally Resolution: NA Issue resolution is unavailable and removed Status: In Progress Work is in progress labels Nov 20, 2025
espressif-bot pushed a commit that referenced this pull request Nov 21, 2025
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.

Merges #17803
Closes #17804
@espressif-bot espressif-bot added Resolution: Done Issue is done internally and removed Resolution: NA Issue resolution is unavailable labels Nov 24, 2025
@Alvin1Zhang
Copy link
Collaborator

Thanks for contribution again, changes have been merged with ef4f475

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

PR-Sync-Merge Pull request sync as merge commit Resolution: Done Issue is done internally Status: Done Issue is done internally

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Reference pages: Some flag structs within configuration structs do not appear properly. (IDFGH-16715)

6 participants