--- a/src/irc_proto.h Mon Mar 30 01:31:13 2009 +0300
+++ b/src/irc_proto.h Mon Mar 30 01:31:27 2009 +0300
@@ -28,6 +28,8 @@
/**
* The set of characters that are considered nickname channel flag prefixes (i.e. op, voice, etc).
+ *
+ * XXX: many IRCd's have more than these, should use the 005 reply instead.
*/
#define IRC_CHANFLAGS "@+"
@@ -42,7 +44,7 @@
/** Username, including any ident-related prefix from the network */
const char *username;
- /** Hostname, either reverse DNS hostname, literal IPv4 or literal IPv6 */
+ /** Hostname, either reverse DNS hostname, literal IPv4, literal IPv6, or something else... */
const char *hostname;
};
@@ -59,12 +61,12 @@
err_t irc_nm_parse (struct irc_nm *nm, char *buf, const char *prefix);
/**
- * Compare two nicknames for equality, with standard strcmp() semantics.
+ * Compare two nicknames for equality, with standard cmp() semantics.
*/
int irc_cmp_nick (const char *nick1, const char *nick2);
/**
- * Compare up to the first n chars of the two nickname strings for equality, with standard strcmp() semantics.
+ * Compare up to the first n chars of the two nickname strings for equality, with standard cmp() semantics.
*/
int irc_ncmp_nick (const char *nick1, const char *nick2, size_t n);
@@ -84,14 +86,14 @@
* Copy the prefixed flags from the given nickname into the given flags buffer (of at least IRC_CHANFLAGS_MAX bytes) and
* NUL-terminate it. Returns a pointer to the actual nickname itself.
*
- * @param nick the nickname, including prefixed chanflags
- * @param chanflags the buffer to store the parsed chanflags into
- * @returns a pointer to the first char of the actual nickname
+ * @param nickname the nickname including prefixed chanflags
+ * @param chanflags buffer to store the parsed chanflags into
+ * @return a pointer to the first char of the actual nickname
*/
-const char* irc_nick_chanflags (const char *nick, char chanflags[IRC_CHANFLAGS_MAX]);
+const char* irc_nick_chanflags (const char *nickname, char chanflags[IRC_CHANFLAGS_MAX]);
/**
- * @group IRC command numerics
+ * @defgroup IRC_RPL_ IRC command numerics
* @{
*/