Update inline documentation for DelFd() so the doxygen docs will be correct.

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

1 files changed, 8 insertions, 0 deletions

diff --git a/include/socketengine.h b/include/socketengine.h
index 557c314c6..729f5e090 100644
--- a/include/socketengine.h
+++ b/include/socketengine.h
@@ -224,7 +224,15 @@ public:
 	 * and false if it failed. This does not free the
 	 * EventHandler pointer using delete, if this is
 	 * required you must do this yourself.
+	 * Note on forcing deletes. DO NOT DO THIS! This is
+	 * extremely dangerous and will most likely render the
+	 * socketengine dead. This was added only for handling
+	 * very rare cases where broken 3rd party libs destroys
+	 * the OS socket beyond our control. If you can't explain
+	 * in minute details why forcing is absolutely necessary
+	 * then you don't need it. That was a NO!
 	 * @param eh The event handler object to remove
+	 * @param force *DANGEROUS* See method description!
 	 * @return True if the event handler was removed
 	 */
 	virtual bool DelFd(EventHandler* eh, bool force = false);