Document invitation key creation/deletion methods

Signed-off-by: Florian Pritz <bluewind@xinu.at>

1 files changed, 11 insertions, 0 deletions

diff --git a/application/service/user.php b/application/service/user.php
index f7dfa5799..336941ca4 100644
--- a/application/service/user.php
+++ b/application/service/user.php
@@ -78,6 +78,11 @@ class user {
 		);
 	}
 
+	/**
+	 * Create an invitation key for a user
+	 * @param userid id of the user
+	 * @return key the created invitation key
+	 */
 	static public function create_invitation_key($userid) {
 		$CI =& get_instance();
 
@@ -104,6 +109,12 @@ class user {
 		return $key;
 	}
 
+	/**
+	 * Remove an invitation key belonging to a user
+	 * @param userid id of the user
+	 * @param key key to remove
+	 * @return number of removed keys
+	 */
 	static public function delete_invitation_key($userid, $key) {
 		$CI =& get_instance();