cpw.qulogic.msnp16: 7ee51159: msn: Document command.h

[masca at cpw.pidgin.im]

-----------------------------------------------------------------
Revision: 7ee511594bdd41df12a7c8a273b52ee77c0206de
Ancestor: 0b827664dfddcf3316ecf9b872a2e82447f9e8a0
Author: masca at cpw.pidgin.im
Date: 2010-03-12T02:29:13
Branch: im.pidgin.cpw.qulogic.msnp16
URL: http://d.pidgin.im/viewmtn/revision/info/7ee511594bdd41df12a7c8a273b52ee77c0206de

Modified files:
        libpurple/protocols/msn/command.h

ChangeLog: 

msn: Document command.h

-------------- next part --------------
============================================================
--- libpurple/protocols/msn/command.h	86fb90888053ac5769526b1184943f81b5e62de5
+++ libpurple/protocols/msn/command.h	cbcd7ca18db266caa308440f0c8bb581a59094ca
@@ -54,9 +54,40 @@ struct _MsnCommand
 	void *payload_cbdata;
 };
 
+/**
+ * Create a command object from the incoming string and ref it.
+ *
+ * @param string 	The incoming string.
+ *
+ * @return 			A MsnCommand object.
+ */
 MsnCommand *msn_command_from_string(const char *string);
+
+
+/**
+ * Destroy a MsnCommand object. If it's being used by someone else,
+ * it just unref the object and return.
+ *
+ * @param cmd 	The MsnCommand to be destroyed.
+ */
 void msn_command_destroy(MsnCommand *cmd);
+
+/**
+ * Add 1 to the ref count.
+ *
+ * @param cmd 	The MsnCommand to be ref.
+ *
+ * @return 		The ref command.
+ */
 MsnCommand *msn_command_ref(MsnCommand *cmd);
+
+/**
+ * Substrac 1 to the ref count. If the count goes to 0, destroy it.
+ *
+ * @param cmd	The MsnCommand to be unref.
+ *
+ * @return 		The ref command.
+ */
 MsnCommand *msn_command_unref(MsnCommand *cmd);
 
 #endif /* MSN_COMMAND_H */