Move irc-bot.c documentation to irc-bot.h

interface a not interfaced function irc_privmsg_ctcp

2 files changed, 130 insertions, 92 deletions

diff --git a/src/map/irc-bot.c b/src/map/irc-bot.c
index f1f76a616..5820ad2cf 100644
--- a/src/map/irc-bot.c
+++ b/src/map/irc-bot.c
@@ -48,10 +48,7 @@ struct irc_bot_interface *ircbot;
 
 char send_string[IRC_MESSAGE_LENGTH];
 
-/**
- * Timer callback to (re-)connect to an IRC server
- * @see timer->do_timer
- */
+/// @copydoc irc_bot_interface::connect_timer()
 int irc_connect_timer(int tid, int64 tick, int id, intptr_t data) {
 	struct hSockOpt opt;
 	if( ircbot->isOn || ++ircbot->fails >= 3 )
@@ -71,10 +68,7 @@ int irc_connect_timer(int tid, int64 tick, int id, intptr_t data) {
 	return 0;
 }
 
-/**
- * Timer callback to send identification commands to an IRC server
- * @see timer->do_timer
- */
+/// @copydoc irc_bot_interface::identify_timer()
 int irc_identify_timer(int tid, int64 tick, int id, intptr_t data) {
 	if( !ircbot->isOn )
 		return 0;
@@ -89,10 +83,7 @@ int irc_identify_timer(int tid, int64 tick, int id, intptr_t data) {
 	return 0;
 }
 
-/**
- * Timer callback to join channels (and optionally send NickServ commands)
- * @see timer->do_timer
- */
+/// @copydoc irc_bot_interface::join_timer()
 int irc_join_timer(int tid, int64 tick, int id, intptr_t data) {
 	if( !ircbot->isOn )
 		return 0;
@@ -113,12 +104,7 @@ int irc_join_timer(int tid, int64 tick, int id, intptr_t data) {
 	return 0;
 }
 
-/**
- * Search the handler for a given IRC received command
- * @param function_name Name of the received IRC command
- * @return              Function pointer to the command handler, NULL in case
- *                      of unhandled commands
- */
+/// @copydoc irc_bot_interface::func_search()
 struct irc_func* irc_func_search(char* function_name) {
 	int i;
 	nullpo_retr(NULL, function_name);
@@ -130,10 +116,7 @@ struct irc_func* irc_func_search(char* function_name) {
 	return NULL;
 }
 
-/**
- * Parser for the IRC server connection
- * @see do_sockets
- */
+/// @copydoc irc_bot_interface::parse()
 int irc_parse(int fd) {
 	char *parse_string = NULL, *p = NULL, *str_safe = NULL;
 
@@ -167,16 +150,7 @@ int irc_parse(int fd) {
 	return 0;
 }
 
-/**
- * Parse the source from a received irc message
- * @param source Source string, as reported by the server
- * @param nick   Pointer to a string where to return the nick (may not be NULL,
- *               needs to be able to fit an IRC_NICK_LENGTH long string)
- * @param ident  Pointer to a string where to return the ident (may not be
- *               NULL, needs to be able to fit an IRC_IDENT_LENGTH long string)
- * @param host   Pointer to a string where to return the hostname (may not be
- *               NULL, needs to be able to fit an IRC_HOST_LENGTH long string)
- */
+/// @copydoc irc_bot_interface::parse_source()
 void irc_parse_source(char *source, char *nick, char *ident, char *host) {
 	int i, pos = 0;
 	size_t len;
@@ -200,12 +174,7 @@ void irc_parse_source(char *source, char *nick, char *ident, char *host) {
 	}
 }
 
-/**
- * Parse a received message from the irc server, and do the appropriate action
- * for the detected command
- * @param fd  IRC server connection file descriptor
- * @param str Raw received message
- */
+/// @copydoc irc_bot_interface::parse_sub()
 void irc_parse_sub(int fd, char *str) {
 	char source[180], command[60], buf1[IRC_MESSAGE_LENGTH], buf2[IRC_MESSAGE_LENGTH];
 	char *target = buf1, *message = buf2;
@@ -235,11 +204,7 @@ void irc_parse_sub(int fd, char *str) {
 	func->func(fd,command,source,target,message);
 }
 
-/**
- * Decides if an IRC Command should be queued or not, based on the flood protection settings.
- *
- * @param str Command to be checked
- **/
+/// @copydoc irc_bot_interface::queue()
 void irc_queue(char *str)
 {
 	struct message_flood *queue_entry = NULL;
@@ -276,6 +241,7 @@ void irc_queue(char *str)
 	}
 }
 
+/// @copydoc irc_bot_interface::queue_timer()
 int irc_queue_timer(int tid, int64 tick, int id, intptr_t data)
 {
 	struct message_flood *queue_entry = ircbot->message_current;
@@ -296,10 +262,7 @@ int irc_queue_timer(int tid, int64 tick, int id, intptr_t data)
 	return 0;
 }
 
-/**
- * Send a raw command to the irc server
- * @param str Command to send
- */
+/// @copydoc irc_bot_interface::send()
 void irc_send(char *str, bool force)
 {
 	size_t len;
@@ -319,20 +282,14 @@ void irc_send(char *str, bool force)
 	WFIFOSET(ircbot->fd, len);
 }
 
-/**
- * Handler for the PING IRC command (send back a PONG)
- * @see irc_parse_sub
- */
+/// @copydoc irc_interface_bot::pong()
 void irc_pong(int fd, char *cmd, char *source, char *target, char *msg) {
 	nullpo_retv(cmd);
 	snprintf(send_string, IRC_MESSAGE_LENGTH, "PONG %s", cmd);
 	ircbot->send(send_string, false);
 }
 
-/**
- * Handler for CTCP commands received via PRIVMSG
- * @see irc_privmsg
- */
+/// @copydoc irc_interface_bot::privmsg_ctcp()
 void irc_privmsg_ctcp(int fd, char *cmd, char *source, char *target, char *msg) {
 	char source_nick[IRC_NICK_LENGTH], source_ident[IRC_IDENT_LENGTH], source_host[IRC_HOST_LENGTH];
 
@@ -378,10 +335,7 @@ void irc_privmsg_ctcp(int fd, char *cmd, char *source, char *target, char *msg)
 	}
 }
 
-/**
- * Handler for the PRIVMSG IRC command (action depends on the message contents)
- * @see irc_parse_sub
- */
+/// @copydoc irc_bot_interface::privmsg()
 void irc_privmsg(int fd, char *cmd, char *source, char *target, char *msg) {
 	size_t len = msg ? strlen(msg) : 0;
 	nullpo_retv(source);
@@ -392,7 +346,7 @@ void irc_privmsg(int fd, char *cmd, char *source, char *target, char *msg) {
 		command[0] = message[0] = '\0';
 		sscanf(msg, "\001%499[^\001\r\n ] %499[^\r\n\001]\001", command, message);
 
-		irc_privmsg_ctcp(fd, command, source, target, message);
+		ircbot->privmsg_ctcp(fd, command, source, target, message);
 #ifdef IRCBOT_DEBUG
 	} else if (strcmpi(target, channel->config->irc_nick) == 0) {
 		ShowDebug("irc_privmsg: Received message from %s: '%s'\n", source ? source : "(null)", msg);
@@ -419,11 +373,7 @@ void irc_privmsg(int fd, char *cmd, char *source, char *target, char *msg) {
 	}
 }
 
-/**
- * Handler for the JOIN IRC command (notify an in-game channel of users joining
- * the IRC channel)
- * @see irc_parse_sub
- */
+/// @copydoc irc_bot_interface::userjoin()
 void irc_userjoin(int fd, char *cmd, char *source, char *target, char *msg) {
 	char source_nick[IRC_NICK_LENGTH], source_ident[IRC_IDENT_LENGTH], source_host[IRC_HOST_LENGTH];
 
@@ -439,11 +389,7 @@ void irc_userjoin(int fd, char *cmd, char *source, char *target, char *msg) {
 	}
 }
 
-/**
- * Handler for the PART and QUIT IRC commands (notify an in-game channel of
- * users leaving the IRC channel)
- * @see irc_parse_sub
- */
+/// @copydoc irc_bot_interface::userleave()
 void irc_userleave(int fd, char *cmd, char *source, char *target, char *msg) {
 	char source_nick[IRC_NICK_LENGTH], source_ident[IRC_IDENT_LENGTH], source_host[IRC_HOST_LENGTH];
 
@@ -462,11 +408,7 @@ void irc_userleave(int fd, char *cmd, char *source, char *target, char *msg) {
 	}
 }
 
-/**
- * Handler for the NICK IRC commands (notify an in-game channel of users
- * changing their name while in the IRC channel)
- * @see irc_parse_sub
- */
+/// @copydoc irc_bot_interface::usernick()
 void irc_usernick(int fd, char *cmd, char *source, char *target, char *msg) {
 	char source_nick[IRC_NICK_LENGTH], source_ident[IRC_IDENT_LENGTH], source_host[IRC_HOST_LENGTH];
 
@@ -482,11 +424,7 @@ void irc_usernick(int fd, char *cmd, char *source, char *target, char *msg) {
 	}
 }
 
-/**
- * Relay a chat message to the irc channel the bot is connected to
- * @param name Sender's name
- * @param msg  Message text
- */
+/// @copydoc irc_bot_interface::relay()
 void irc_relay(const char *name, const char *msg)
 {
 	if (!ircbot->isIn)
@@ -501,9 +439,7 @@ void irc_relay(const char *name, const char *msg)
 	ircbot->send(send_string, false);
 }
 
-/**
- * IRC bot initializer
- */
+/// @copydoc irc_bot_interface::init()
 void irc_bot_init(bool minimal) {
 	/// Command handlers
 	const struct irc_func irc_func_base[] = {
@@ -554,9 +490,7 @@ void irc_bot_init(bool minimal) {
 	timer->add(timer->gettick() + 7000, ircbot->connect_timer, 0, 0);
 }
 
-/**
- * IRC bot finalizer
- */
+/// @copydoc irc_bot_interface::final()
 void irc_bot_final(void) {
 	int i;
 
@@ -619,6 +553,7 @@ void ircbot_defaults(void) {
 
 	ircbot->pong = irc_pong;
 	ircbot->privmsg = irc_privmsg;
+	ircbot->privmsg_ctcp = irc_privmsg_ctcp;
 
 	ircbot->userjoin = irc_userjoin;
 	ircbot->userleave = irc_userleave;
diff --git a/src/map/irc-bot.h b/src/map/irc-bot.h
index 949305bc9..f73426693 100644
--- a/src/map/irc-bot.h
+++ b/src/map/irc-bot.h
@@ -67,29 +67,132 @@ struct irc_bot_interface {
 		struct irc_func **list;
 		unsigned int size;
 	} funcs;
-	/* */
+
+	/**
+	 * IRC bot initializer
+	 */
 	void (*init) (bool minimal);
+
+	/**
+	 * IRC bot finalizer
+	 */
 	void (*final) (void);
-	/* */
+
+	/**
+	 * Parser for the IRC server connection
+	 * @see do_sockets
+	 */
 	int (*parse) (int fd);
+	
+	/**
+	 * Parse a received message from the irc server, and do the appropriate action
+	 * for the detected command
+	 * @param fd  IRC server connection file descriptor
+	 * @param str Raw received message
+	 */
 	void (*parse_sub) (int fd, char *str);
+
+	/**
+	 * Parse the source from a received irc message
+	 * @param source Source string, as reported by the server
+	 * @param nick   Pointer to a string where to return the nick (may not be NULL,
+	 *               needs to be able to fit an IRC_NICK_LENGTH long string)
+	 * @param ident  Pointer to a string where to return the ident (may not be
+	 *               NULL, needs to be able to fit an IRC_IDENT_LENGTH long string)
+	 * @param host   Pointer to a string where to return the hostname (may not be
+	 *               NULL, needs to be able to fit an IRC_HOST_LENGTH long string)
+	 */
 	void (*parse_source) (char *source, char *nick, char *ident, char *host);
-	/* */
+
+	/**
+	 * Search the handler for a given IRC received command
+	 * @param function_name Name of the received IRC command
+	 * @return              Function pointer to the command handler, NULL in case
+	 *                      of unhandled commands
+	 */
 	struct irc_func* (*func_search) (char* function_name);
-	/* */
+
+	/**
+	 * Timer callback to (re-)connect to an IRC server
+	 * @see timer_interface::do_timer
+	 */
 	int (*connect_timer) (int tid, int64 tick, int id, intptr_t data);
+
+	/**
+	 * Timer callback to send identification commands to an IRC server
+	 * @see timer_interface::do_timer
+	 */
 	int (*identify_timer) (int tid, int64 tick, int id, intptr_t data);
+
+	/**
+	 * Timer callback to join channels (and optionally send NickServ commands)
+	 * @see timer_interface::do_timer
+	 */
 	int (*join_timer) (int tid, int64 tick, int id, intptr_t data);
-	/* */
+
+	/**
+	 * Timer callback to send queued IRC Commands
+	 * @see timer_interface::do_timer
+	 */
 	int (*queue_timer) (int tid, int64 tick, int id, intptr_t data);
+	
+	/**
+	 * Decides if an IRC Command should be queued or not, based on the flood protection settings.
+	 *
+	 * @param str Command to be checked
+	 */
 	void (*queue) (char *str);
+
+	/**
+	 * Send a raw command to the irc server
+	 * @param str Command to send
+	 */
 	void (*send)(char *str, bool force);
+
+	/**
+	 * Relay a chat message to the irc channel the bot is connected to
+	 * @param name Sender's name
+	 * @param msg  Message text
+	 */
 	void (*relay) (const char *name, const char *msg);
-	/* */
+	
+	/**
+	 * Handler for the PING IRC command (send back a PONG)
+	 * @see irc_bot_interface::parse_sub
+	 */
 	void (*pong) (int fd, char *cmd, char *source, char *target, char *msg);
+
+	/**
+	 * Handler for the PRIVMSG IRC command (action depends on the message contents)
+	 * @see irc_bot_interface::parse_sub
+	 */
 	void (*privmsg) (int fd, char *cmd, char *source, char *target, char *msg);
+
+	/**
+	 * Handler for CTCP commands received via PRIVMSG
+	 * @see irc_bot_interface::privmsg
+	 */
+	void (*privmsg_ctcp) (int fd, char *cmd, char *source, char *target, char *msg);
+
+	/**
+	 * Handler for the JOIN IRC command (notify an in-game channel of users joining
+	 * the IRC channel)
+	 * @see irc_bot_interface::parse_sub
+	 */
 	void (*userjoin) (int fd, char *cmd, char *source, char *target, char *msg);
+
+	/**
+	 * Handler for the PART and QUIT IRC commands (notify an in-game channel of
+	 * users leaving the IRC channel)
+	 * @see irc_bot_interface::parse_sub
+	 */
 	void (*userleave) (int fd, char *cmd, char *source, char *target, char *msg);
+
+	/**
+	 * Handler for the NICK IRC commands (notify an in-game channel of users
+	 * changing their name while in the IRC channel)
+	 * @see irc_bot_interface::parse_sub
+	 */
 	void (*usernick) (int fd, char *cmd, char *source, char *target, char *msg);
 };