splitbrain / dokuwiki

inc/PassHash.class.php

Doc Comments +1 added lines

@@ -113,6 +113,7 @@
      * @param string|null &$salt  The salt, pass null if you want one generated
      * @param int          $len   The length of the salt
      * @param bool         $cut   Apply length restriction to existing salt?
+     * @param string|null $salt
      */
     public function init_salt(&$salt, $len = 32, $cut = true) {
         if(is_null($salt)) {

inc/remote.php

Doc Comments +1 added lines, -1 removed lines

@@ -306,7 +306,7 @@
     /**
      * Transform file to xml
      *
-     * @param mixed $data
+     * @param string|boolean $data
      * @return mixed
      */
     public function toFile($data) {

inc/utf8.php

Doc Comments +1 added lines, -1 removed lines

@@ -614,7 +614,7 @@
     /**
      * Decodes numeric HTML entities to their correct UTF-8 characters
      *
-     * @param $ent string A numeric entity
+     * @param string $ent string A numeric entity
      * @return string|false
      */
     function utf8_decode_numeric($ent) {

lib/plugins/authmysql/auth.php

Doc Comments +1 added lines, -1 removed lines

@@ -765,7 +765,7 @@
      * @author Matthias Grimm <matthiasgrimm@users.sourceforge.net>
      *
      * @param  string $user  user's nick to get data for
-     * @return false|array false on error, user info on success
+     * @return string false on error, user info on success
      */
     protected function _retrieveUserInfo($user) {
         $sql    = str_replace('%{user}', $this->_escape($user), $this->getConf('getUserInfo'));

lib/plugins/usermanager/admin.php

Doc Comments +1 added lines

@@ -1035,6 +1035,7 @@
      *
      * @param array  $user   data of user
      * @param string &$error reference catched error message
+     * @param string $error
      * @return bool whether successful
      */
     protected function _addImportUser($user, & $error){

inc/Form/Form.php

Doc Comments +1 added lines, -1 removed lines

@@ -286,7 +286,7 @@
      * Adds a label referencing another input element, allows HTML for content
      *
      * @param string $content
-     * @param string|Element $for
+     * @param string $for
      * @param int $pos
      * @return Element
      */

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