mambax7 / XoopsCore25

htdocs/include/functions.php

Doc Comments +12 added lines, -12 removed lines

@@ -20,7 +20,7 @@ 
 /**
  * xoops_getHandler()
  *
- * @param mixed $name
+ * @param string $name
  * @param mixed $optional
  *
  * @return XoopsObjectHandler|false
@@ -53,7 +53,7 @@ 
 /**
  * xoops_getModuleHandler()
  *
- * @param mixed $name
+ * @param string $name
  * @param mixed $module_dir
  * @param mixed $optional
  * @return XoopsObjectHandler|false
@@ -300,7 +300,7 @@ 
 /**
  * xoops_error
  *
- * @param mixed  $msg
+ * @param string  $msg
  * @param string $title
  * @return void
  */
@@ -394,7 +394,7 @@ 
  *
  * @param mixed  $time
  * @param string $timeoffset
- * @return int
+ * @return double
  */
 function xoops_getUserTimestamp($time, $timeoffset = '')
 {
@@ -590,7 +590,7 @@ 
  * formatURL()
  *
  * @param mixed $url
- * @return mixed|string
+ * @return string
  */
 function formatURL($url)
 {
@@ -671,7 +671,7 @@ 
 
 /**
  * Function to redirect a user to certain pages
- * @param        $url
+ * @param        string $url
  * @param int    $time
  * @param string $message
  * @param bool   $addredirect
@@ -755,7 +755,7 @@ 
 /**
  * xoops_getenv()
  *
- * @param mixed $key
+ * @param string $key
  * @return string
  */
 function xoops_getenv($key)
@@ -842,7 +842,7 @@ 
  * xoops_getrank()
  *
  * @param integer $rank_id
- * @param mixed   $posts
+ * @param integer   $posts
  * @return
  */
 function xoops_getrank($rank_id = 0, $posts = 0)
@@ -1045,7 +1045,7 @@ 
 /**
  * xoops_getOption()
  *
- * @param mixed $option
+ * @param string $option
  * @internal param string $type
  * @deprecated
  * @return string
@@ -1066,7 +1066,7 @@ 
 /**
  * xoops_getConfigOption()
  *
- * @param mixed  $option
+ * @param string  $option
  * @param array|string $type
  * @internal param string $dirname
  * @deprecated
@@ -1098,7 +1098,7 @@ 
 /**
  * xoops_setConfigOption()
  *
- * @param mixed $option
+ * @param string $option
  * @param null  $new
  * @return void
 @deprecated
@@ -1118,7 +1118,7 @@ 
  *
  * Method for module developers getting a module config item. This could be from any module requested.
  *
- * @param mixed  $option
+ * @param string  $option
  * @param string $dirname
  * @return bool
 @deprecated

htdocs/include/old_functions.php

Doc Comments +20 added lines, -20 removed lines

@@ -219,31 +219,31 @@
 /**
  * showThread :: DO NOT USE
  *
- * @param unknown_type         $color_number
- * @param unknown_type         $subject_image
+ * @param integer         $color_number
+ * @param string         $subject_image
  * @param unknown_type         $subject
  * @param unknown_type         $text
- * @param unknown_type         $post_date
- * @param unknown_type         $ip_image
- * @param unknown_type         $reply_image
- * @param unknown_type         $edit_image
- * @param unknown_type         $delete_image
+ * @param string         $post_date
+ * @param string         $ip_image
+ * @param string         $reply_image
+ * @param string         $edit_image
+ * @param string         $delete_image
  * @param string|\unknown_type $username
  * @param string|\unknown_type $rank_title
  * @param string|\unknown_type $rank_image
- * @param string|\unknown_type $avatar_image
- * @param string|\unknown_type $reg_date
- * @param string|\unknown_type $posts
- * @param string|\unknown_type $user_from
- * @param string|\unknown_type $online_image
- * @param string|\unknown_type $profile_image
- * @param string|\unknown_type $pm_image
- * @param string|\unknown_type $email_image
- * @param string|\unknown_type $www_image
- * @param string|\unknown_type $icq_image
- * @param string|\unknown_type $aim_image
- * @param string|\unknown_type $yim_image
- * @param string|\unknown_type $msnm_image
+ * @param string $avatar_image
+ * @param string $reg_date
+ * @param string $posts
+ * @param string $user_from
+ * @param string $online_image
+ * @param string $profile_image
+ * @param string $pm_image
+ * @param string $email_image
+ * @param string $www_image
+ * @param string $icq_image
+ * @param string $aim_image
+ * @param string $yim_image
+ * @param string $msnm_image
  */
 function showThread($color_number, $subject_image, $subject, $text, $post_date, $ip_image, $reply_image, $edit_image, $delete_image, $username = '', $rank_title = '', $rank_image = '', $avatar_image = '', $reg_date = '', $posts = '', $user_from = '', $online_image = '', $profile_image = '', $pm_image = '', $email_image = '', $www_image = '', $icq_image = '', $aim_image = '', $yim_image = '', $msnm_image = '')
 {

htdocs/modules/system/class/avatar.php

Doc Comments +1 added lines, -1 removed lines

@@ -114,7 +114,7 @@
      * Create new Object
      *
      * @param  bool $isNew
-     * @return object
+     * @return SystemAvatar
      */
     public function create($isNew = true)
     {

htdocs/modules/system/class/thumbs/phpthumb.gif.php

Doc Comments +46 added lines

@@ -64,6 +64,9 @@ 
 
 ///////////////////////////////////////////////////////////////////////////////////////////////////
 
+/**
+ * @param string $lpszFileName
+ */
 function gif_outputAsBmp($gif, $lpszFileName, $bgColor = -1)
 {
 	if (!isset($gif) || (@get_class($gif) <> 'cgif') || !$gif->loaded() || ($lpszFileName == '')) {
@@ -186,6 +189,10 @@ 
 
 	///////////////////////////////////////////////////////////////////////////
 
+	/**
+	 * @param string $data
+	 * @param integer $datLen
+	 */
 	function deCompress($data, &$datLen)
 	{
 		$stLen  = strlen($data);
@@ -210,6 +217,11 @@ 
 
 	///////////////////////////////////////////////////////////////////////////
 
+	/**
+	 * @param boolean $bInit
+	 *
+	 * @return integer
+	 */
 	function LZWCommand(&$data, $bInit)
 	{
 		if ($bInit) {
@@ -392,6 +404,10 @@ 
 
 	///////////////////////////////////////////////////////////////////////////
 
+	/**
+	 * @param string $lpData
+	 * @param integer $num
+	 */
 	function load($lpData, $num)
 	{
 		$this->m_nColors  = 0;
@@ -504,6 +520,9 @@ 
 
 	///////////////////////////////////////////////////////////////////////////
 
+	/**
+	 * @param integer $hdrLen
+	 */
 	function load($lpData, &$hdrLen)
 	{
 		$hdrLen = 0;
@@ -541,6 +560,9 @@ 
 
 	///////////////////////////////////////////////////////////////////////////
 
+	/**
+	 * @param string $str
+	 */
 	function w2i($str)
 	{
 		return ord(substr($str, 0, 1)) + (ord(substr($str, 1, 1)) << 8);
@@ -579,6 +601,10 @@ 
 
 	///////////////////////////////////////////////////////////////////////////
 
+	/**
+	 * @param string $lpData
+	 * @param integer $hdrLen
+	 */
 	function load($lpData, &$hdrLen)
 	{
 		$hdrLen = 0;
@@ -612,6 +638,9 @@ 
 
 	///////////////////////////////////////////////////////////////////////////
 
+	/**
+	 * @param string $str
+	 */
 	function w2i($str)
 	{
 		return ord(substr($str, 0, 1)) + (ord(substr($str, 1, 1)) << 8);
@@ -649,6 +678,10 @@ 
 
 	///////////////////////////////////////////////////////////////////////////
 
+	/**
+	 * @param string $data
+	 * @param integer $datLen
+	 */
 	function load($data, &$datLen)
 	{
 		$datLen = 0;
@@ -696,6 +729,10 @@ 
 
 	///////////////////////////////////////////////////////////////////////////
 
+	/**
+	 * @param string $data
+	 * @param integer $extLen
+	 */
 	function skipExt(&$data, &$extLen)
 	{
 		$extLen = 0;
@@ -741,6 +778,9 @@ 
 
 	///////////////////////////////////////////////////////////////////////////
 
+	/**
+	 * @param string $str
+	 */
 	function w2i($str)
 	{
 		return ord(substr($str, 0, 1)) + (ord(substr($str, 1, 1)) << 8);
@@ -814,6 +854,9 @@ 
 
 	///////////////////////////////////////////////////////////////////////////
 
+	/**
+	 * @param integer $iIndex
+	 */
 	function loadFile($lpszFileName, $iIndex)
 	{
 		if ($iIndex < 0) {
@@ -967,6 +1010,9 @@ 
 
 	///////////////////////////////////////////////////////////////////////////
 
+	/**
+	 * @param integer $bgColor
+	 */
 	function getPng($bgColor)
 	{
 		$out = '';

htdocs/xoops_lib/modules/protector/filters_disabled/postcommon_post_language_match.php

Doc Comments +1 added lines, -1 removed lines

@@ -116,7 +116,7 @@
     /**
      * Execute the filter
      *
-     * @return bool
+     * @return boolean|null
      */
     public function execute()
     {

htdocs/xoops_lib/modules/protector/filters_disabled/postcommon_post_stopforumspam.php

Doc Comments +1 added lines, -1 removed lines

@@ -23,7 +23,7 @@
     protected $minimumConfidence = 65.0; // set at your desired threshold
 
     /**
-     * @return bool
+     * @return boolean|null
      */
     public function execute()
     {

htdocs/xoops_lib/modules/protector/library/HTMLPurifier/AttrDef/CSS/Length.php

Doc Comments +1 added lines, -1 removed lines

@@ -34,7 +34,7 @@
      * @param string $string
      * @param HTMLPurifier_Config $config
      * @param HTMLPurifier_Context $context
-     * @return bool|string
+     * @return false|string
      */
     public function validate($string, $config, $context)
     {

htdocs/xoops_lib/modules/protector/library/HTMLPurifier/AttrDef/HTML/Pixels.php

Doc Comments +1 added lines, -1 removed lines

@@ -24,7 +24,7 @@
      * @param string $string
      * @param HTMLPurifier_Config $config
      * @param HTMLPurifier_Context $context
-     * @return bool|string
+     * @return string|false
      */
     public function validate($string, $config, $context)
     {

htdocs/class/cache/xoopscache.php

Doc Comments +7 added lines, -7 removed lines

@@ -79,7 +79,7 @@ 
      * Tries to find and include a file for a cache engine and returns object instance
      *
      * @param  $name Name of the engine
-     * @return mixed $engine object or null
+     * @return boolean $engine object or null
      * @access private
      */
     private function loadEngine($name)
@@ -206,7 +206,7 @@ 
      *
      * @param  string $key       Identifier for the data
      * @param  mixed  $value     Data to be cached - anything except a resource
-     * @param  mixed  $duration  Optional - string configuration name OR how long to cache the data, either in seconds or a
+     * @param  string  $duration  Optional - string configuration name OR how long to cache the data, either in seconds or a
      *                           string that can be parsed by the strtotime() function OR array('config' => 'default', 'duration' => '3600')
      * @return boolean True if the data was successfully cached, false on failure
      * @access public
@@ -384,7 +384,7 @@ 
      * generates a safe key
      *
      * @param  string $key the key passed over
-     * @return mixed  string $key or false
+     * @return false|string  string $key or false
      * @access private
      */
     public function key($key)
@@ -449,7 +449,7 @@ 
      * @param  string $key      Identifier for the data
      * @param  mixed  $value    Data to be cached
      * @param  mixed  $duration How long to cache the data, in seconds
-     * @return boolean True if the data was successfully cached, false on failure
+     * @return boolean|null True if the data was successfully cached, false on failure
      * @access public
      */
     public function write($key, $value, $duration = null)
@@ -473,7 +473,7 @@ 
      * Delete a key from the cache
      *
      * @param  string $key Identifier for the data
-     * @return boolean True if the value was successfully deleted, false if it didn't exist or couldn't be removed
+     * @return boolean|null True if the value was successfully deleted, false if it didn't exist or couldn't be removed
      * @access public
      */
     public function delete($key)
@@ -484,7 +484,7 @@ 
      * Delete all keys from the cache
      *
      * @param  boolean $check if true will check expiration, otherwise delete all
-     * @return boolean True if the cache was successfully cleared, false otherwise
+     * @return boolean|null True if the cache was successfully cleared, false otherwise
      * @access public
      */
     public function clear($check)
@@ -494,7 +494,7 @@ 
     /**
      * Cache Engine settings
      *
-     * @return array settings
+     * @return integer settings
      * @access public
      */
     public function settings()