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

Improve some comments

Browse Source
This commit is contained in:
Said Achmiz 2016-03-06 15:35:59 -05:00
parent 920b89d9cc
commit f7196c60fb
1 changed files with 11 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
IRCClient/IRCClientSession.h
View File

@ -70,8 +70,8 @@
/** @class IRCClientSession /** @class IRCClientSession
* @brief Represents a connected IRC Session. * @brief Represents a connected IRC Session.
* *
* IRCClientSession represents a single connection to an IRC server. On initialising * IRCClientSession represents a single connection to an IRC server. After initialising
* the object, and setting the delegate, server, port, and password (if required) * the object, setting the delegate, server, port, and password (if required)
* properties, and setting the nickname, username and realname using the * properties, and setting the nickname, username and realname using the
* setNickname:username:realname: method, you call the connect: and run: methods * setNickname:username:realname: method, you call the connect: and run: methods
* to connect to the IRC server and start a new thread. * to connect to the IRC server and start a new thread.
@ -130,10 +130,13 @@
*/ */
@property (assign) NSStringEncoding encoding; @property (assign) NSStringEncoding encoding;
/** An NSDictionary of channels that the client is currently connected to. */ /** An NSDictionary of channels that the client is currently connected to.
Keys are channel names (NSData objects containing C strings), values are
IRCClientChannel objects.
*/
@property (readonly) NSDictionary *channels; @property (readonly) NSDictionary *channels;
/** returns YES if the server is currently connected successfully, and NO if /** Returns YES if the server is currently connected successfully, and NO if
it is not. */ it is not. */
@property (readonly, getter=isConnected) bool connected; @property (readonly, getter=isConnected) bool connected;
@ -157,7 +160,7 @@
messages have implementation-specific uses. See the various RFCs, and other messages have implementation-specific uses. See the various RFCs, and other
info sources, for details. info sources, for details.
*/ */
+(NSDictionary *)ircNumericCodes; + (NSDictionary *)ircNumericCodes;
/** Set the nickname, username, and realname for the session. /** Set the nickname, username, and realname for the session.
@ -166,7 +169,7 @@
already connected; use the nick: method to attempt a nick change while already connected; use the nick: method to attempt a nick change while
connected.) connected.)
*/ */
-(int)setNickname:(NSData *)nickname username:(NSData *)username realname:(NSData *)realname; - (int)setNickname:(NSData *)nickname username:(NSData *)username realname:(NSData *)realname;
/** Connect to the IRC server. /** Connect to the IRC server.
@ -219,7 +222,8 @@
/** lists channels on the IRC server. /** lists channels on the IRC server.
@param channel a channel name or string to pass to the LIST command. Implementation specific. @param channel a channel name or string to pass to the LIST command.
Implementation specific.
*/ */
- (int)list:(NSData *)channel; - (int)list:(NSData *)channel;