summaryrefslogtreecommitdiff
path: root/src/modules
diff options
context:
space:
mode:
authorbrain <brain@e03df62e-2008-0410-955e-edbf42e46eb7>2007-08-26 16:55:38 +0000
committerbrain <brain@e03df62e-2008-0410-955e-edbf42e46eb7>2007-08-26 16:55:38 +0000
commit8e14d91fb92768ea4fe838cd4a0ec335b7b735df (patch)
tree6dd253daf85691db9042ee3793772a2a39f6c9d1 /src/modules
parent5577604494b8a5fdb023e2fa2843a6736fde52b8 (diff)
Document ModuleSpanningTree::RemoteMessage. Maybe useful for other stuff.
git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@7828 e03df62e-2008-0410-955e-edbf42e46eb7
Diffstat (limited to 'src/modules')
-rw-r--r--src/modules/m_spanningtree/main.cpp7
1 files changed, 6 insertions, 1 deletions
diff --git a/src/modules/m_spanningtree/main.cpp b/src/modules/m_spanningtree/main.cpp
index 3a338a55a..5613251b0 100644
--- a/src/modules/m_spanningtree/main.cpp
+++ b/src/modules/m_spanningtree/main.cpp
@@ -624,7 +624,12 @@ int ModuleSpanningTree::HandleVersion(const char** parameters, int pcnt, userrec
return 1;
}
-/*
+/* This method will attempt to get a link message out to as many people as is required.
+ * If a user is provided, and that user is local, then the user is sent the message using
+ * WriteServ (they are the local initiator of that message). If the user is remote, they are
+ * sent that message remotely via PUSH.
+ * If the user is NULL, then the notice is sent locally via WriteToSnoMask with snomask 'l',
+ * and remotely via SNONOTICE with mask 'l'.
*/
void ModuleSpanningTree::RemoteMessage(userrec* user, const char* format, ...)
{