From 67b479b256ae7436b507860d32ee7e0b29b1657a Mon Sep 17 00:00:00 2001
From: Gerrit Uitslag <klapinklapin@gmail.com>
Date: Tue, 30 Jun 2015 22:41:51 +0200
Subject: PHPDocs for remote and action

---
 lib/plugins/acl/remote.php |  2 +-
 lib/plugins/action.php     |  2 ++
 lib/plugins/remote.php     | 13 ++++++++++++-
 3 files changed, 15 insertions(+), 2 deletions(-)

diff --git a/lib/plugins/acl/remote.php b/lib/plugins/acl/remote.php
index 42449428f..031686f95 100644
--- a/lib/plugins/acl/remote.php
+++ b/lib/plugins/acl/remote.php
@@ -8,7 +8,7 @@ class remote_plugin_acl extends DokuWiki_Remote_Plugin {
     /**
      * Returns details about the remote plugin methods
      *
-     * @return array
+     * @return array Information about all provided methods. {@see RemoteAPI}
      */
     public function _getMethods() {
         return array(
diff --git a/lib/plugins/action.php b/lib/plugins/action.php
index 4b5eef60a..23d94a509 100644
--- a/lib/plugins/action.php
+++ b/lib/plugins/action.php
@@ -16,6 +16,8 @@ class DokuWiki_Action_Plugin extends DokuWiki_Plugin {
 
     /**
      * Registers a callback function for a given event
+     *
+     * @param Doku_Event_Handler $controller
      */
     public function register(Doku_Event_Handler $controller) {
         trigger_error('register() not implemented in '.get_class($this), E_USER_WARNING);
diff --git a/lib/plugins/remote.php b/lib/plugins/remote.php
index a51f701fb..47f954ee6 100644
--- a/lib/plugins/remote.php
+++ b/lib/plugins/remote.php
@@ -1,19 +1,30 @@
 <?php
 
+/**
+ * Class DokuWiki_Remote_Plugin
+ */
 abstract class DokuWiki_Remote_Plugin extends DokuWiki_Plugin {
 
     private  $api;
 
+    /**
+     * Constructor
+     */
     public function __construct() {
         $this->api = new RemoteAPI();
     }
 
     /**
+     * Get all available methods with remote access.
+     *
      * @abstract
-     * @return array Information to all provided methods. {@see RemoteAPI}.
+     * @return array Information about all provided methods. {@see RemoteAPI}.
      */
     public abstract function _getMethods();
 
+    /**
+     * @return RemoteAPI
+     */
     protected function getApi() {
         return $this->api;
     }
-- 
cgit v1.2.3