From e53a25cbaee50fdf6b9a4a118677709b47bac4cd Mon Sep 17 00:00:00 2001
From: Max Kellermann <max@duempel.org>
Date: Sun, 24 Nov 2013 19:28:04 +0100
Subject: event: add API documentation

---
 src/event/TimeoutMonitor.hxx | 4 ++++
 1 file changed, 4 insertions(+)

(limited to 'src/event/TimeoutMonitor.hxx')

diff --git a/src/event/TimeoutMonitor.hxx b/src/event/TimeoutMonitor.hxx
index 98e4e5564..aa2bbea39 100644
--- a/src/event/TimeoutMonitor.hxx
+++ b/src/event/TimeoutMonitor.hxx
@@ -28,6 +28,10 @@
 
 class EventLoop;
 
+/**
+ * This class monitors a timeout.  Use Schedule() to begin the timeout
+ * or Cancel() to cancel it.
+ */
 class TimeoutMonitor {
 #ifdef USE_EPOLL
 	friend class EventLoop;
-- 
cgit v1.2.3