More docs. Tons more docs. I need coffee and we're out of coffee :<

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

2 files changed, 79 insertions, 6 deletions

diff --git a/include/dynamic.h b/include/dynamic.h
index 4440c476d..d63e5dc83 100644
--- a/include/dynamic.h
+++ b/include/dynamic.h
@@ -18,54 +18,112 @@
 #ifndef __DLL_H
 #define __DLL_H
 
+/** This typedef represents the init_module function within each module.
+ * The init_module function is the only exported extern "C" declaration
+ * in any module file.
+ */
 typedef void * (initfunc) (void);
 
 #include "inspircd_config.h"
 
 class InspIRCd;
 
+/** The DLLManager class is able to load a module file by filename,
+ * and locate its init_module symbol.
+ */
 class DLLManager
 {
  public:
+	/** This constructor loads the module using dlopen()
+	 * @param ServerInstance The creator class of this object
+	 * @param fname The filename to load. This should be within
+	 * the modules dir.
+	 */
 	DLLManager(InspIRCd* ServerInstance, const char *fname);
 	virtual ~DLLManager();
 
 
 #ifdef STATIC_LINK
-	bool GetSymbol( initfunc* &v, const char *sym_name );
+	/** Get a symbol using static linking.
+	 * @param v A static function pointer, pointing at an init_module function
+	 * @param sym_name The symbol name to find, usually "init_module"
+	 * @return True if the symbol can be found
+	 */
+	bool GetSymbol(initfunc* &v, const char *sym_name);
 #else
-	bool GetSymbol( void **, const char *sym_name );
+	/** Get a symbol using dynamic linking.
+	 * @param v A function pointer, pointing at an init_module function
+	 * @param sym_name The symbol name to find, usually "init_module"
+	 * @return true if the symbol can be found, also the symbol will be put into v.
+	 */
+	bool GetSymbol(void **v, const char *sym_name);
 #endif
-
+	/** Get the last error from dlopen() or dlsym().
+	 * @return The last error string, or NULL if no error has occured
+	 */
 	char* LastError() 
 	{
 		 return err;
 	}
 	
  protected:
+
+	/** The module handle
+	 */
 	void *h;
+
+	/** The last error string, or NULL
+	 */
 	char *err;
 #ifdef STATIC_LINK
+
+	/** The module name
+	 */
 	char staticname[1024];
 #endif
 };
 
-
+/** This class is a specialized form of DLLManager designed to load InspIRCd modules.
+ * It's job is to call the init_module function and receive a factory pointer.
+ */
 class DLLFactoryBase : public DLLManager
 {
  public:
+	/** Default constructor.
+	 * This constructor loads a module file by calling its DLLManager subclass constructor,
+	 * then finds the symbol using DLLManager::GetSymbol(), and calls the symbol,
+	 * obtaining a valid pointer to the init_module function
+	 */
 	DLLFactoryBase(InspIRCd* Instance, const char *fname, const char *func_name = 0);
+
+	/** Default destructor
+	 */
 	virtual ~DLLFactoryBase();
 #ifdef STATIC_LINK
+	/** A function pointer to the factory function
+	 */
 	initfunc *factory_func;
 #else
+	/** A function pointer to the factory function
+	 */
 	void * (*factory_func)(void);	
 #endif
 };
 
+/** This is the highest-level class of the DLLFactory system used to load InspIRCd modules.
+ * Its job is to finally call the init_module function and obtain a pointer to a ModuleFactory.
+ * This template is a container for ModuleFactory itself, so that it may 'plug' into ModuleFactory
+ * and provide module loading capabilities transparently.
+ */
 template <class T> class DLLFactory : public DLLFactoryBase
 {
  public:
+	/** Default constructor.
+	 * This constructor passes its paramerers down through DLLFactoryBase and then DLLManager
+	 * to load the module, then calls the factory function to retrieve a pointer to a ModuleFactory
+	 * class. It is then down to the core to call the ModuleFactory::CreateModule() method and
+	 * receive a Module* which it can insert into its module lists.
+	 */
 	DLLFactory(InspIRCd* Instance, const char *fname, const char *func_name=0) : DLLFactoryBase(Instance, fname, func_name)
 	{
 		if (factory_func)
@@ -74,12 +132,16 @@ template <class T> class DLLFactory : public DLLFactoryBase
 			factory = reinterpret_cast<T*>(-1);
 	}
 	
+	/** The destructor deletes the ModuleFactory pointer.
+	 */
 	~DLLFactory()
 	{
 		if (factory)
 			delete factory;
 	}
 
+	/** The ModuleFactory pointer.
+	 */
 	T *factory;
 };
 
diff --git a/include/modules.h b/include/modules.h
index 3375ead8c..aa36bed3a 100644
--- a/include/modules.h
+++ b/include/modules.h
@@ -1410,7 +1410,7 @@ class FileReader : public classbase
 };
 
 
-/** Instantiates classes inherited from Module
+/** Instantiates classes inherited from Module.
  * This class creates a class inherited from type Module, using new. This is to allow for modules
  * to create many different variants of Module, dependent on architecture, configuration, etc.
  * In most cases, the simple class shown in the example module m_foobar.so will suffice for most
@@ -1419,7 +1419,11 @@ class FileReader : public classbase
 class ModuleFactory : public classbase
 {
  public:
+	/** The default constructor does nothing.
+	 */
 	ModuleFactory() { }
+	/** The default destructor does nothing
+	 */
 	virtual ~ModuleFactory() { }
 	/** Creates a new module.
 	 * Your inherited class of ModuleFactory must return a pointer to your Module class
@@ -1428,9 +1432,16 @@ class ModuleFactory : public classbase
 	virtual Module * CreateModule(InspIRCd* Me) = 0;
 };
 
-
+/** A DLLFactory (designed to load shared objects) containing a ModuleFactory.
+ */
 typedef DLLFactory<ModuleFactory> ircd_module;
+
+/** A list of loaded Modules
+ */
 typedef std::vector<Module*> ModuleList;
+
+/** A list of loaded ModuleFactories
+ */
 typedef std::vector<ircd_module*> FactoryList;
 
 #endif