summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--lib/plugins/action.php14
1 files changed, 8 insertions, 6 deletions
diff --git a/lib/plugins/action.php b/lib/plugins/action.php
index 4891349cb..fda30de9f 100644
--- a/lib/plugins/action.php
+++ b/lib/plugins/action.php
@@ -1,6 +1,6 @@
<?php
/**
- * Admin Plugin Prototype
+ * Action Plugin Prototype
*
* @license GPL 2 (http://www.gnu.org/licenses/gpl.html)
* @author Christopher Smith <chris@jalakai.co.uk>
@@ -12,13 +12,15 @@ if(!defined('DOKU_PLUGIN')) define('DOKU_PLUGIN',DOKU_INC.'lib/plugins/');
require_once(DOKU_INC.'inc/plugin.php');
/**
- * All DokuWiki plugins to extend the admin function
+ * All DokuWiki plugins to interfere with the event system
* need to inherit from this class
*/
class DokuWiki_Action_Plugin extends DokuWiki_Plugin {
- function register($controller) {
- trigger_error('register() not implemented in '.get_class($this), E_USER_WARNING);
- }
-
+ /**
+ * Registers a callback function for a given event
+ */
+ function register($controller) {
+ trigger_error('register() not implemented in '.get_class($this), E_USER_WARNING);
+ }
}