aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/lib/plugins/remote.php
diff options
context:
space:
mode:
authorGerrit Uitslag <klapinklapin@gmail.com>2015-06-30 22:41:51 +0200
committerGerrit Uitslag <klapinklapin@gmail.com>2015-06-30 22:41:51 +0200
commit67b479b256ae7436b507860d32ee7e0b29b1657a (patch)
tree6f6cc63bf382d9475cddea494442d2f4d37fc059 /lib/plugins/remote.php
parent2b6c681901bfed9efc7d09dca27aee308d48341d (diff)
downloaddokuwiki-67b479b256ae7436b507860d32ee7e0b29b1657a.tar.gz
dokuwiki-67b479b256ae7436b507860d32ee7e0b29b1657a.zip
PHPDocs for remote and action
Diffstat (limited to 'lib/plugins/remote.php')
-rw-r--r--lib/plugins/remote.php13
1 files changed, 12 insertions, 1 deletions
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;
}