Yoshi2889 / SMF2.1

Sources/Subs-Db-postgresql.php

Doc Comments +3 added lines, -4 removed lines

@@ -457,7 +457,6 @@ 
 
 /**
  * affected_rows
- * @param resource $connection
  */
 function smf_db_affected_rows($result = null)
 {
@@ -771,11 +770,11 @@ 
 /**
  * This function tries to work out additional error information from a back trace.
  *
- * @param $error_message
+ * @param string $error_message
  * @param $log_message
  * @param $error_type
- * @param $file
- * @param $line
+ * @param string $file
+ * @param integer $line
  */
 function smf_db_error_backtrace($error_message, $log_message = '', $error_type = false, $file = null, $line = null)
 {

Sources/Subs-Db-sqlite.php

Doc Comments +3 added lines, -3 removed lines

@@ -645,11 +645,11 @@
 /**
  * This function tries to work out additional error information from a back trace.
  *
- * @param $error_message
+ * @param string $error_message
  * @param $log_message
  * @param $error_type
- * @param $file
- * @param $line
+ * @param string $file
+ * @param integer $line
  */
 function smf_db_error_backtrace($error_message, $log_message = '', $error_type = false, $file = null, $line = null)
 {

Sources/Subs-Graphics.php

Doc Comments +6 added lines, -7 removed lines

@@ -29,7 +29,6 @@ 
  * - updates the database info for the member's avatar.
  * - returns whether the download and resize was successful.
  *
- * @param string $temporary_path, the full path to the temporary file
  * @param int $memID, member ID
  * @param int $max_width
  * @param int $max_height
@@ -205,7 +204,7 @@ 
  *
  * @param string $fileName
  * @param bool $extensiveCheck = false
- * @return true on success, false on failure.
+ * @return boolean on success, false on failure.
  */
 function checkImageContents($fileName, $extensiveCheck = false)
 {
@@ -248,7 +247,7 @@ 
  * Sets a global $gd2 variable needed by some functions to determine
  * whether the GD2 library is present.
  *
- * @return whether or not GD1 is available.
+ * @return boolean or not GD1 is available.
  */
 function checkGD()
 {
@@ -267,7 +266,7 @@ 
 /**
  * Checks whether the Imagick class is present.
  *
- * @return whether or not Imagick is available.
+ * @return boolean or not Imagick is available.
  */
 function checkImagick()
 {
@@ -277,7 +276,7 @@ 
 /**
  * See if we have enough memory to thumbnail an image
  *
- * @return whether we do
+ * @return boolean we do
  */
 function imageMemoryCheck($sizes)
 {
@@ -310,7 +309,7 @@ 
  * @param int $max_width
  * @param int $max_height
  * @param int $preferred_format = 0
- * @return whether it succeeded.
+ * @return boolean it succeeded.
  */
 function resizeImageFile($source, $destination, $max_width, $max_height, $preferred_format = 0)
 {
@@ -761,7 +760,7 @@ 
  * Outputs a gif or a png (depending on whether gif ix supported).
  *
  * @param string $code
- * @return false if something goes wrong.
+ * @return false|null if something goes wrong.
  */
 function showCodeImage($code)
 {

Sources/Subs-Menu.php

Doc Comments +1 added lines, -1 removed lines

@@ -280,7 +280,7 @@
 /**
  * Delete a menu.
  * @param string $menu_id = 'last'
- * @return bool
+ * @return false|null
  */
 function destroyMenu($menu_id = 'last')
 {

Sources/Subs-OpenID.php

Doc Comments +8 added lines, -5 removed lines

@@ -81,7 +81,7 @@ 
 
 /**
  * Revalidate a user using OpenID. Note that this function will not return when authentication is required.
- * @return bool
+ * @return boolean|null
  */
 function smf_openID_revalidate()
 {
@@ -104,7 +104,7 @@ 
  * @param string $server
  * @param string $handle = null
  * @param bool $no_delete = false
- * @return array
+ * @return string
  */
 function smf_openID_getAssociation($server, $handle = null, $no_delete = false)
 {
@@ -147,7 +147,7 @@ 
 /**
  * @todo Enter description here ...
  * @param string $server
- * @return array
+ * @return string
  */
 function smf_openID_makeAssociation($server)
 {
@@ -401,7 +401,7 @@ 
 
 /**
  * @todo Enter description here ...
- * @param string $uri
+ * @param string $url
  * @return array
  */
 function smf_openid_member_exists($url)
@@ -480,7 +480,7 @@ 
 
 /**
  * @todo Enter description here ...
- * @return float
+ * @return string
  */
 function smf_openid_generate_private_key()
 {
@@ -580,6 +580,9 @@ 
 	return $hmac;
 }
 
+/**
+ * @param string $str
+ */
 function binary_to_long($str)
 {
 	$bytes = array_merge(unpack('C*', $str));

Sources/Subs-Package.php

Doc Comments +7 added lines, -6 removed lines

@@ -22,7 +22,7 @@ 
 /**
  * Reads a .tar.gz file, filename, in and extracts file(s) from it.
  * essentially just a shortcut for read_tgz_data().
- * @param string $filename
+ * @param string $gzfilename
  * @param string $destination
  * @param bool $single_file = false
  * @param bool $overwrite = false
@@ -72,7 +72,8 @@ 
  * @param bool single_file = false,
  * @param bool overwrite = false,
  * @param array files_to_extract = null
- * @return array
+ * @param string $destination
+ * @return string
  */
 function read_tgz_data($data, $destination, $single_file = false, $overwrite = false, $files_to_extract = null)
 {
@@ -342,6 +343,7 @@ 
  * Checks the existence of a remote file since file_exists() does not do remote.
  * will return false if the file is "moved permanently" or similar.
  * @param string url
+ * @param string|null $url
  * @return bool true if the remote url exists.
  */
 function url_exists($url)
@@ -432,7 +434,7 @@ 
  * - otherwise returns a basic array of id, version, filename, and similar information.
  * - an xmlArray is available in 'xml'.
  *
- * @param string $filename
+ * @param string $gzfilename
  * @return array
  */
 function getPackageInfo($gzfilename)
@@ -1442,6 +1444,7 @@ 
  * - returns true if the version matched.
  *
  * @param string $versions
+ * @param string $the_version
  * @return highest install value string or false
  */
 function matchHighestPackageVersion($versions, $reset = false, $the_version)
@@ -1617,8 +1620,7 @@ 
 /**
  * Deletes a directory, and all the files and direcories inside it.
  * requires access to delete these files.
- * @param string $path
- * @param bool $delete_directory = true
+ * @param bool $delete_dir = true
  */
 function deltree($dir, $delete_dir = true)
 {
@@ -1692,7 +1694,6 @@ 
 /**
  * Creates the specified tree structure with the mode specified.
  * creates every directory in path until it finds one that already exists.
- * @param string $path
  * @param int $mode
  * @return bool true if successful, false otherwise
  */

Sources/Subs-Post.php

Doc Comments +2 added lines, -1 removed lines

@@ -1414,7 +1414,7 @@ 
  * @param string $message - the message to send
  * @param resource $socket - socket to send on
  * @param string $response - the expected response code
- * @return whether it responded as such.
+ * @return string|boolean it responded as such.
  */
 function server_parse($message, $socket, $response)
 {
@@ -2793,6 +2793,7 @@ 
  * @param string $type, types supported are 'approval', 'activation', and 'standard'.
  * @param int $memberID
  * @param string $member_name = null
+ * @param string $type
  * @uses the Login language file.
  */
 function adminNotify($type, $memberID, $member_name = null)

Sources/Subs-Sound.php

Doc Comments +1 added lines, -1 removed lines

@@ -24,7 +24,7 @@
  * Used by VerificationCode() (Register.php).
  *
  * @param string $word
- * @return bool false on failure
+ * @return null|false false on failure
  */
 
 function createWaveFile($word)

Sources/Subs.php

Doc Comments +6 added lines, -5 removed lines

@@ -730,7 +730,7 @@ 
  * - additionally converts   and '.
  *
  * @param string $string
- * @return the string without entities
+ * @return string string without entities
  */
 function un_htmlspecialchars($string)
 {
@@ -833,7 +833,7 @@ 
  * @param string $message
  * @param bool $smileys = true
  * @param string $cache_id = ''
- * @param array $parse_tags = null
+ * @param string[] $parse_tags = null
  * @return string
  */
 function parse_bbc($message, $smileys = true, $cache_id = '', $parse_tags = array())
@@ -3482,6 +3482,7 @@ 
  * Lookup an IP; try shell_exec first because we can do a timeout on it.
  *
  * @param string $ip
+ * @return string
  */
 function host_from_ip($ip)
 {
@@ -3584,11 +3585,11 @@ 
 /**
  * Creates an image/text button
  *
- * @param string $filename
  * @param string $alt
  * @param string $label = ''
- * @param bool $custom = ''
+ * @param string|boolean $custom = ''
  * @param bool $force_use = false
+ * @param string $name
  * @return string
  */
 function create_button($name, $alt, $label = '', $custom = '', $force_use = false)
@@ -4041,7 +4042,7 @@ 
  * supports static class method calls.
  *
  * @param string $hook
- * @param array $paramaters = array()
+ * @param array $parameters = array()
  * @return array the results of the functions
  */
 function call_integration_hook($hook, $parameters = array())