From 253d4b48ec708eb42033862dc15c8576f44a48ed Mon Sep 17 00:00:00 2001
From: Gerrit Uitslag <klapinklapin@gmail.com>
Date: Wed, 1 Oct 2014 15:32:05 +0200
Subject: more PHPDocs, unused var, small bit code reformatting

---
 lib/plugins/syntax.php | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

(limited to 'lib/plugins/syntax.php')

diff --git a/lib/plugins/syntax.php b/lib/plugins/syntax.php
index 4a301f927..7acf681e4 100644
--- a/lib/plugins/syntax.php
+++ b/lib/plugins/syntax.php
@@ -52,6 +52,7 @@ class DokuWiki_Syntax_Plugin extends Doku_Parser_Mode_Plugin {
      * 'stack'  - Special case. Plugin wraps other paragraphs.
      *
      * @see Doku_Handler_Block
+     *
      * @return string
      */
     function getPType(){
@@ -94,9 +95,9 @@ class DokuWiki_Syntax_Plugin extends Doku_Parser_Mode_Plugin {
      * The contents of the $data array depends on what the handler() function above
      * created
      *
-     * @param   $format   string        output format being rendered
-     * @param   $renderer Doku_Renderer the current renderer object
-     * @param   $data     array         data created by handler()
+     * @param string          $format   output format being rendered
+     * @param Doku_Renderer   $renderer the current renderer object
+     * @param array           $data     data created by handler()
      * @return  boolean                 rendered correctly?
      */
     function render($format, Doku_Renderer $renderer, $data) {
-- 
cgit v1.2.3


From cded11250d495f6039a20f1036c64ea7b230ceb2 Mon Sep 17 00:00:00 2001
From: Gerrit Uitslag <klapinklapin@gmail.com>
Date: Wed, 3 Dec 2014 00:09:45 +0100
Subject: phpdocs syntax plugin base class

---
 lib/plugins/syntax.php | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

(limited to 'lib/plugins/syntax.php')

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);
-- 
cgit v1.2.3