From 009bf7f5edca80ec95716559cf33f00a31aaf16c Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?S=C3=B6nke=20Ludwig?= <sludwig@outerproduct.org>
Date: Thu, 26 Nov 2020 10:45:32 +0100
Subject: [PATCH] Add return value documentation to doProcessEvents.

---
 source/eventcore/drivers/posix/driver.d | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/source/eventcore/drivers/posix/driver.d b/source/eventcore/drivers/posix/driver.d
index e56f6d9..dc2b50d 100644
--- a/source/eventcore/drivers/posix/driver.d
+++ b/source/eventcore/drivers/posix/driver.d
@@ -336,6 +336,13 @@ package class PosixEventLoop {
 
 	protected abstract void dispose();
 
+	/** Waits for and processes a single batch of events.
+
+		Returns:
+			Returns `false` if no event was received before the timeout expired
+			and `true` if either an event was received, or if the wait was
+			interrupted by an error or signal.
+	*/
 	protected abstract bool doProcessEvents(Duration dur);
 
 	/// Registers the FD for general notification reception.