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

Fill out doxygen from existing comments #228

Open
mysterymath opened this issue Oct 13, 2023 · 0 comments
Open

Fill out doxygen from existing comments #228

mysterymath opened this issue Oct 13, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation p1

Comments

@mysterymath
Copy link
Member

Our Doxygen for the SDK is woefullly incomplete, even in comparison to the comments already present in the SDK headers. This is likely just due to the comments being improperly formatted for Doxygen. We should go through in a big sweep and reformat all comments to an appropriate Doxygen style. Simultaneously, we can start requiring this style for new contributions.
@mysterymath mysterymath added documentation Improvements or additions to documentation p1 labels Oct 13, 2023
@mysterymath mysterymath changed the title Fill out doxygen from existing comment Fill out doxygen from existing comments Oct 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation p1
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@mysterymath