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

Generate API documentation from code comments #25

Open
jimbojw opened this issue Jun 15, 2022 · 0 comments
Open

Generate API documentation from code comments #25

jimbojw opened this issue Jun 15, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@jimbojw
Copy link
Collaborator

jimbojw commented Jun 15, 2022

Currently, the source code includes verbose comments describing the various classes, members and methods. These should be exposed through generated documentation and made navigable from the web.
@jimbojw jimbojw added documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed labels Mar 14, 2023
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 good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@jimbojw