Skip to content

doc: Fix cpu specific enum in doxygen#12737

Merged
dylad merged 3 commits intoRIOT-OS:masterfrom
MrKevinWeiss:pr/doc/gpioenumfix
Nov 18, 2019
Merged

doc: Fix cpu specific enum in doxygen#12737
dylad merged 3 commits intoRIOT-OS:masterfrom
MrKevinWeiss:pr/doc/gpioenumfix

Conversation

@MrKevinWeiss
Copy link
Contributor

Contribution description

Exclude overridden typedefs as otherwise they appear multiple times in the generated documentation.

This series fixes documentation for GPIO, I2C and SPI drivers.

Testing procedure

make doc read the periph driver enums for GPIO, I2C, and SPI

Issues/PRs references

Related to #10964

@MrKevinWeiss MrKevinWeiss added Area: doc Area: Documentation Impact: minor The PR is small in size and might only require a quick look of a knowledgeable reviewer CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR labels Nov 18, 2019
@MrKevinWeiss MrKevinWeiss self-assigned this Nov 18, 2019
@MrKevinWeiss
Copy link
Contributor Author

ping @yegorich

@MrKevinWeiss MrKevinWeiss requested a review from smlng November 18, 2019 10:47
Copy link
Contributor

@yegorich yegorich left a comment

Choose a reason for hiding this comment

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

This fixes the issue.

@MrKevinWeiss MrKevinWeiss added the Type: bug The issue reports a bug / The PR fixes a bug (including spelling errors) label Nov 18, 2019
Copy link
Member

@dylad dylad left a comment

Choose a reason for hiding this comment

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

proxy-ACK

@dylad dylad added the Reviewed: 5-documentation The documentation details of the PR were reviewed according to the maintainer guidelines label Nov 18, 2019
@dylad dylad added this to the Release 2020.01 milestone Nov 18, 2019
@dylad dylad merged commit 5f4b8ef into RIOT-OS:master Nov 18, 2019
@MrKevinWeiss MrKevinWeiss deleted the pr/doc/gpioenumfix branch November 18, 2019 13:23
@MrKevinWeiss
Copy link
Contributor Author

Thanks for the quick review!

@gschorcht
Copy link
Contributor

@MrKevinWeiss Thanks for figuring out the problem. I am a little ashamed because I reintroduced the problem with my PR #11808, although I knew the problem 😶

@MrKevinWeiss
Copy link
Contributor Author

It was @yegorich that found it. Also I was the one who merged the PR so the responsibility is shared.

@gschorcht
Copy link
Contributor

Thank you both.

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

Labels

Area: doc Area: Documentation CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR Impact: minor The PR is small in size and might only require a quick look of a knowledgeable reviewer Reviewed: 5-documentation The documentation details of the PR were reviewed according to the maintainer guidelines Type: bug The issue reports a bug / The PR fixes a bug (including spelling errors)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants