updated code docs and readme to include version 1.0.1

Author: c0nevskigamma

AUTHORS

@@ -0,0 +1,8 @@
+# Below is a list of people and organizations that have contributed
+# to the gamma_smart_pagination flutter package. Names should be added to the list like so:
+#
+#   Name/Organization <email address>
+
+Gamma Tech Ltd. <https://gammatech.mk>
+Zoran Conevski <zoran.conevski@gammatech.mk>
+Darko Sarev <darko.sarev@gammatech.mk>

CHANGELOG.md

@@ -1,3 +1,8 @@
+## 1.0.1
+* Updated code docs
+* Internal / non-public facing method names updated
+* Updated README
+
 ## 1.0.0
 * Breaking changes:
   - `GammaSmartController` is now `GammaController`

README.md

@@ -26,7 +26,7 @@ Flutter package for implementing infinite scroll pagination, with support for pu
 
 ## Installation
 
-Add `gamma_smart_pagination: ^0.0.1` to your `pubspec.yaml` dependencies. And import it:
+Add `gamma_smart_pagination: ^1.0.1` to your `pubspec.yaml` dependencies. And import it:
 
 ```dart
 import 'package:gamma_smart_pagination/gamma_smart_pagination.dart';

example/pubspec.lock

@@ -257,7 +257,7 @@ packages:
       path: ".."
       relative: true
     source: path
-    version: "1.0.0"
+    version: "1.0.1"
   glob:
     dependency: transitive
     description:

lib/src/controller/gamma_controller.dart

@@ -15,12 +15,12 @@ class GammaController extends ChangeNotifier {
     _status = const GammaControllerStatus.idle();
   }
 
-  /// [attachListener] method to add a listener to the controller.
+  /// add a listener to the controller.
   void attachListener(VoidCallback listener) {
     _listeners.add(listener);
   }
 
-  /// [detachListener] method to remove a listener from the controller.
+  /// remove a listener from the controller.
   /// @Params: [listener] is the listener to be removed.
   /// If no listener is passed, all listeners will be removed.
   void detachListener({VoidCallback? listener}) {
@@ -31,7 +31,7 @@ class GammaController extends ChangeNotifier {
     }
   }
 
-  /// [listeners] getter for the controller listeners.
+  /// getter for the controller listeners.
   List<VoidCallback> get listeners => _listeners;
 
   /// Whether any [Listener] objects have attached themselves to the
@@ -41,66 +41,66 @@ class GammaController extends ChangeNotifier {
   /// must not be called.
   bool get hasClients => _listeners.isNotEmpty;
 
-  /// [GammaControllerStatus] getter for the controller status.
+  /// getter for the controller status.
   GammaControllerStatus get status => _status;
 
-  /// [statusString] getter for the controller status as a string.
+  /// getter for the controller status as a string.
   String get statusString => _status.toString();
 
-  /// [setIdle] method to set the controller status to idle.
+  /// set the controller status to idle.
   /// Use this method when the widget is first rendered.
   /// And also it can be used after the first load of data is completed.
   void setIdle() {
     _status = const GammaControllerStatus.idle();
     notifyListeners();
   }
 
-  /// [setLoading] method to set the controller status to loading.
+  /// set the controller status to loading.
   /// Use this method when the widget is loading more data.
   void setLoading() {
     _status = const GammaControllerStatus.loading();
     notifyListeners();
   }
 
-  /// [setLoadingCompleted] method to set the controller status to loadingCompleted.
+  /// set the controller status to loadingCompleted.
   /// Use this method when the widget is done loading more data.
   /// But there is still more data to load.
   void setLoadingCompleted() {
     _status = const GammaControllerStatus.loadingCompleted();
     notifyListeners();
   }
 
-  /// [setLoadingFailed] method to set the controller status to loadingFailed.
+  /// set the controller status to loadingFailed.
   /// Use this method when the widget failed to load more data.
   /// @Params: [errorMessage] is the error message that will be displayed in the footer.
   void setLoadingFailed({String? errorMessage}) {
     _status = GammaControllerStatus.loadingFailed(errorMessage: errorMessage);
     notifyListeners();
   }
 
-  /// [setNoMoreData] method to set the controller status to noMoreData.
+  /// set the controller status to noMoreData.
   /// Use this method when the widget has loaded all the data.
   /// AND there is no more data to load.
   void setNoMoreData() {
     _status = const GammaControllerStatus.noMoreData();
     notifyListeners();
   }
 
-  /// [setRefreshFailed] method to set the controller status to refreshingFailed.
+  /// set the controller status to refreshingFailed.
   /// Use this method when the widget failed to refresh the data.
   void setRefreshFailed() {
     _status = const GammaControllerStatus.refreshingFailed();
     notifyListeners();
   }
 
-  /// [setRefreshing] method to set the controller status to refreshing.
+  /// set the controller status to refreshing.
   /// Use this method when the widget is refreshing the data.
   void setRefreshing() {
     _status = const GammaControllerStatus.refreshing();
     notifyListeners();
   }
 
-  /// [setRefreshingCompleted] method to set the controller status to refreshingCompleted.
+  /// set the controller status to refreshingCompleted.
   /// Use this method when the widget is done refreshing the data.
   void setRefreshingCompleted() {
     _status = const GammaControllerStatus.refreshingCompleted();

lib/src/widget/gamma_smart_pagination.dart

@@ -2,47 +2,48 @@ import 'package:flutter/material.dart';
 import '../../gamma_smart_pagination.dart';
 import '../helpers/extensions.dart';
 
-/// [GammaSmartPagination] is a wrapper widget for scrollable widgets that enables
+/// Wrapper widget for scrollable widgets that enables
 /// pull to refresh and infinite scrolling pagination.
 class GammaSmartPagination extends StatefulWidget {
-  /// [GammaController] that will be used to control the status of the pagination.
+  /// Controls for the status of the pagination.
   final GammaController gammaSmartController;
 
-  /// [ScrollController] that will be used to control the scroll position of the list internally.
+  /// Controls the scroll position of the list internally.
   final ScrollController scrollController;
 
-  /// [onLoadMore] is the callback that will be called when the user scrolls to the bottom of the list.
+  /// Callback that will be called when the user scrolls to the bottom of the list.
   final Future<void> Function()? onLoadMore;
 
-  /// [onRefresh] is the callback that will be called when the user pulls down the list.
+  /// Callback that will be called when the user pulls down the list.
   final Future<void> Function()? onRefresh;
 
-  /// [@required][child] is the scrollable child widget that will be wrapped by the GammaSmartPagination widget.
+  /// Scrollable child widget that will be wrapped by the GammaSmartPagination widget.
+  /// It must have physics set to [NeverScrollableScrollPhysics] and shrinkWrap set to true.
   final Widget child;
 
-  /// [@required][itemCount] is the number of items in the list.
+  /// Number of items in the list.
   final int itemCount;
 
-  /// [noInitialDataWidget] is the widget that will be displayed when the list is empty.
+  /// Widget that will be displayed when the list is empty.
   final Widget? noInitialDataWidget;
 
-  /// [noMoreDataWidget] is the widget that will be displayed when the list has loaded all the data.
+  /// Widget that will be displayed when the list has loaded all the data.
   final Widget? noMoreDataWidget;
 
-  /// [loadingFailedWidget] is the widget that will be displayed when the list failed to load more data.
+  /// Widget that will be displayed when the list failed to load more data.
   final Widget? loadingFailedWidget;
 
-  /// [refreshFailedWidget] is the widget that will be displayed when the list failed to refresh.
+  /// Widget that will be displayed when the list failed to refresh.
   final Widget? refreshFailedWidget;
 
-  /// [loadingIndicator] is the widget that will be displayed when the list is loading more data.
+  /// Widget that will be displayed when the list is loading more data.
   final Widget? loadingIndicator;
 
-  /// [enableLogging] is a boolean that will enable logging when set to true.
+  /// Enable logging when set to true.
   final bool enableLogging;
 
-  /// [GammaSmartPagination] is a 2 in 1 widget that acts as a wrapper for scrollable widgets.
-  /// It enables pull to refresh and infinite scrolling pagination.
+  /// Wrapper for scrollable widgets that enables
+  /// pull to refresh and infinite scrolling pagination.
   ///
   /// Typically used as wrapper for [ListView], [GridView].
   ///
@@ -71,13 +72,13 @@ class GammaSmartPagination extends StatefulWidget {
 }
 
 class _GammaSmartPaginationState extends State<GammaSmartPagination> {
-  /// [GammaController] that will be used to control the status of the pagination.
+  /// Controls the status of the pagination.
   GammaController get _customController => widget.gammaSmartController;
 
-  /// [ScrollController] that will be used to control the scroll position of the list internally.
+  /// Controls the scroll position of the list internally.
   ScrollController get _scrollController => widget.scrollController;
 
-  /// [sensitivityFactor] is the factor that will be used to determine if the user has reached the bottom of the list.
+  /// factor to determine if the user has reached the bottom of the list.
   static const double _sensitivityFactor = 200.0;
 
   final wipedGrayTextColorStyle = TextStyle(color: Colors.grey.shade400);
@@ -97,32 +98,33 @@ class _GammaSmartPaginationState extends State<GammaSmartPagination> {
 
   @override
   void initState() {
-    _scrollController.addListener(onBottomReached);
+    _scrollController.addListener(_onBottomReached);
     super.initState();
   }
 
-  /// [onBottomReached] is called when the user scrolls to the bottom of the list.
-  void onBottomReached() {
+  /// Callback when the user scrolls to the bottom of the list.
+  void _onBottomReached() {
     final maxScroll = _scrollController.position.maxScrollExtent;
     final currentScroll = _scrollController.position.pixels;
     if (currentScroll >= (maxScroll - _sensitivityFactor)) {
       if (_customController.shouldLoadMore && currentScroll > 0) {
         _logLoadMoreCalled();
-        onLoadMore();
+        _onLoadMore();
       }
     }
   }
 
-  /// [onLoadMore] is called when the user scrolls to the bottom of the list.
-  Future<void> onLoadMore() async {
+  /// Callback when the user scrolls to the bottom of the list.
+  Future<void> _onLoadMore() async {
     _customController.setLoading();
     await widget.onLoadMore?.call();
   }
 
-  /// [onRefresh] is called when the user pulls down the list.
-  Future<void> onRefresh() async {
+  /// Called when the user pulls down the list.
+  Future<void> _onRefresh() async {
+    _logRefreshCalled();
     _customController.setRefreshing();
-    await widget.onRefresh?.call();
+    return await widget.onRefresh?.call();
   }
 
   @override
@@ -137,10 +139,7 @@ class _GammaSmartPaginationState extends State<GammaSmartPagination> {
 
   RefreshIndicator _buildDataWidget() {
     return RefreshIndicator(
-        onRefresh: () async {
-          _logRefreshCalled();
-          return widget.onRefresh?.call();
-        },
+        onRefresh: () async => _onRefresh(),
         child: SingleChildScrollView(
           controller: _scrollController,
           physics: const AlwaysScrollableScrollPhysics(),

pubspec.yaml

@@ -1,6 +1,6 @@
 name: gamma_smart_pagination
 description: Flutter package for infinite scrolling pagination, which supports pull down to refresh and pull up to load more.
-version: 1.0.0
+version: 1.0.1
 repository: https://github.com/GammaTechMK/gamma_smart_pagination
 
 environment: