From 8e14d91fb92768ea4fe838cd4a0ec335b7b735df Mon Sep 17 00:00:00 2001 From: brain Date: Sun, 26 Aug 2007 16:55:38 +0000 Subject: Document ModuleSpanningTree::RemoteMessage. Maybe useful for other stuff. git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@7828 e03df62e-2008-0410-955e-edbf42e46eb7 --- src/modules/m_spanningtree/main.cpp | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) (limited to 'src/modules') 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, ...) { -- cgit v1.2.3