changeset 31151:f6b2412e4351

msn: Document command.h

--- a/libpurple/protocols/msn/command.h	Fri Mar 12 02:26:57 2010 +0000
+++ b/libpurple/protocols/msn/command.h	Fri Mar 12 02:29:13 2010 +0000
@@ -54,9 +54,40 @@
 	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 */