Document ListenSocket class

git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@4968 e03df62e-2008-0410-955e-edbf42e46eb7

1 files changed, 10 insertions, 0 deletions

diff --git a/include/socket.h b/include/socket.h
index c00c7f131..f868daf92 100644
--- a/include/socket.h
+++ b/include/socket.h
@@ -138,12 +138,22 @@ namespace irc
 	};
 };
 
+/** This class handles incoming connections on client ports.
+ * It will create a new userrec for every valid connection
+ * and assign it a file descriptor.
+ */
 class ListenSocket : public EventHandler
 {
  protected:
+	/** The creator/owner of this object
+	 */
 	InspIRCd* ServerInstance;
  public:
+	/** Create a new listening socket
+	 */
 	ListenSocket(InspIRCd* Instance, int sockfd, irc::sockets::insp_sockaddr client, irc::sockets::insp_sockaddr server, int port, char* addr);
+	/** Handle an I/O event
+	 */
 	void HandleEvent(EventType et);
 };