add documentation

13 years ago · e91edabe0f
parent 273f162b26
commit e91edabe0f
1 changed files with 13 additions and 0 deletions
--- a/lib/ocs/cloud.php
+++ b/lib/ocs/cloud.php
@ -46,6 +46,19 @@ class OC_OCS_Cloud {
 	
 	/**
 	 * gets user info
+	 *
+	 * exposes the quota of an user:
+	 * <data>
+	 *   <quota>
+	 *      <free>1234</free>
+	 *      <used>4321</used>
+	 *      <total>5555</total>
+	 *      <ralative>0.78</ralative>
+	 *   </quota>
+	 * </data>
+	 *
+	 * @param $parameters object should contain parameter 'userid' which identifies
+	 *                           the user from whom the information will be returned
 	 */
 	public static function getUser($parameters) {
 		// Check if they are viewing information on themselves