Skip to content

Lots of small doxygen fixes #2390

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

Merged
merged 2 commits into from
Apr 4, 2025
Merged

Lots of small doxygen fixes #2390

merged 2 commits into from
Apr 4, 2025

Conversation

lurch
Copy link
Contributor

@lurch lurch commented Apr 1, 2025

Fixes most of the issues identified in #2371 (thanks @magy00 )
Also fixes some things found by carefully examining the Doxygen error logs
Also updates the resets.h documentation (using section 2.14 of https://datasheets.raspberrypi.com/rp2040/rp2040-datasheet.pdf and section 7.5 of https://datasheets.raspberrypi.com/rp2350/rp2350-datasheet.pdf as reference)

We obviously never noticed before, but one of the things fixed here actually prevented pio_sm_init from appearing at https://www.raspberrypi.com/documentation/pico-sdk/hardware.html#functions-15 !

@lurch lurch added the documentation Improvements or additions to documentation label Apr 1, 2025
@JamesH65
Copy link
Contributor

JamesH65 commented Apr 1, 2025

Only a quick scan, but LGTM.

peterharperuk
peterharperuk previously approved these changes Apr 1, 2025
Copy link
Contributor

@peterharperuk peterharperuk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good

@peterharperuk peterharperuk added this to the 2.1.2 milestone Apr 1, 2025
@kilograham kilograham merged commit 5912699 into develop Apr 4, 2025
8 checks passed
@kilograham kilograham deleted the see_doxygen branch April 4, 2025 16:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants