aboutsummaryrefslogtreecommitdiffstats
path: root/lib
diff options
context:
space:
mode:
authorMorris Jobke <morris.jobke@gmail.com>2013-08-27 16:07:25 +0200
committerMorris Jobke <morris.jobke@gmail.com>2013-08-27 16:07:25 +0200
commite91edabe0f58fe316e3fb62461bce16168e74f52 (patch)
treec1b015b405c20ec22ccae9938598da6575b75701 /lib
parent273f162b26b15b2238972001a4ada3fa52eeece9 (diff)
downloadnextcloud-server-e91edabe0f58fe316e3fb62461bce16168e74f52.tar.gz
nextcloud-server-e91edabe0f58fe316e3fb62461bce16168e74f52.zip
add documentation
Diffstat (limited to 'lib')
-rw-r--r--lib/ocs/cloud.php13
1 files changed, 13 insertions, 0 deletions
diff --git a/lib/ocs/cloud.php b/lib/ocs/cloud.php
index b64200d0916..2dd99319057 100644
--- 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