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

[FEATURE]: Add support to generate developer documentation from Doxygen comments #15

Open
evan-palmer opened this issue Mar 2, 2023 · 0 comments
Labels
enhancement New feature or request needs triage This issue needs triage support

Comments

@evan-palmer
Copy link
Collaborator

Is your feature request related to a problem? Please describe

The implementation has been documented using Doxygen. To make it easier for new users and developers to get started with contributing to the project, it would be helpful to provide support for generating a site from the comments.

Describe the solution you'd like

Add the necessary files to generate a site from the doxygen comments. It will also be necessary to document the steps to generate this documentation.

Describe alternatives you've considered

If possible, it would be much more useful to generate this documentation as part of the user documentation (see Issue #14). However, if this is not possible, then a separate site may be used.

Implementation Ideas

Create the respective Doxygen configuration files needed to build the site.

Additional context

@evan-palmer evan-palmer added the enhancement New feature or request label Mar 2, 2023
@evan-palmer evan-palmer added the low priority This is a low priority issue label Mar 31, 2023
@evan-palmer evan-palmer added needs triage This issue needs triage support and removed low priority This is a low priority issue labels Aug 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request needs triage This issue needs triage support
Projects
None yet
Development

No branches or pull requests

1 participant