Commented new functions

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

diff --git a/include/dynamic.h b/include/dynamic.h
index b34f2358b53f28805d373fe35ba605e7cc126988..987f5de72c23192685895a941521b3b65d56891a 100644 (file)
--- a/include/dynamic.h
+++ b/include/dynamic.h
@@ -1,16 +1,23 @@
+/*       +------------------------------------+
+ *       | Inspire Internet Relay Chat Daemon |
+ *       +------------------------------------+
+ *
+ *  Inspire is copyright (C) 2002-2004 ChatSpike-Dev.
+ *                       E-mail:
+ *                <brain@chatspike.net>
+ *               <Craig@chatspike.net>
+ *     
+ * Written by Craig Edwards, Craig McLure, and others.
+ * This program is free but copyrighted software; see
+ *            the file COPYING for details.
+ *
+ * ---------------------------------------------------
+ */
+
+
 #ifndef __DLL_H
 #define __DLL_H
 
-//
-// class DLLManager is the simple ELF C++ Library manager.
-//
-// It tries to dynamically load the specified shared library
-// when it is construted.
-//
-// You should call LastError() before doing anything.  If it 
-// returns NULL there is no error.
-//
-
 
 class DLLManager
 {
@@ -32,70 +39,24 @@ class DLLManager
 };
 
 
-//
-// class DLLFactoryBase is the base class used for the DLLFactory
-// template class.  
-// 
-// It inherits from the DLLManager class and must be constructed with
-// the file name of the shared library and the function name within that
-// library which will create the desired C++ factory class.
-// If you do not provide func_name to the constructor, it defaults to
-// the undecorated "C" symbol "factory0"
-//
-// factory_func will be set to a pointer to the requested factory creator 
-// function.  If there was an error linking to the shared library,
-// factory_func will be 0.
-//
-// You can call 'LastError()' to find the error message that occurred.
-//
-//
-
 class DLLFactoryBase : public DLLManager
 {
  public:
-       DLLFactoryBase(
-                      const char *fname,
-                      const char *func_name=0
-                      );
-               
+       DLLFactoryBase(const char *fname, const char *func_name = 0);
        virtual ~DLLFactoryBase();
-       
        void * (*factory_func)(void);   
 };
 
 
-//
-// The DLLFactory template class inherits from DLLFactoryBase.
-// The constructor takes the file name of the shared library
-// and the undecorated "C" symbol name of the factory creator
-// function.  The factory creator function in your shared library
-// MUST either return a pointer to an object that is a subclass
-// of 'T' or it must return 0.
-//
-// If everything is cool, then 'factory' will point to the
-// requested factory class.  If not, it will be 0.
-//
-// Since the DLLFactory template ultimately inherits DLLManager,
-// you can call LastError() to get any error code information
-//
-// The created factory is OWNED by the DLLFactory class.  
-// The created factory will get deleted when the DLLFactory class
-// is deleted, because the DLL will get unloaded as well.
-//
-
-template <class T>
-class DLLFactory : public DLLFactoryBase
+template <class T> class DLLFactory : public DLLFactoryBase
 {
  public:
-       DLLFactory(
-                  const char *fname,
-                  const char *func_name=0
-                  ) : DLLFactoryBase( fname, func_name )
+       DLLFactory(const char *fname, const char *func_name=0) : DLLFactoryBase(fname,func_name)
        {
-               if( factory_func )
-                 factory = (T *)factory_func();
-               else 
-                 factory = 0;
+               if (factory_func)
+                       factory = (T*)factory_func();
+               else
+                       factory = 0;
        }
        
        ~DLLFactory()