From 3ecf6b495b02bdabe317547fe4bcf2179e3fb6d7 Mon Sep 17 00:00:00 2001 From: Sadie Powell Date: Wed, 21 Feb 2024 15:44:55 +0000 Subject: [PATCH] Document IRCDProto::Parse. --- include/protocol.h | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/include/protocol.h b/include/protocol.h index 70e45837e..29943d0e0 100644 --- a/include/protocol.h +++ b/include/protocol.h @@ -42,7 +42,15 @@ public: virtual void SendCTCPInternal(const MessageSource &, const Anope::string &dest, const Anope::string &buf); virtual void SendNumericInternal(int numeric, const Anope::string &dest, const Anope::string &buf); - virtual bool Parse(const Anope::string &, Anope::map &, Anope::string &, Anope::string &, std::vector &); + /** Parses an incoming message from the IRC server. + * @param message The message to parse. + * @param tags The location to store tags. + * @param source The location to store the source. + * @param command The location to store the command name. + * @param params The location to store the parameters. + * @return If the message was well formed then true; otherwise, false. + */ + virtual bool Parse(const Anope::string &message, Anope::map &tags, Anope::string &source, Anope::string &command, std::vector ¶ms); virtual Anope::string Format(const Anope::string &source, const Anope::string &message); /* Modes used by default by our clients */