-
Notifications
You must be signed in to change notification settings - Fork 7.9k
include: devicetree: gpio: add doxygen to all GPIO headers header files #95349
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
include: devicetree: gpio: add doxygen to all GPIO headers header files #95349
Conversation
8d07fc5
to
4530be0
Compare
5617709
to
5f805e0
Compare
Add doxygen documentation for this header. Signed-off-by: Benjamin Cabé <[email protected]>
Add doxygen documentation for this header. Also fix typo for ARDUINO_NANO_HEADER_A5. Signed-off-by: Benjamin Cabé <[email protected]>
Add doxygen documentation for this header. Signed-off-by: Benjamin Cabé <[email protected]>
Add doxygen documentation for this header. Signed-off-by: Benjamin Cabé <[email protected]>
Add doxygen documentation for this header. Signed-off-by: Benjamin Cabé <[email protected]>
For all GPIO headers/connectors, add a short mention of the header file that can be used to access pin numbers macros. Signed-off-by: Benjamin Cabé <[email protected]>
5f805e0
to
f2e4c37
Compare
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM and thanks! Since we're making this more visible, I would take the opportunity to add a note to the Uno R3 layout that mentions something along those lines:
Usually Arduino pins are numbered starting from the digital pins, and the analog pins follow. Note the sequence here instead starts from the analog pins, so
D0 == 6
.
(unfortunate choice when it was added; not sure we can switch now without breaking compatibility).
I think I might be missing your point. Isn't the whole point of now having macros that folks won't really have to worry about the underlying actual value, and hence why we clearly encourage folks to use the constants? https://github.com/zephyrproject-rtos/zephyr/blob/main/dts/bindings/gpio/arduino-header-r3.yaml#L47-L48 |
Sure, but Arduino users have been trained to numbers unfortunately, so it is extremely tempting for people interested in the Arduino connectors to try using them anyway. I was pointing out that while other connectors happen to match with our standard numbering, |
Document Arduino MKR, ST Morpho etc. so as to have them conveniently visible in the API reference
https://builds.zephyrproject.io/zephyr/pr/95349/docs/doxygen/html/group__devicetree-gpio-pin-headers.html
This builds on top of #95320 as I basically realized it would be nice to have all GPIO nexuses showing up in the docs. I will rebase once the other PR is merged but would appreciate feedback on everything but the first 3 commits in this PR.