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

Documenting helper functions related to topData #280

Conversation

Ben-Bingham
Copy link
Contributor

Added some documentation to some functions that add/get/reserve value in topData, no code was modified.

I tried to format the documentation in the same way that documentation was formatted in other parts of the codebase.

src/osp/tasks/top_utils.h Outdated Show resolved Hide resolved
src/osp/tasks/top_utils.h Outdated Show resolved Hide resolved
src/osp/tasks/top_utils.h Outdated Show resolved Hide resolved
src/osp/tasks/top_utils.h Outdated Show resolved Hide resolved
@Ben-Bingham
Copy link
Contributor Author

Ben-Bingham commented May 11, 2024

I switched over the "param" portions of the macro docs to say "arglist" instead of both count and ID.

As jonesmz said in a previous comment count is needed for every call of the macro, so I will make another pull request that either changes the arguments in the macros to always include the count parameter, or as Capital-Asterisk suggested there are methods to count the number of arguments in a variadic argument, I will try to implement that method first.

If I can get it working with either method I will also update the documentation to still be accurate.

@jonesmz
Copy link
Member

jonesmz commented May 12, 2024

I wouldn't worry too much about rewriting the macro arguments.

Its enough to just document the "api" the implementation detail macros can use the shorthand notation without any issues

You can, of course, just don't consider that change a blocker for merging your PR.

I'll let cap merge it when its ready.

@Capital-Asterisk Capital-Asterisk merged commit a36993c into TheOpenSpaceProgram:master May 17, 2024
22 checks passed
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.

3 participants