pidgin: cce54d60: Add a few bits of documentation

[markdoliner at pidgin.im]

-----------------------------------------------------------------
Revision: cce54d60666920e5b31a240f7bdce9e829b09ea4
Ancestor: 845b534b3cb3144c4d6107ca794d3ea9858649ea
Author: markdoliner at pidgin.im
Date: 2008-06-07T00:56:14
Branch: im.pidgin.pidgin
URL: http://d.pidgin.im/viewmtn/revision/info/cce54d60666920e5b31a240f7bdce9e829b09ea4

Modified files:
        libpurple/protocols/msn/notification.c
        libpurple/protocols/msn/slplink.h

ChangeLog: 

Add a few bits of documentation

-------------- next part --------------
============================================================
--- libpurple/protocols/msn/notification.c	bf426c63b81287ba21ab95726728e09b11aa88b4
+++ libpurple/protocols/msn/notification.c	c6e5170cfa279b5cf10b42ff9220a4e70c7049a3
@@ -1015,13 +1015,13 @@ fln_cmd(MsnCmdProc *cmdproc, MsnCommand 
 	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);
 
============================================================
--- libpurple/protocols/msn/slplink.h	567cbc459ff271ba6c4cf6b48fff0d9a10e2b16c
+++ libpurple/protocols/msn/slplink.h	2e862a16e96f7248ccae44cf05e8ff0a43da7eb9
@@ -60,9 +60,20 @@ void msn_slplink_destroy(MsnSlpLink *slp
 };
 
 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);