summaryrefslogtreecommitdiff
path: root/docs/man/ModuleFactory.3
diff options
context:
space:
mode:
authorbrain <brain@e03df62e-2008-0410-955e-edbf42e46eb7>2004-04-30 12:26:11 +0000
committerbrain <brain@e03df62e-2008-0410-955e-edbf42e46eb7>2004-04-30 12:26:11 +0000
commitf61345bd0eed92ccc4882a190a19c902fbbfc5fb (patch)
tree241963780303a3ce75b0d1a51b20cb93fd829901 /docs/man/ModuleFactory.3
parent1a897a19105498bff0104e296a6c39a5864e5600 (diff)
Added manpages, extra docs
git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@753 e03df62e-2008-0410-955e-edbf42e46eb7
Diffstat (limited to 'docs/man/ModuleFactory.3')
-rw-r--r--docs/man/ModuleFactory.360
1 files changed, 60 insertions, 0 deletions
diff --git a/docs/man/ModuleFactory.3 b/docs/man/ModuleFactory.3
new file mode 100644
index 000000000..4d6298ae9
--- /dev/null
+++ b/docs/man/ModuleFactory.3
@@ -0,0 +1,60 @@
+.TH "ModuleFactory" 3 "30 Apr 2004" "InspIRCd" \" -*- nroff -*-
+.ad l
+.nh
+.SH NAME
+ModuleFactory \- Instantiates classes inherited from \fBModule\fP This class creates a class inherited from type \fBModule\fP, using new.
+
+.PP
+.SH SYNOPSIS
+.br
+.PP
+\fC#include <modules.h>\fP
+.PP
+Inherits \fBclassbase\fP.
+.PP
+.SS "Public Member Functions"
+
+.in +1c
+.ti -1c
+.RI "\fBModuleFactory\fP ()"
+.br
+.ti -1c
+.RI "virtual \fB~ModuleFactory\fP ()"
+.br
+.ti -1c
+.RI "virtual \fBModule\fP * \fBCreateModule\fP ()=0"
+.br
+.RI "\fICreates a new module.\fP"
+.in -1c
+.SH "Detailed Description"
+.PP
+Instantiates classes inherited from \fBModule\fP This class creates a class inherited from type \fBModule\fP, using new.
+
+This is to allow for modules to create many different variants of \fBModule\fP, dependent on architecture, configuration, etc. In most cases, the simple class shown in the example module m_foobar.so will suffice for most modules.
+.PP
+Definition at line 633 of file modules.h.
+.SH "Constructor & Destructor Documentation"
+.PP
+.SS "ModuleFactory::ModuleFactory ()\fC [inline]\fP"
+.PP
+Definition at line 636 of file modules.h.
+.PP
+.nf
+636 { }
+.fi
+.SS "virtual ModuleFactory::~ModuleFactory ()\fC [inline, virtual]\fP"
+.PP
+Definition at line 637 of file modules.h.
+.PP
+.nf
+637 { }
+.fi
+.SH "Member Function Documentation"
+.PP
+.SS "virtual \fBModule\fP* ModuleFactory::CreateModule ()\fC [pure virtual]\fP"
+.PP
+Creates a new module.Your inherited class of ModuleFactory must return a pointer to your \fBModule\fP class using this method.
+
+.SH "Author"
+.PP
+Generated automatically by Doxygen for InspIRCd from the source code.