splitbrain / dokuwiki

lib/plugins/auth.php

Doc Comments +1 added lines, -1 removed lines

@@ -183,7 +183,7 @@
      * @param   string  $user    Username
      * @param   string  $pass    Cleartext Password
      * @param   bool    $sticky  Cookie should not expire
-     * @return  bool             true on successful auth
+     * @return  boolean|null             true on successful auth
      */
     public function trustExternal($user, $pass, $sticky = false) {
         /* some example:

lib/plugins/authplain/auth.php

Doc Comments +4 added lines, -1 removed lines

@@ -82,7 +82,7 @@ 
      * @author  Andreas Gohr <andi@splitbrain.org>
      * @param string $user
      * @param bool $requireGroups  (optional) ignored by this plugin, grps info always supplied
-     * @return array|false
+     * @return string
      */
     public function getUserData($user, $requireGroups=true) {
         if($this->users === null) $this->_loadUserData();
@@ -380,6 +380,9 @@ 
         return $users;
     }
 
+    /**
+     * @param string $line
+     */
     protected function _splitUserData($line){
         // due to a bug in PCRE 6.6, preg_split will fail with the regex we use here
         // refer github issues 877 & 885

inc/confutils.php

Doc Comments +2 added lines, -2 removed lines

@@ -23,7 +23,7 @@ 
  *
  * @param string $file file name
  * @param bool   $knownonly
- * @return array with extension, mimetype and if it should be downloaded
+ * @return string with extension, mimetype and if it should be downloaded
  */
 function mimetype($file, $knownonly=true){
     $mtypes = getMimeTypes();     // known mimetypes
@@ -244,7 +244,7 @@ 
  * @param string $file
  * @param bool $lower
  *
- * @return array
+ * @return string
  */
 function confToHash($file,$lower=false) {
     $conf = array();

inc/DifferenceEngine.php

Doc Comments +5 added lines, -2 removed lines

@@ -942,6 +942,9 @@ 
         $this->_tag = '';
     }
 
+    /**
+     * @param string $new_tag
+     */
     function _flushGroup($new_tag) {
         if ($this->_group !== '') {
             if ($this->_tag == 'mark')
@@ -1364,8 +1367,8 @@ 
     /**
      * @access private
      *
-     * @param array $edits1
-     * @param array $edits2
+     * @param _DiffOp[] $edits1
+     * @param _DiffOp[] $edits2
      *
      * @return array
      */

inc/init.php

Doc Comments +1 added lines, -1 removed lines

@@ -8,7 +8,7 @@
  *
  * @param integer $start
  *
- * @return mixed
+ * @return double
  */
 function delta_time($start=0) {
     return microtime(true)-((float)$start);

inc/JpegMeta.php

Doc Comments +14 added lines, -2 removed lines

@@ -2546,7 +2546,7 @@ 
      * @param string $header
      * @param mixed $value
      *
-     * @return int|mixed
+     * @return integer
      */
     function _write8BIM(&$data, $pos, $type, $header, &$value) {
         $signature = "8BIM";
@@ -2616,7 +2616,7 @@ 
      * @param string $type
      * @param mixed $value
      *
-     * @return int|mixed
+     * @return integer
      */
     function _writeIPTCEntry(&$data, $pos, $type, &$value) {
         $pos = $this->_putShort($data, $pos, 0x1C02);
@@ -2778,6 +2778,10 @@ 
     }
 
     /*************************************************************/
+
+    /**
+     * @param string $mode
+     */
     function _exifTagTypes($mode) {
         $tags = array();
 
@@ -2928,6 +2932,10 @@ 
     }
 
     /*************************************************************/
+
+    /**
+     * @param string $mode
+     */
     function _exifNameTags($mode) {
         $tags = $this->_exifTagNames($mode);
         return $this->_names2Tags($tags);
@@ -3008,6 +3016,10 @@ 
     }
 
     /*************************************************************/
+
+    /**
+     * @param integer $pos
+     */
     function _getShort(&$data, $pos, $bigEndian = true) {
         if ($bigEndian) {
             return (ord($data{$pos}) << 8)

inc/media.php

Doc Comments +5 added lines, -5 removed lines

@@ -638,7 +638,7 @@ 
  * @param string   $file    path to file
  * @param string   $mime    mime type
  * @param bool|int $old_rev revision timestamp or false
- * @return bool
+ * @return false|null
  */
 function media_notify($id,$file,$mime,$old_rev=false){
     global $conf;
@@ -908,7 +908,7 @@ 
  * @param string     $image media id
  * @param string     $ns
  * @param null|int   $auth  permission level
- * @param string|int $rev   revision timestamp or empty string
+ * @param boolean $rev   revision timestamp or empty string
  */
 function media_tab_view($image, $ns, $auth=null, $rev='') {
     global $lang;
@@ -977,7 +977,7 @@ 
  * @param string         $image media id
  * @param int            $auth permission level
  * @param int|string     $rev revision timestamp or empty string
- * @param JpegMeta|bool  $meta
+ * @param JpegMeta  $meta
  *
  * @author Kate Arzamastseva <pshns@ukr.net>
  */
@@ -1143,7 +1143,7 @@ 
  * @param string        $image image id
  * @param int           $auth  permission level
  * @param string|int    $rev   revision timestamp, or empty string
- * @param bool|JpegMeta $meta  image object, or create one if false
+ * @param JpegMeta $meta  image object, or create one if false
  */
 function media_details($image, $auth, $rev='', $meta=false) {
     global $lang;
@@ -1746,7 +1746,7 @@ 
  * @param string     $amp           separator
  * @param bool       $abs           absolute url?
  * @param bool       $params_array  return the parmeters array?
- * @return string|array - link or link parameters
+ * @return string[] - link or link parameters
  */
 function media_managerURL($params=false, $amp='&amp;', $abs=false, $params_array=false) {
     global $ID;

inc/parser/handler.php

Doc Comments +15 added lines

@@ -31,6 +31,9 @@ 
         $this->CallWriter->writeCall($call);
     }
 
+    /**
+     * @param integer $pos
+     */
     function addPluginCall($plugin, $args, $state, $pos, $match) {
         $call = array('plugin',array($plugin, $args, $state, $match), $pos);
         $this->CallWriter->writeCall($call);
@@ -728,8 +731,20 @@ 
 
 //------------------------------------------------------------------------
 interface Doku_Handler_CallWriter_Interface {
+
+    /**
+     * @return void
+     */
     public function writeCall($call);
+
+    /**
+     * @return void
+     */
     public function writeCalls($calls);
+
+    /**
+     * @return void
+     */
     public function finalise();
 }
 

inc/parser/lexer.php

Doc Comments +1 added lines, -1 removed lines

@@ -565,7 +565,7 @@
  *
  * @param string $str
  *
- * @return mixed
+ * @return string
  */
 function Doku_Lexer_Escape($str) {
     //$str = addslashes($str);