summaryrefslogtreecommitdiff
path: root/docs/man/man3/Event.3
diff options
context:
space:
mode:
authorbrain <brain@e03df62e-2008-0410-955e-edbf42e46eb7>2005-12-09 20:21:39 +0000
committerbrain <brain@e03df62e-2008-0410-955e-edbf42e46eb7>2005-12-09 20:21:39 +0000
commitbab9f4b4bc0f6aa0e1377745fd216ef9874b3f27 (patch)
tree816b86525dc3e6f84a81adb0c8744b4c4798e792 /docs/man/man3/Event.3
parenta96341b150898376a1b01c7fb4519e1265c599b6 (diff)
Added new module docs
git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@2301 e03df62e-2008-0410-955e-edbf42e46eb7
Diffstat (limited to 'docs/man/man3/Event.3')
-rw-r--r--docs/man/man3/Event.310
1 files changed, 5 insertions, 5 deletions
diff --git a/docs/man/man3/Event.3 b/docs/man/man3/Event.3
index 545ed1fdc..0105be0ae 100644
--- a/docs/man/man3/Event.3
+++ b/docs/man/man3/Event.3
@@ -1,4 +1,4 @@
-.TH "Event" 3 "27 Nov 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
+.TH "Event" 3 "9 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@@ -58,7 +58,7 @@ The Event class is a unicast message directed at all modules.
When the class is properly instantiated it may be sent to all modules using the \fBSend()\fP method, which will trigger the OnEvent method in all modules passing the object as its parameter.
.PP
-Definition at line 196 of file modules.h.
+Definition at line 197 of file modules.h.
.SH "Constructor & Destructor Documentation"
.PP
.SS "Event::Event (char * anydata, \fBModule\fP * src, \fBstd::string\fP eventid)"
@@ -142,7 +142,7 @@ References FOREACH_MOD.
.PP
This member holds a pointer to arbitary data set by the emitter of the message.
.PP
-Definition at line 201 of file modules.h.
+Definition at line 202 of file modules.h.
.PP
Referenced by GetData().
.SS "\fBstd::string\fP \fBEvent::id\fP\fC [protected]\fP"
@@ -151,14 +151,14 @@ The event identifier.
.PP
This is arbitary text which should be used to distinguish one type of event from another.
.PP
-Definition at line 210 of file modules.h.
+Definition at line 211 of file modules.h.
.PP
Referenced by GetEventID().
.SS "\fBModule\fP* \fBEvent::source\fP\fC [protected]\fP"
.PP
This is a pointer to the sender of the message, which can be used to directly trigger events, or to create a reply.
.PP
-Definition at line 205 of file modules.h.
+Definition at line 206 of file modules.h.
.PP
Referenced by GetSource().