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

Add support for Doxygen documentation #203

Open
meshtag opened this issue Sep 18, 2023 · 0 comments
Open

Add support for Doxygen documentation #203

meshtag opened this issue Sep 18, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers

Comments

@meshtag
Copy link
Member

meshtag commented Sep 18, 2023

Is your feature request related to a problem? Please describe.
There is no developer documentation for the project at the moment. We should add this as the project becomes more mature.

Describe the solution you'd like
We can potentially use Doxygen to generate developer documentation for us. You can also use cool extensions like this one to get documentation boilerplate while writing the code. Perhaps we can make a rule of including developer documentation in all new PRs which will be accepted?
(/cc @zhanghb97 @FlagerLee @MbjYjbpivj @xlinsist @SForeKeeper @Avimitin et al)

Describe alternatives you've considered
Feel free to suggest any other alternatives that you might like, but we should stick to one tool for the entire codebase.

@meshtag meshtag added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers labels Sep 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant