From 7d0fc076616482c78d197cfda9d5bd7e075d43d0 Mon Sep 17 00:00:00 2001 From: brain Date: Sun, 2 May 2004 12:29:43 +0000 Subject: Added manpages git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@778 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/man/man3/ModuleFactory.3 | 60 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 60 insertions(+) create mode 100644 docs/man/man3/ModuleFactory.3 (limited to 'docs/man/man3/ModuleFactory.3') diff --git a/docs/man/man3/ModuleFactory.3 b/docs/man/man3/ModuleFactory.3 new file mode 100644 index 000000000..353f4cd7a --- /dev/null +++ b/docs/man/man3/ModuleFactory.3 @@ -0,0 +1,60 @@ +.TH "ModuleFactory" 3 "2 May 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 \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 754 of file modules.h. +.SH "Constructor & Destructor Documentation" +.PP +.SS "ModuleFactory::ModuleFactory ()\fC [inline]\fP" +.PP +Definition at line 757 of file modules.h. +.PP +.nf +757 { } +.fi +.SS "virtual ModuleFactory::~ModuleFactory ()\fC [inline, virtual]\fP" +.PP +Definition at line 758 of file modules.h. +.PP +.nf +758 { } +.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. -- cgit v1.3.1-10-gc9f91