consumeQueue: document return

gmpassos · Aug 10, 2023 · 15629c5 · 15629c5
1 parent 28110c8
commit 15629c5
Showing 1 changed file with 1 addition and 0 deletions.
diff --git a/lib/src/win32_gui_base.dart b/lib/src/win32_gui_base.dart
@@ -516,6 +516,7 @@ class WindowMessageLoop {
   }
 
   /// Consumes the message queue.
+  /// - Returns the amount of processed messages.
   /// - Calls Win32 [PeekMessage] (removing from que queue).
   /// - Stops after consume reaches [maxMessages] or when the queue is empty.
   static int consumeQueue({int maxMessages = 3}) {