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

Create proper documentation for dartx #129

Open
komape opened this issue Apr 13, 2021 · 2 comments
Open

Create proper documentation for dartx #129

komape opened this issue Apr 13, 2021 · 2 comments

Comments

@komape
Copy link
Contributor

komape commented Apr 13, 2021

As far as I know dartx's content is only documented in code and in README.md. Would be nice to create some real docs like dart itself does. I've never done this but I found dartdoc which looks promising. Could be set up as a GitHub Page.

@simc
Copy link
Owner

simc commented Apr 13, 2021

@komape Most (if not all) of the extension methods have docs. Pub.dev automatically generates them: https://pub.dev/documentation/dartx/latest/dartx/dartx-library.html

@komape
Copy link
Contributor Author

komape commented Apr 14, 2021

@leisim But for every method I have to open the seperate extension doc. Is there a way to show all docs of extensions that extend the same class in one doc (besides README.md)?

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

2 participants