jushutch / swiping_card_deck

A widget for swiping through a deck of cards with gestures or buttons.
https://pub.dev/packages/swiping_card_deck
BSD 3-Clause "New" or "Revised" License
13 stars 10 forks source link

Add dartdoc comments to swiping_gesture_detector.dart #1

Open jushutch opened 3 years ago

jushutch commented 3 years ago

There are currently no dartdoc comments in swiping_gesture_detector.dart. Comments should be added for all public properties, classes, and methods. For a good example, look at the comments in swiping_card_deck.dart. Follow the guidelines outlined in Effective Dart Documentation. To verify that formatting is correct, generate the package API documentation using dartdoc. The generated documentation should look similar to the existing documentation for swiping_card_deck.dart.