diff options
| author | Sadie Powell <sadie@witchery.services> | 2024-02-21 15:44:55 +0000 |
|---|---|---|
| committer | Sadie Powell <sadie@witchery.services> | 2024-02-22 00:14:08 +0000 |
| commit | 3ecf6b495b02bdabe317547fe4bcf2179e3fb6d7 (patch) | |
| tree | 96b6114ab7a38bb655089020ce0f57e828cc1b8f /include/protocol.h | |
| parent | 8475697e3b9154a018f9bba59e93366a8f835100 (diff) | |
Document IRCDProto::Parse.
Diffstat (limited to 'include/protocol.h')
| -rw-r--r-- | include/protocol.h | 10 |
1 files changed, 9 insertions, 1 deletions
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 &, Anope::string &, std::vector<Anope::string> &); + /** 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<Anope::string> &tags, Anope::string &source, Anope::string &command, std::vector<Anope::string> ¶ms); virtual Anope::string Format(const Anope::string &source, const Anope::string &message); /* Modes used by default by our clients */ |