From: w00t <w00t@e03df62e-2008-0410-955e-edbf42e46eb7>
Date: Sat, 25 Oct 2008 12:59:11 +0000 (+0000)
Subject: Document ENCAP.
X-Git-Tag: v2.0.23~2403
X-Git-Url: https://git.netwichtig.de/gitweb/?a=commitdiff_plain;h=2be4fff3e371b8add4fa6f471414e1f88418875f;p=user%2Fhenk%2Fcode%2Finspircd.git

Document ENCAP.


git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@10705 e03df62e-2008-0410-955e-edbf42e46eb7
---

diff --git a/include/protocol.h b/include/protocol.h
index 8579f03aa..da4c96907 100644
--- a/include/protocol.h
+++ b/include/protocol.h
@@ -42,6 +42,12 @@ class ProtocolInterface : public Extensible
 	ProtocolInterface(InspIRCd* Instance) : ServerInstance(Instance) { }
 	virtual ~ProtocolInterface() { }
 
+	/** Generate an ENCAP message.
+	 * See the protocol documentation for the purpose of ENCAP.
+	 * @param encap This is a list of string parameters, the first of which must be a server ID or glob matching servernames.
+	 * The second must be a subcommand. All subsequent parameters are dependant on the subcommand.
+	 * ENCAP (should) be used instead of creating new protocol messages for easier third party application support.
+	 */
 	virtual void SendEncapsulatedData(parameterlist &encap) { }
 
 	virtual void SendMetaData(void* target, int type, const std::string &key, const std::string &data) { }