more phpdocs and minor check

inc/Input.class.php

@@ -131,7 +131,7 @@ public function set($name, $value) {
      * @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]))) {

inc/RemoteAPICore.php

@@ -318,7 +318,7 @@ function readNamespace($ns,$opts){
      * @return array
      */
     function search($query){
-        $regex = '';
+        $regex = array();
         $data  = ft_pageSearch($query,$regex);
         $pages = array();
 

inc/Tar.class.php

@@ -530,7 +530,7 @@ protected function writeFileHeader($name, $uid, $gid, $perm, $size, $mtime, $typ
      * 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;

inc/cli.php

@@ -471,7 +471,7 @@ public function parseOptions() {
      *
      * @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];

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();

inc/common.php

@@ -337,7 +337,7 @@ function buildAttributes($params, $skipempty = false) {
  *
  * @author Andreas Gohr <[email protected]>
  *
- * @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

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

inc/indexer.php

@@ -1248,7 +1248,7 @@ protected function indexLengths($filter) {
      * @author Tom N Harris <[email protected]>
      *
      * @param string $line
-     * @param string $id
+     * @param string|int $id
      * @param int    $count
      * @return string
      */

inc/parserutils.php

@@ -616,12 +616,13 @@ function p_sort_modes($a, $b){
  * @author Andreas Gohr <[email protected]>
  *
  * @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;

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 */