diff options
author | brain <brain@e03df62e-2008-0410-955e-edbf42e46eb7> | 2004-05-16 14:58:40 +0000 |
---|---|---|
committer | brain <brain@e03df62e-2008-0410-955e-edbf42e46eb7> | 2004-05-16 14:58:40 +0000 |
commit | 740b09e2aee345c6fde199986d8eab6e0db224e3 (patch) | |
tree | 4f47ab9fe4cd60b2dcfc9a1c314e61a2787103a6 /include/dynamic.h | |
parent | 574718589f602ab4e1e59cda6eb89eb2366c8a65 (diff) |
Updated header comments
git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@816 e03df62e-2008-0410-955e-edbf42e46eb7
Diffstat (limited to 'include/dynamic.h')
-rw-r--r-- | include/dynamic.h | 64 |
1 files changed, 17 insertions, 47 deletions
diff --git a/include/dynamic.h b/include/dynamic.h index 0382324ce..987f5de72 100644 --- 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,24 +39,6 @@ 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: @@ -59,25 +48,6 @@ class DLLFactoryBase : public DLLManager }; -// -// 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 { public: |