splitbrain / dokuwiki

inc/RemoteAPICore.php

Doc Comments +1 added lines, -1 removed lines

@@ -517,7 +517,7 @@
      * @param string $id page id
      * @param string $text wiki text
      * @param array $params such as summary,minor
-     * @return bool|string
+     * @return boolean
      */
     function appendPage($id, $text, $params) {
         $currentpage = $this->rawPage($id);

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) {

inc/ZipLib.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -343,7 +343,7 @@
     /**
      * @param resource $zip
      * @param string   $zip_name filename path to file
-     * @return array
+     * @return resource
      */
     function ReadCentralDir($zip,$zip_name) {
         $size = filesize($zip_name);

lib/exe/css.php

Doc Comments +4 added lines, -1 removed lines

@@ -262,7 +262,7 @@ 
  *
  * @param string $tpl the used template
  * @param bool   $preview load preview replacements
- * @return array with keys 'stylesheets' and 'replacements'
+ * @return string with keys 'stylesheets' and 'replacements'
  */
 function css_styleini($tpl, $preview=false) {
     global $conf;
@@ -437,6 +437,9 @@ 
     protected $location;             // base url location of the CSS/Less file
     protected $relative_path = null;
 
+    /**
+     * @param string $file
+     */
     public function __construct($file) {
         $this->filepath = $file;
     }

lib/plugins/acl/admin.php

Doc Comments +2 added lines

@@ -713,6 +713,8 @@
      *
      * @author  Frank Schubert <frank@schokilade.de>
      * @author  Andreas Gohr <andi@splitbrain.org>
+     * @param boolean $ispage
+     * @param string $name
      */
     function _html_checkboxes($setperm,$ispage,$name){
         global $lang;

lib/plugins/auth.php

Doc Comments +2 added lines, -2 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:
@@ -238,7 +238,7 @@ 
      * @author  Andreas Gohr <andi@splitbrain.org>
      * @param   string $user the user name
      * @param   bool $requireGroups whether or not the returned data must include groups
-     * @return  false|array containing user data or false
+     * @return  boolean containing user data or false
      */
     public function getUserData($user, $requireGroups=true) {
         if(!$this->cando['external']) msg("no valid authorisation system in use", -1);

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/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();
@@ -348,6 +348,9 @@ 
         }
     }
 
+    /**
+     * @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

lib/plugins/config/settings/extra.class.php

Doc Comments +2 added lines, -2 removed lines

@@ -174,7 +174,7 @@ 
          *
          * @param DokuWiki_Plugin $plugin object of config plugin
          * @param bool            $echo   true: show inputted value, when error occurred, otherwise the stored setting
-         * @return array with content array(string $label_html, string $input_html)
+         * @return string[] with content array(string $label_html, string $input_html)
          */
         function html(&$plugin, $echo=false) {
             global $lang;
@@ -283,7 +283,7 @@ 
          *
          * @param DokuWiki_Plugin $plugin object of config plugin
          * @param bool            $echo   true: show inputted value, when error occurred, otherwise the stored setting
-         * @return array with content array(string $label_html, string $input_html)
+         * @return string[] with content array(string $label_html, string $input_html)
          */
         function html(&$plugin, $echo=false) {