changeset 23305:27f7fae4a361

Add a few bits of documentation
author Mark Doliner <mark@kingant.net>
date Sat, 07 Jun 2008 00:56:14 +0000
parents 945bf99cb233
children 67581872c47f
files libpurple/protocols/msn/notification.c libpurple/protocols/msn/slplink.h
diffstat 2 files changed, 13 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/libpurple/protocols/msn/notification.c	Sat Jun 07 00:47:16 2008 +0000
+++ b/libpurple/protocols/msn/notification.c	Sat Jun 07 00:56:14 2008 +0000
@@ -1015,13 +1015,13 @@
 	MsnSlpLink *slplink;
 	MsnUser *user;
 
+	/* Tell libpurple that the user has signed off */
 	user = msn_userlist_find_user(cmdproc->session->userlist, cmd->params[0]);
-
 	user->status = "offline";
 	msn_user_update(user);
 
+	/* If we have an open MsnSlpLink with the user then close it */
 	slplink = msn_session_find_slplink(cmdproc->session, cmd->params[0]);
-
 	if (slplink != NULL)
 		msn_slplink_destroy(slplink);
 
--- a/libpurple/protocols/msn/slplink.h	Sat Jun 07 00:47:16 2008 +0000
+++ b/libpurple/protocols/msn/slplink.h	Sat Jun 07 00:56:14 2008 +0000
@@ -60,9 +60,20 @@
 };
 
 void msn_slplink_destroy(MsnSlpLink *slplink);
+
+/**
+ * @return An MsnSlpLink for the given user, or NULL if there is no
+ *         existing MsnSlpLink.
+ */
 MsnSlpLink *msn_session_find_slplink(MsnSession *session,
 									 const char *who);
+
+/**
+ * @return An MsnSlpLink for the given user.  One will be created if
+ *         it does not already exist.
+ */
 MsnSlpLink *msn_session_get_slplink(MsnSession *session, const char *username);
+
 MsnSlpSession *msn_slplink_find_slp_session(MsnSlpLink *slplink,
 											long session_id);
 void msn_slplink_add_slpcall(MsnSlpLink *slplink, MsnSlpCall *slpcall);