-
Notifications
You must be signed in to change notification settings - Fork 89
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
Move documentation to Doxygen comments #687
Comments
hi @ihhub, I looked into this issue, and a few points came up, namely
cheers |
Hi @zafar-hussain , documentation generation in Doxygen is based on comments in the source code. What previously was done is to update the documentation manually which absolutely not a proper approach. Doxygen allows to generate the documentation automatically. Doxygen can be also configured which types of tiles to be scanned. I think the first step is to add Doxygen as a part of GitHub Actions pipeline at the least to generate documentation.
|
hi @ihhub thanks for the reply, for point 3, I allowed doxygen to parse *.md files too, and it created nice looking help pages from them too, |
Hi @zafar-hussain , looks great, How would you like to proceed with it? |
Hi @ihhub, Sorry, I can't work on this project due to lack of time. Cheers |
This is not scalable to keep a separate file for documentation. There are many tools in the wild and one of them is Doxygen which is designed just for this purpose.
The text was updated successfully, but these errors were encountered: