more phpdocs and minor check

10 files changed, 13 insertions, 12 deletions

diff --git a/inc/Input.class.php b/inc/Input.class.php
index f4a4612df..199994d8d 100644
--- a/inc/Input.class.php
+++ b/inc/Input.class.php
@@ -131,7 +131,7 @@ class Input {
      * @param string    $name Parameter name
      * @param mixed     $default If parameter is not set, initialize with this value
      * @param bool      $nonempty Init with $default if parameter is set but empty()
-     * @return &mixed
+     * @return mixed (reference)
      */
     public function &ref($name, $default = '', $nonempty = false) {
         if(!isset($this->access[$name]) || ($nonempty && empty($this->access[$name]))) {
diff --git a/inc/RemoteAPICore.php b/inc/RemoteAPICore.php
index b34fe7f20..c0e6869f1 100644
--- a/inc/RemoteAPICore.php
+++ b/inc/RemoteAPICore.php
@@ -318,7 +318,7 @@ class RemoteAPICore {
      * @return array
      */
     function search($query){
-        $regex = '';
+        $regex = array();
         $data  = ft_pageSearch($query,$regex);
         $pages = array();
 
diff --git a/inc/Tar.class.php b/inc/Tar.class.php
index 05831df58..04246846e 100644
--- a/inc/Tar.class.php
+++ b/inc/Tar.class.php
@@ -530,7 +530,7 @@ class Tar {
      * Decode the given tar file header
      *
      * @param string $block a 512 byte block containign the header data
-     * @return array|bool
+     * @return array|false
      */
     protected function parseHeader($block) {
         if(!$block || strlen($block) != 512) return false;
diff --git a/inc/cli.php b/inc/cli.php
index 29d76ece1..14e2c0c8d 100644
--- a/inc/cli.php
+++ b/inc/cli.php
@@ -471,7 +471,7 @@ class DokuCLI_Options {
      *
      * @param string $option
      * @param bool|string $default what to return if the option was not set
-     * @return false|string
+     * @return bool|string
      */
     public function getOpt($option, $default = false) {
         if(isset($this->options[$option])) return $this->options[$option];
diff --git a/inc/cliopts.php b/inc/cliopts.php
index c75a5a93b..f2782a465 100644
--- a/inc/cliopts.php
+++ b/inc/cliopts.php
@@ -78,7 +78,7 @@ class Doku_Cli_Opts {
      * @param string $bin_file      executing file name - this MUST be passed the __FILE__ constant
      * @param string $short_options short options
      * @param array  $long_options  (optional) long options
-     * @return Doku_Cli_Opts_Container or Doku_Cli_Opts_Error
+     * @return Doku_Cli_Opts_Container|Doku_Cli_Opts_Error
      */
     function & getOptions($bin_file, $short_options, $long_options = null) {
         $args = Doku_Cli_Opts::readPHPArgv();
diff --git a/inc/common.php b/inc/common.php
index 444e90198..7932fc9f0 100644
--- a/inc/common.php
+++ b/inc/common.php
@@ -337,7 +337,7 @@ function buildAttributes($params, $skipempty = false) {
  *
  * @author Andreas Gohr <andi@splitbrain.org>
  *
- * @return string[string] with the data: array(pageid=>name, ... )
+ * @return string[] with the data: array(pageid=>name, ... )
  */
 function breadcrumbs() {
     // we prepare the breadcrumbs early for quick session closing
diff --git a/inc/html.php b/inc/html.php
index adcd212ed..754e08edf 100644
--- a/inc/html.php
+++ b/inc/html.php
@@ -177,7 +177,7 @@ function html_topbtn(){
  * @param string         $name
  * @param string         $id
  * @param string         $akey   access key
- * @param string[string] $params key-value pairs added as hidden inputs
+ * @param string[] $params key-value pairs added as hidden inputs
  * @param string         $method
  * @param string         $tooltip
  * @param bool|string    $label  label text, false: lookup btn_$name in localization
diff --git a/inc/indexer.php b/inc/indexer.php
index ec0c523e0..014c5c5eb 100644
--- a/inc/indexer.php
+++ b/inc/indexer.php
@@ -1248,7 +1248,7 @@ class Doku_Indexer {
      * @author Tom N Harris <tnharris@whoopdedo.org>
      *
      * @param string $line
-     * @param string $id
+     * @param string|int $id
      * @param int    $count
      * @return string
      */
diff --git a/inc/parserutils.php b/inc/parserutils.php
index 791033e63..ef62c8e49 100644
--- a/inc/parserutils.php
+++ b/inc/parserutils.php
@@ -616,12 +616,13 @@ function p_sort_modes($a, $b){
  * @author Andreas Gohr <andi@splitbrain.org>
  *
  * @param string $mode
- * @param array  $instructions
+ * @param array|null|false  $instructions
  * @param array  $info returns render info like enabled toc and cache
  * @return null|string rendered output
  */
 function p_render($mode,$instructions,&$info){
     if(is_null($instructions)) return '';
+    if($instructions === false) return '';
 
     $Renderer = p_get_renderer($mode);
     if (is_null($Renderer)) return null;
diff --git a/inc/pluginutils.php b/inc/pluginutils.php
index 911c4e5c0..4d591869d 100644
--- a/inc/pluginutils.php
+++ b/inc/pluginutils.php
@@ -49,7 +49,7 @@ function plugin_load($type,$name,$new=false,$disabled=false) {
  * Whether plugin is disabled
  *
  * @param string $plugin name of plugin
- * @return bool; true disabled, false enabled
+ * @return bool true disabled, false enabled
  */
 function plugin_isdisabled($plugin) {
     /** @var $plugin_controller Doku_Plugin_Controller */
@@ -61,7 +61,7 @@ function plugin_isdisabled($plugin) {
  * Enable the plugin
  *
  * @param string $plugin name of plugin
- * @return bool; true saving succeed, false saving failed
+ * @return bool true saving succeed, false saving failed
  */
 function plugin_enable($plugin) {
     /** @var $plugin_controller Doku_Plugin_Controller */
@@ -73,7 +73,7 @@ function plugin_enable($plugin) {
  * Disable the plugin
  *
  * @param string $plugin name of plugin
- * @return bool; true saving succeed, false saving failed
+ * @return bool  true saving succeed, false saving failed
  */
 function plugin_disable($plugin) {
     /** @var $plugin_controller Doku_Plugin_Controller */