Skip to content
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

Missing hardware_busctrl Doxygen group #2035

Open
lurch opened this issue Nov 12, 2024 · 0 comments
Open

Missing hardware_busctrl Doxygen group #2035

lurch opened this issue Nov 12, 2024 · 0 comments
Assignees
Milestone

Comments

@lurch
Copy link
Contributor

lurch commented Nov 12, 2024

There's a simple script here which checks that every \ingroup has a matching \defgroup (used with various Doxygen tags).

Most of the errors it reports are red-herrings caused by various CMSIS headers, but two of the errors that it reports look genuine:

src/rp2040/hardware_structs/include/hardware/structs/busctrl.h uses \ingroup hardware_busctrl which was never defined
src/rp2350/hardware_structs/include/hardware/structs/busctrl.h uses \ingroup hardware_busctrl which was never defined

and indeed doing a git grep shows that this group is never defined anywhere:

$ git grep hardware_busctrl
src/rp2040/hardware_structs/include/hardware/structs/busctrl.h: *  \ingroup hardware_busctrl
src/rp2350/hardware_structs/include/hardware/structs/busctrl.h: *  \ingroup hardware_busctrl

These files are both auto-generated, so I'll assign this (very low priority) issue to @matiasilva

I dunno what the "right" fix is here, but perhaps the following results suggests that the easiest solution would be just to get rid of these \ingroup hardware_busctrl lines from these autogenerated headers? 🤷‍♂️

$ git -C src/rp2040/hardware_structs grep "defgroup"
$ git -C src/rp2350/hardware_structs grep "defgroup"
$ git -C src/rp2040/hardware_structs grep "ingroup"
include/hardware/structs/busctrl.h: *  \ingroup hardware_busctrl
include/hardware/structs/clocks.h: *  \ingroup hardware_clocks
include/hardware/structs/clocks.h: *  \ingroup hardware_clocks
include/hardware/structs/io_bank0.h: * \ingroup hardware_gpio
include/hardware/structs/resets.h: *  \ingroup hardware_resets
$ git -C src/rp2350/hardware_structs grep "ingroup"
include/hardware/structs/busctrl.h: *  \ingroup hardware_busctrl
include/hardware/structs/clocks.h: *  \ingroup hardware_clocks
include/hardware/structs/clocks.h: *  \ingroup hardware_clocks
include/hardware/structs/io_bank0.h: * \ingroup hardware_gpio
include/hardware/structs/resets.h: *  \ingroup hardware_resets
include/hardware/structs/ticks.h: *  \ingroup hardware_ticks
@kilograham kilograham modified the milestones: 2.1.0, 2.2.0 Nov 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants