PHPDocs for remote and action

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(

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);

lib/plugins/remote.php

 <?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;
     }