From 42ea7f447f39fbc2f79eaaec31f8c10ede59c5d0 Mon Sep 17 00:00:00 2001
From: Gerrit Uitslag <klapinklapin@gmail.com>
Date: Wed, 1 Oct 2014 11:30:27 +0200
Subject: Many PHPDocs, some unused and dyn declared vars

many PHPDocs
some unused variables
some dynamically declared variables declared
---
 lib/exe/xmlrpc.php         |  8 ++++++++
 lib/plugins/acl/remote.php | 30 +++++++++++++++++++++++++++---
 2 files changed, 35 insertions(+), 3 deletions(-)

(limited to 'lib')

diff --git a/lib/exe/xmlrpc.php b/lib/exe/xmlrpc.php
index c09daa17c..3a878ebe4 100644
--- a/lib/exe/xmlrpc.php
+++ b/lib/exe/xmlrpc.php
@@ -40,10 +40,18 @@ class dokuwiki_xmlrpc_server extends IXR_Server {
         }
     }
 
+    /**
+     * @param string|int $data iso date(yyyy[-]mm[-]dd[ hh:mm[:ss]]) or timestamp
+     * @return IXR_Date
+     */
     function toDate($data) {
         return new IXR_Date($data);
     }
 
+    /**
+     * @param string $data
+     * @return IXR_Base64
+     */
     function toFile($data) {
         return new IXR_Base64($data);
     }
diff --git a/lib/plugins/acl/remote.php b/lib/plugins/acl/remote.php
index 2fdc697db..b10c544ee 100644
--- a/lib/plugins/acl/remote.php
+++ b/lib/plugins/acl/remote.php
@@ -1,7 +1,16 @@
 <?php
 
+/**
+ * Class remote_plugin_acl
+ */
 class remote_plugin_acl extends DokuWiki_Remote_Plugin {
-    function _getMethods() {
+
+    /**
+     * Returns details about the remote plugin methods
+     *
+     * @return array
+     */
+    public function _getMethods() {
         return array(
             'addAcl' => array(
                 'args' => array('string','string','int'),
@@ -17,13 +26,28 @@ class remote_plugin_acl extends DokuWiki_Remote_Plugin {
         );
     }
 
-    function addAcl($scope, $user, $level){
+    /**
+     * Add a new entry to ACL config
+     *
+     * @param string $scope
+     * @param string $user
+     * @param int    $level see also inc/auth.php
+     * @return bool
+     */
+    public function addAcl($scope, $user, $level){
         /** @var admin_plugin_acl $apa */
         $apa = plugin_load('admin', 'acl');
         return $apa->_acl_add($scope, $user, $level);
     }
 
-    function delAcl($scope, $user){
+    /**
+     * Remove an entry from ACL config
+     *
+     * @param string $scope
+     * @param string $user
+     * @return bool
+     */
+    public function delAcl($scope, $user){
         /** @var admin_plugin_acl $apa */
         $apa = plugin_load('admin', 'acl');
         return $apa->_acl_del($scope, $user);
-- 
cgit v1.2.3