store: Add dartdoc on UpdateMachine.dispose

chrisbobbe · chrisbobbe · commit b2cedd5687e0 · 2024-10-17T16:23:08.000-07:00
We'll add more to this soon.
diff --git a/lib/model/store.dart b/lib/model/store.dart
@@ -957,6 +957,10 @@ class UpdateMachine {
     await NotificationService.registerToken(store.connection, token: token);
   }
 
+  /// Cleans up resources.
+  ///
+  /// After this is called, the instance is not in a usable state
+  /// and should be abandoned.
   void dispose() { // TODO abort long-poll and close ApiConnection
     NotificationService.instance.token.removeListener(_registerNotificationToken);
   }

Original file line number	Diff line number	Diff line change
`@@ -957,6 +957,10 @@ class UpdateMachine {`
`957`	`957`	`await NotificationService.registerToken(store.connection, token: token);`
`958`	`958`	`}`
`959`	`959`
	`960`	`+ /// Cleans up resources.`
	`961`	`+ ///`
	`962`	`+ /// After this is called, the instance is not in a usable state`
	`963`	`+ /// and should be abandoned.`
`960`	`964`	`void dispose() { // TODO abort long-poll and close ApiConnection`
`961`	`965`	`NotificationService.instance.token.removeListener(_registerNotificationToken);`
`962`	`966`	`}`