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

doc: Add code and API documentation #16

Open
weltling opened this issue Mar 14, 2023 · 0 comments
Open

doc: Add code and API documentation #16

weltling opened this issue Mar 14, 2023 · 0 comments

Comments

@weltling
Copy link
Contributor

The public library API needs to be documented for the end consumer. It is thinkable to approach this using code inline documentation and then generate a readable format using tools like doxygen or similar. The exact method on how to implement this is to be evaluated and discussed closer, to achieve the best result.

@weltling weltling changed the title doc: Add inline code documentation doc: Add code and API documentation Mar 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant