From f8ff5979636b8fd012dbff78ed445ae87ebba818 Mon Sep 17 00:00:00 2001
From: Max Kellermann <max@musicpd.org>
Date: Thu, 15 Oct 2020 16:55:29 +0200
Subject: [PATCH] event/SocketEvent: document Close()

---
 src/event/SocketEvent.hxx | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/src/event/SocketEvent.hxx b/src/event/SocketEvent.hxx
index 0f4f0ec06..cd26d6c9d 100644
--- a/src/event/SocketEvent.hxx
+++ b/src/event/SocketEvent.hxx
@@ -116,6 +116,9 @@ public:
 
 	void Open(SocketDescriptor _fd) noexcept;
 
+	/**
+	 * Close the socket (and cancel all scheduled events).
+	 */
 	void Close() noexcept;
 
 	unsigned GetScheduledFlags() const noexcept {