MDL-30225 add some phpdoc mentioning to avoid to use broken get_user_…

…capabilities ws lib function
BenKelada · Apr 18, 2012 · b449d3b · b449d3b
1 parent 099aaa8
commit b449d3b
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/webservice/lib.php b/webservice/lib.php
@@ -508,6 +508,10 @@ public function get_service_required_capabilities($serviceid) {
     /**
      * Get user capabilities (with context)
      * Only useful for documentation purpose
+     * WARNING: do not use this "broken" function. It was created in the goal to display some capabilities
+     * required by users. In theory we should not need to display this kind of information
+     * as the front end does not display it itself. In pratice,
+     * admins would like the info, for more info you can follow: MDL-29962
      *
      * @param int $userid user id
      * @return array
@@ -527,6 +531,10 @@ public function get_user_capabilities($userid) {
 
     /**
      * Get missing user capabilities for a given service
+     * WARNING: do not use this "broken" function. It was created in the goal to display some capabilities
+     * required by users. In theory we should not need to display this kind of information
+     * as the front end does not display it itself. In pratice,
+     * admins would like the info, for more info you can follow: MDL-29962
      *
      * @param array $users users
      * @param int $serviceid service id