Skip to content

sys/psa_crypto: drop no-op Doxygen statements#21393

Merged
mguetschow merged 1 commit intoRIOT-OS:masterfrom
maribu:sys/psa_crypto/drop-bogus-doc
Apr 10, 2025
Merged

sys/psa_crypto: drop no-op Doxygen statements#21393
mguetschow merged 1 commit intoRIOT-OS:masterfrom
maribu:sys/psa_crypto/drop-bogus-doc

Conversation

@maribu
Copy link
Copy Markdown
Member

@maribu maribu commented Apr 9, 2025

Contribution description

This drops a lot of "no-op" Doxygen statements, such as @param foo <description> where <description> is the empty string.

This now also provides no documentation, but a lot more compact.

Testing procedure

The generated documentation should not contain any documentation about the parameters, but the headers should be a lot shorter.

Issues/PRs references

None

This drops a lot of "no-op" Doxygen statements, such as
`@param foo <description>` where `<description>` is the empty string.

This now also provides no documentation, but a lot more compact.
@github-actions github-actions bot added the Area: sys Area: System label Apr 9, 2025
@maribu maribu requested review from Einhornhool and mguetschow April 9, 2025 19:02
@crasbe crasbe added the CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR label Apr 9, 2025
@riot-ci
Copy link
Copy Markdown

riot-ci commented Apr 9, 2025

Murdock results

✔️ PASSED

51ed6f7 sys/psa_crypto: drop no-op Doxygen statements

Success Failures Total Runtime
1 0 1 01m:16s

Artifacts

Copy link
Copy Markdown
Contributor

@mguetschow mguetschow left a comment

Choose a reason for hiding this comment

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

Thanks for the cleanup!

@mguetschow mguetschow enabled auto-merge April 10, 2025 08:15
@mguetschow mguetschow added this pull request to the merge queue Apr 10, 2025
Merged via the queue into RIOT-OS:master with commit e372d80 Apr 10, 2025
27 checks passed
@mguetschow mguetschow added this to the Release 2025.04 milestone Apr 10, 2025
@maribu maribu deleted the sys/psa_crypto/drop-bogus-doc branch April 16, 2025 07:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Area: sys Area: System CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants