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

Improve code documentation #48

Open
schultek opened this issue Nov 28, 2022 · 0 comments
Open

Improve code documentation #48

schultek opened this issue Nov 28, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@schultek
Copy link
Owner

There is still a lot of undocumented code in the core package. At least all important classes and methods should be documented using doc comments.

We should also further customize the generated api docs and add topics for organization using a dartdoc_options.yaml file.
See here for documentation and here for an example.
@schultek schultek added the documentation Improvements or additions to documentation label Nov 28, 2022
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
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@schultek