summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGerrit Uitslag <klapinklapin@gmail.com>2014-12-03 00:09:45 +0100
committerGerrit Uitslag <klapinklapin@gmail.com>2014-12-03 00:09:45 +0100
commitcded11250d495f6039a20f1036c64ea7b230ceb2 (patch)
tree7f60717a7d4428e3998178c8d0f392443f92e5e9
parenta85f63dedee1c8ddf15757e204a170bf000d89dc (diff)
downloadrpg-cded11250d495f6039a20f1036c64ea7b230ceb2.tar.gz
rpg-cded11250d495f6039a20f1036c64ea7b230ceb2.tar.bz2
phpdocs syntax plugin base class
-rw-r--r--lib/plugins/syntax.php4
1 files changed, 2 insertions, 2 deletions
diff --git a/lib/plugins/syntax.php b/lib/plugins/syntax.php
index 4a301f927..7d2daa70d 100644
--- a/lib/plugins/syntax.php
+++ b/lib/plugins/syntax.php
@@ -70,7 +70,7 @@ class DokuWiki_Syntax_Plugin extends Doku_Parser_Mode_Plugin {
* @param int $state The lexer state for the match
* @param int $pos The character position of the matched text
* @param Doku_Handler $handler The Doku_Handler object
- * @return array Return an array with all data you want to use in render
+ * @return bool|array Return an array with all data you want to use in render, false don't add an instruction
*/
function handle($match, $state, $pos, Doku_Handler $handler){
trigger_error('handle() not implemented in '.get_class($this), E_USER_WARNING);
@@ -97,7 +97,7 @@ class DokuWiki_Syntax_Plugin extends Doku_Parser_Mode_Plugin {
* @param $format string output format being rendered
* @param $renderer Doku_Renderer the current renderer object
* @param $data array data created by handler()
- * @return boolean rendered correctly?
+ * @return boolean rendered correctly? (however, returned value is not used at the moment)
*/
function render($format, Doku_Renderer $renderer, $data) {
trigger_error('render() not implemented in '.get_class($this), E_USER_WARNING);