diff --git a/IRCClient/IRCClientChannel.h b/IRCClient/IRCClientChannel.h index 144530b..ada31a3 100644 --- a/IRCClient/IRCClientChannel.h +++ b/IRCClient/IRCClientChannel.h @@ -79,7 +79,7 @@ /** Sets the topic of the channel. * * Note that not all users on a channel have permission to change the topic; if you fail - * to set the topic, then you will not see an onTopic event on the IRCClientChannelDelegate. + * to set the topic, then you will not see a topicSet:by: event on the IRCClientChannelDelegate. * * @param aTopic the topic the client wishes to set for the channel. */ @@ -88,7 +88,7 @@ /** Sets the mode of the channel. * * Note that not all users on a channel have permission to change the mode; if you fail - * to set the mode, then you will not see a modeSet event on the IRCClientChannelDelegate. + * to set the mode, then you will not see a modeSet:withParams:by: event on the IRCClientChannelDelegate. * * @param mode the mode to set the channel to */ diff --git a/IRCClient/IRCClientSession.h b/IRCClient/IRCClientSession.h index f1725df..2c92aab 100644 --- a/IRCClient/IRCClientSession.h +++ b/IRCClient/IRCClientSession.h @@ -168,13 +168,20 @@ of IRC commands. */ - (int)sendRaw:(NSData *)message; -/** quits the IRC server with the given reason. On success, an onQuit event will be - sent to the IRCClientSessionDelegate with the nickname of the IRC client. +/** quits the IRC server with the given reason. + + On success, a userQuit:withReason: event will be sent to the + IRCClientSessionDelegate with the nickname of the IRC client and the reason + provided by the user (or nil if no reason was provided). */ - (int)quit:(NSData *)reason; /** Joins a channel with a given name and key + On success, a userJoined:channel: event will be sent to the + IRCClientSessionDelegate with the nickname of the IRC client and the name of + the channel that was joined. + @param channel the channel to join @param key they key for the channel (may be nil) */ @@ -192,7 +199,11 @@ */ - (int)userMode:(NSString *)mode; -/** sets the IRC client nickname. On success, an onNick event will be sent to the delegate +/** sets the IRC client nickname. + + On success, a nickChangedFrom:to: event will be sent to the + IRCClientSessionDelegate with our old nick and the new nick that we now + have. @param newnick new nickname to set. */ @@ -234,8 +245,8 @@ /** send a CTCP reply to another IRC client - @param reply the CTCP reply string to send - @param target the nickname of the IRC client to send the reply to. + @param reply the CTCP reply string to send + @param target the nickname of the IRC client to send the reply to. */ - (int)ctcpReply:(NSData *)reply target:(NSString *)target;