Document SendMetaData.

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

diff --git a/include/protocol.h b/include/protocol.h
index da4c9690722031582bad8529363e4687a04fe9a5..f78d52928299067d6280ae775b513aefac78e8e3 100644 (file)
--- a/include/protocol.h
+++ b/include/protocol.h
@@ -42,7 +42,7 @@ class ProtocolInterface : public Extensible
        ProtocolInterface(InspIRCd* Instance) : ServerInstance(Instance) { }
        virtual ~ProtocolInterface() { }
 
-       /** Generate an ENCAP message.
+       /** Send an ENCAP message to one or more linked servers.
         * 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.
@@ -50,6 +50,12 @@ class ProtocolInterface : public Extensible
         */
        virtual void SendEncapsulatedData(parameterlist &encap) { }
 
+       /** Send metadata for an object to other linked servers.
+        * @param target The object to send metadata for.
+        * @param type The type of metadata to send (TYPE_USER, TYPE_CHANNEL, etc)
+        * @param key The 'key' of the data, e.g. "swhois" for swhois desc on a user
+        * @param data The string representation of the data
+        */
        virtual void SendMetaData(void* target, int type, const std::string &key, const std::string &data) { }
 
        virtual void SendTopic(Channel* channel, std::string &topic) { }