Fix various documentation comments.

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

diff --git a/include/socketengine.h b/include/socketengine.h
index 2b759dad84ef541818296ce0439b8086c7be4a8d..d8d5e406dc5c28a0fc924e9fc6d7b91a23b53407 100644 (file)
--- a/include/socketengine.h
+++ b/include/socketengine.h
@@ -3,14 +3,13 @@
  *
  *   Copyright (C) 2013-2016 Attila Molnar <attilamolnar@hush.com>
  *   Copyright (C) 2013-2014 Adam <Adam@anope.org>
- *   Copyright (C) 2012-2013, 2017-2019 Sadie Powell <sadie@witchery.services>
+ *   Copyright (C) 2012-2013, 2017-2020 Sadie Powell <sadie@witchery.services>
  *   Copyright (C) 2012 Robby <robby@chatbelgie.be>
+ *   Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
  *   Copyright (C) 2009 Uli Schlachter <psychon@inspircd.org>
- *   Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
  *   Copyright (C) 2007-2008, 2017 Robin Burchell <robin+git@viroteck.net>
- *   Copyright (C) 2007-2008, 2010 Craig Edwards <brain@inspircd.org>
- *   Copyright (C) 2007 burlex <burlex@e03df62e-2008-0410-955e-edbf42e46eb7>
  *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
+ *   Copyright (C) 2005-2008 Craig Edwards <brain@inspircd.org>
  *
  * This file is part of InspIRCd.  InspIRCd is free software: you can
  * redistribute it and/or modify it under the terms of the GNU General Public
@@ -28,10 +27,7 @@
 
 #pragma once
 
-#include <vector>
 #include <string>
-#include <map>
-#include "config.h"
 #include "socket.h"
 #include "base.h"
 
@@ -187,7 +183,7 @@ class CoreExport EventHandler : public classbase
 
        inline int GetEventMask() const { return event_mask; }
 
-       /** Set a new file desciptor
+       /** Set a new file descriptor
         * @param FD The new file descriptor. Do not call this method without
         * first deleting the object from the SocketEngine if you have
         * added it to a SocketEngine instance.
@@ -330,8 +326,6 @@ public:
         * failure (for example, you try and enable
         * epoll on a 2.4 linux kernel) then this
         * function may bail back to the shell.
-        * @return void, but it is acceptable for this function to bail back to
-        * the shell or operating system on fatal error.
         */
        static void Init();
 
@@ -393,7 +387,7 @@ public:
        static bool HasFd(int fd);
 
        /** Returns the EventHandler attached to a specific fd.
-        * If the fd isnt in the socketengine, returns NULL.
+        * If the fd isn't in the socketengine, returns NULL.
         * @param fd The event handler to look for
         * @return A pointer to the event handler, or NULL
         */
@@ -404,7 +398,7 @@ public:
         * number of events which occurred during this call.  This method will
         * dispatch events to their handlers by calling their
         * EventHandler::OnEventHandler*() methods.
-        * @return The number of events which have occured.
+        * @return The number of events which have occurred.
         */
        static int DispatchEvents();
 
@@ -560,8 +554,6 @@ public:
         * allows for the socket engine to re-create its handle
         * after the daemon forks as the socket engine is created
         * long BEFORE the daemon forks.
-        * @return void, but it is acceptable for this function to bail back to
-        * the shell or operating system on fatal error.
         */
        static void RecoverFromFork();