Document base modes

[user/henk/code/inspircd.git] / include / socketengine_epoll.h

diff --git a/include/socketengine_epoll.h b/include/socketengine_epoll.h
index 65d1150f73824fbfe4cbb1d0289ed03b44f8f8ba..f675671e2dd7d0a6b21c14eb2640aae3c430856e 100644 (file)
--- a/include/socketengine_epoll.h
+++ b/include/socketengine_epoll.h
@@ -29,12 +29,21 @@
 
 class InspIRCd;
 
+/** A specialisation of the SocketEngine class, designed to use linux 2.6 epoll().
+ */
 class EPollEngine : public SocketEngine
 {
 private:
-       struct epoll_event events[MAX_DESCRIPTORS];     /* Up to 64k sockets for epoll */
+       /** These are used by epoll() to hold socket events
+        */
+       struct epoll_event events[MAX_DESCRIPTORS];
 public:
+       /** Create a new EPollEngine
+        * @param Instance The creator of this object
+        */
        EPollEngine(InspIRCd* Instance);
+       /** Delete an EPollEngine
+        */
        virtual ~EPollEngine();
        virtual bool AddFd(int fd, bool readable, char type);
        virtual int GetMaxFds();
@@ -44,9 +53,13 @@ public:
        virtual std::string GetName();
 };
 
+/** Creates a SocketEngine
+ */
 class SocketEngineFactory
 {
 public:
+       /** Create a new instance of SocketEngine based on EpollEngine
+        */
        SocketEngine* Create(InspIRCd* Instance) { return new EPollEngine(Instance); }
 };