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.

Sign up for GitHub

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

Jump to bottom

doxygen fixes #138

Merged
merged 2 commits into from
Feb 5, 2024
Merged

doxygen fixes #138

merged 2 commits into from
Feb 5, 2024

Conversation

t4c1
Copy link
Contributor

@t4c1 t4c1 commented Feb 2, 2024 •
edited
Loading

Various fixes to doxygen, mostly in device fucntions:

  • removed mentions of accessors from functions that only accept pointers
  • improved wording of some parameter descriptions
  • some typos
  • removed the outdated big comment that attempted to describe interactions between functions.

Checklist

Tick if relevant:

  • [N/A] New files have a copyright
  • [N/A] New headers have an include guards
  • [N/A] API is documented with Doxygen
  • [N/A] New functionalities are tested
  • [N/A] Tests pass locally
  • Files are clang-formatted

hjabird
hjabird previously approved these changes Feb 2, 2024
View reviewed changes
Rbiessy
Rbiessy previously approved these changes Feb 2, 2024
View reviewed changes
@t4c1 t4c1 dismissed stale reviews from Rbiessy and hjabird via 1168718 February 2, 2024 13:08
@t4c1 t4c1 merged commit 5963edf into main Feb 5, 2024
1 check passed
@t4c1 t4c1 deleted the doxy_fix branch February 5, 2024 08:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Rbiessy Rbiessy Rbiessy approved these changes

@AD2605 AD2605 AD2605 approved these changes

@hjabird hjabird hjabird left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@t4c1 @hjabird @Rbiessy @AD2605