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

PROS 4: Improve Header Documentation for Doxygen Integration #351

Open
WillXuCodes opened this issue Mar 7, 2022 · 0 comments
Open

PROS 4: Improve Header Documentation for Doxygen Integration #351

WillXuCodes opened this issue Mar 7, 2022 · 0 comments
Assignees
Labels
in progress This is currently being worked on
Projects

Comments

@WillXuCodes
Copy link
Member

Expected Behavior:

Currently, our documentation attempts to follow the doxygen release structure as much as possible, but there are some areas where this can be improved. Furthermore, we still need to add examples to the header files.

https://github.com/purduesigbots/pros/blob/664be01244b983f266501f785a99f4de2ff9b1c3/include/pros/motors.hpp

A good example of this can be found in the file above, which is is connected to our doxygen proof of concept that can be found here:

https://purduesigbots.github.io/pros-doxygen-docs/group__cpp-motors.html

@WillXuCodes WillXuCodes added this to To do in PROS 4 Mar 7, 2022
@omegaStag omegaStag self-assigned this Mar 8, 2022
@WillXuCodes WillXuCodes moved this from To do to In progress in PROS 4 Jun 4, 2022
@WillXuCodes WillXuCodes assigned ColexDev and unassigned omegaStag Jul 3, 2022
@ColexDev ColexDev added the in progress This is currently being worked on label Jul 20, 2022
@WillXuCodes WillXuCodes changed the title Improve Header Documentation for Doxygen Integration PROS 4: Improve Header Documentation for Doxygen Integration Aug 25, 2022
@Richard-Stump Richard-Stump assigned omegaStag and unassigned ColexDev Oct 18, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
in progress This is currently being worked on
Projects
No open projects
PROS 4
  
In progress
Development

No branches or pull requests

3 participants