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

Set up doxygen and sphynx #2

Open
Viha123 opened this issue Apr 12, 2024 · 0 comments
Open

Set up doxygen and sphynx #2

Viha123 opened this issue Apr 12, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation 💳 technical debt Shortcuts taken before that must be fixed later

Comments

@Viha123
Copy link
Contributor

Viha123 commented Apr 12, 2024

  • make sure all code that is pushed follows required style guidelines, and all drivers have a hpp file with doxygen styled comments in order to render things properly.
  • thinks to note are: do not copy the doxygen comments in the cpp files because there might be discrepencies between them. In cpp files use only.
  • more info will be in the wiki for style guide
@Viha123 Viha123 added documentation Improvements or additions to documentation 💳 technical debt Shortcuts taken before that must be fixed later labels Oct 27, 2024
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 💳 technical debt Shortcuts taken before that must be fixed later
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@Viha123