doc(auto_refresh): fix codegen syntax

bamlab · Jul 4, 2024 · ff7801e · ff7801e
1 parent 4a8c2d0
commit ff7801e
Showing 1 changed file with 20 additions and 2 deletions.
diff --git a/lib/src/auto_refresh_extension.dart b/lib/src/auto_refresh_extension.dart
@@ -16,7 +16,7 @@ extension AutoRefreshExtension<T> on AutoDisposeRef<T> {
   ///
   /// without codegen:
   /// ```dart
-  /// final myProvider = Provider<int>((ref) {
+  /// final dataProvider = Provider<int>((ref) {
   ///   ref.autoRefresh(const Duration(seconds: 1));
   ///   return fetchData();
   /// });
@@ -25,7 +25,7 @@ extension AutoRefreshExtension<T> on AutoDisposeRef<T> {
   /// with codegen:
   /// ```dart
   /// @riverpod
-  /// int myProvider(MyRef ref) {
+  /// int data(DataRef ref) {
   ///   ref.autoRefresh(const Duration(seconds: 1));
   ///   return fetchData();
   /// }
@@ -37,6 +37,24 @@ extension AutoRefreshExtension<T> on AutoDisposeRef<T> {
 
   /// Refreshes the value each time the app returns to foreground.
   ///
+  /// Example usages:
+  /// without codegen:
+  /// ```dart
+  /// final dataProvider = Provider<int>((ref) {
+  ///   ref.refreshWhenReturningToForeground();
+  ///   return fetchData();
+  /// });
+  /// ```
+  ///
+  /// with codegen:
+  /// ```dart
+  /// @riverpod
+  /// int data(DataRef ref) {
+  ///   ref.refreshWhenReturningToForeground();
+  ///   return fetchData();
+  /// }
+  /// ```
+  ///
   void refreshWhenReturningToForeground() {
     final listener = AppLifecycleListener(onResume: invalidateSelf);
     onDispose(listener.dispose);