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

doc: re-generate api docs with functions in the same order as in .h files #47

Merged
merged 1 commit into from
Jun 22, 2024

Conversation

luisdbianchi
Copy link
Member

Description

The API docs were generated with functions ordered alphabetically. The generate-sphinx-definitions script now generates the lists in the same order as the .h files, this PR updates all the documentation to use this new sorting.

Checklist

  • I have read followed CONTRIBUTING.md
    • I have added tests
    • I have updated the documentation
    • I have updated the CHANGELOG
  • Are there any breaking changes?
    • If yes: I have marked them in the CHANGELOG
  • Does this PR introduce any platform specific code?
  • Security: Does this PR potentially affect security?
  • Performance: Does this PR potentially affect performance?

Copy link

MISRA C Logo

MISRA Guideline Compliance Summary

Commit: 9abefb212c06cd3f70565a80ac5c931435c7154f
Date: 2024-06-21
Guidelines: MISRA C 2012
Checking Tool: Cppcheck
Result: Compliant ✅

🎉 No MISRA C 2012 Violations Found!

You can download the complete report from: MISRA C Report

Copy link

codecov bot commented Jun 21, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

📢 Thoughts on this report? Let us know!

@AngelCastilloB AngelCastilloB merged commit 7f0a316 into main Jun 22, 2024
7 checks passed
@AngelCastilloB AngelCastilloB deleted the feat/update-api-docs branch June 22, 2024 09:35
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

Successfully merging this pull request may close these issues.

None yet

2 participants