achmizs/IRCClient
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Rectify embedded documentation (event names)

Browse Source 
The comments for some methods in IRCClientSession.h and
IRCClientChannel.h were incorrect (they still talked about the old
event names, from version 1.0). This commit fixes those errors.
This commit is contained in:
achmizs 2015-12-21 18:52:59 -05:00
parent ae40b333fd
commit d2ea0bf7fb
2 changed files with 18 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
IRCClient/IRCClientChannel.h
View File

@ -79,7 +79,7 @@
/** Sets the topic of the channel. /** Sets the topic of the channel.
* *
* Note that not all users on a channel have permission to change the topic; if you fail * 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. * @param aTopic the topic the client wishes to set for the channel.
*/ */
@ -88,7 +88,7 @@
/** Sets the mode of the channel. /** Sets the mode of the channel.
* *
* Note that not all users on a channel have permission to change the mode; if you fail * 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 * @param mode the mode to set the channel to
*/ */

17
IRCClient/IRCClientSession.h
View File

@ -168,13 +168,20 @@
of IRC commands. */ of IRC commands. */
- (int)sendRaw:(NSData *)message; - (int)sendRaw:(NSData *)message;
/** quits the IRC server with the given reason. On success, an onQuit event will be /** quits the IRC server with the given reason.
sent to the IRCClientSessionDelegate with the nickname of the IRC client.
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; - (int)quit:(NSData *)reason;
/** Joins a channel with a given name and key /** 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 channel the channel to join
@param key they key for the channel (may be nil) @param key they key for the channel (may be nil)
*/ */
@ -192,7 +199,11 @@
*/ */
- (int)userMode:(NSString *)mode; - (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. @param newnick new nickname to set.
*/ */