openfoodfacts-dart
openfoodfacts-dart copied to clipboard
Rewriting documentation
Currently we have an outdated DOCUMENTATION.md, now I ask myself, if we should stick with this or if we should rather add more comments to the mainly used methods and then refer to the automatically generated documentation found here: https://openfoodfacts.github.io/openfoodfacts-dart/
@monsieurtanuki, any preferences here?
@M123-dev I don't read documentation, I read code.
So my suggestion is: we should add proper ///
comments, and let the documentation generator work on top of it for whoever reads documentation but not code.
And if needed add examples or tests, and link to them from README.md.