search

objectbox / objectbox-dart

Flutter database for super-fast Dart object persistence
https://docs.objectbox.io/getting-started
Apache License 2.0
970 stars 119 forks source link

API docs #66

Closed vaind closed 3 years ago

vaind commented 4 years ago

Public APIs should have Doc comments so they would show up on pub.dev docs page

greenrobot commented 4 years ago

Works in general, please update with more specific info.

vaind commented 3 years ago

Currently, the actual code docs are very sparse (mostly absent), see https://pub.dev/documentation/objectbox/latest/objectbox/objectbox-library.html

The point of this issue is to add and improve docs of the public APIs (e.g. Query<T>) and hide the APIs that don't have to be public, e.g. maybe things like ConditionGroupAll could be hidden as it really is just an implementation detail?

greenrobot-team commented 3 years ago

Added docs to reach 20% mark to get points. https://github.com/objectbox/objectbox-dart/commit/865ac1894372d19234b126c235df24a1e4b19cd5

vaind commented 3 years ago

All APIs are currently covered with docs. I've added a linter rule to notify about missing cases.

Before closing this issue, I need to make sure CI would catch if a new API was added without docs. Analyzer CI is broken now, so that has to wait until https://github.com/axel-op/dart-package-analyzer/issues/14 is closed