Index: ./services/user_service/user_service.inc
===================================================================
RCS file: /cvs/drupal-contrib/contributions/modules/services/services/user_service/Attic/user_service.inc,v
retrieving revision 1.1.2.8.2.9
diff -u -p -r1.1.2.8.2.9 user_service.inc
--- ./services/user_service/user_service.inc	20 Feb 2010 23:54:23 -0000	1.1.2.8.2.9
+++ ./services/user_service/user_service.inc	22 Feb 2010 01:54:17 -0000
@@ -7,10 +7,12 @@
  */
 
 /**
- * Delete an user.
+ * Delete a user.
  *
  * @param $uid
- *   Number. The user ID.
+ *   UID of the user to be deleted.
+ *
+ * @see user_delete()
  */
 function user_service_delete($uid) {
   $account = user_load($uid);
@@ -24,10 +26,10 @@ function user_service_delete($uid) {
 }
 
 /**
- * Check if the user is allowed to delete the user.
+ * Check to see if the services account is allowed to delete a user.
  *
  * @param $uid
- *   Number. The user ID.
+ *   UID of the user to be deleted.
  */
 function user_service_delete_access($uid) {
   global $user;
@@ -39,7 +41,12 @@ function user_service_delete_access($uid
  * Get user details.
  *
  * @param $uid
- *   Number. The user ID.
+ *   UID of the user to be loaded.
+ *
+ * @return
+ *   A user object.
+ *
+ * @see user_load()
  */
 function user_service_get($uid) {
   $account = user_load($uid);
@@ -63,12 +70,17 @@ function user_service_get_access($uid) {
 }
 
 /**
- * Login a user
+ * Login a user using the specified credentials.
+ *
+ * Note this will transfer a plaintext password.
  *
  * @param $username
- *   String. The username.
+ *   Username to be logged in.
  * @param $password
- *   String. The user password.
+ *   Password, must be plain text and not hashed.
+ *
+ * @return
+ *   A valid session object.
  */
 function user_service_login($username, $password) {
   global $user;
@@ -96,7 +108,7 @@ function user_service_login($username, $
 }
 
 /**
- * Logout user
+ * Logout the current user.
  */
 function user_service_logout() {
   global $user;
@@ -119,10 +131,17 @@ function user_service_logout() {
 }
 
 /**
- * Save user details.
+ * Save user data.
+ *
+ * This can create a new user or modify an existing user, depending on the
+ * information passed to the function. This function uses drupal_execute()
+ * and as such exepects all input to match the submitting form in question.
+ *
+ * @param $account
+ *   An array of account information.
  *
- * @param $user_data
- *   Object. The user object with all user data.
+ * @return
+ *   The UID of the user whose information was saved.
  */
 function user_service_save($account) {
   // Load the required includes for saving profile information
@@ -182,10 +201,11 @@ function user_service_save($account) {
 }
 
 /**
- * Check if the user is allowed to get the user data.
+ * Check if the services account is allowed to create or edit user data.
  *
- * @param $uid
- *   Number. The user ID.
+ * @param $account
+ *   An array of user account information (note that UID is the only
+ *   property used.)
  */
 function user_service_save_access($account) {
   global $user;
