Yoshi2889 / SMF2.1

other/upgrade.php

Doc Comments +18 added lines

@@ -207,6 +207,9 @@ 
 // MD5 Encryption.
 if (!function_exists('md5_hmac'))
 {
+	/**
+	 * @param string $key
+	 */
 	function md5_hmac($data, $key)
 	{
 		if (strlen($key) > 64)
@@ -441,6 +444,9 @@ 
 }
 
 // Used to direct the user to another location.
+/**
+ * @param string $location
+ */
 function redirectLocation($location, $addForm = true)
 {
 	global $upgradeurl, $upcontext, $command_line;
@@ -2127,6 +2133,9 @@ 
 	return addslashes(preg_replace(array('~^\.([/\\\]|$)~', '~[/]+~', '~[\\\]+~', '~[/\\\]$~'), array($install_path . '$1', '/', '\\', ''), $path));
 }
 
+/**
+ * @param string $filename
+ */
 function parse_sql($filename)
 {
 	global $db_prefix, $db_collation, $boarddir, $boardurl, $command_line, $file_steps, $step_progress, $custom_warning;
@@ -2413,6 +2422,9 @@ 
 	return true;
 }
 
+/**
+ * @param string $string
+ */
 function upgrade_query($string, $unbuffered = false)
 {
 	global $db_connection, $db_server, $db_user, $db_passwd, $db_type, $command_line, $upcontext, $upgradeurl, $modSettings;
@@ -3042,6 +3054,9 @@ 
 	$upcontext['current_step'] = 1;
 }
 
+/**
+ * @param string $message
+ */
 function print_error($message, $fatal = false)
 {
 	static $fp = null;
@@ -3055,6 +3070,9 @@ 
 		exit;
 }
 
+/**
+ * @param string $message
+ */
 function throw_error($message)
 {
 	global $upcontext;

Sources/Class-Package.php

Doc Comments +4 added lines, -4 removed lines

@@ -257,7 +257,7 @@ 
 	 * of elements, an array of xmlArray's is returned for use with foreach.
 	 * Example use:
 	 *  foreach ($xml->set('html/body/p') as $p)
-	 * @param $path string The path to search for.
+	 * @param string $path string The path to search for.
 	 * @return array An array of xmlArray objects
 	 */
 	public function set($path)
@@ -855,7 +855,7 @@ 
 	 * Changes a files atrributes (chmod)
 	 *
 	 * @param string $ftp_file The file to CHMOD
-	 * @param int|string $chmod The value for the CHMOD operation
+	 * @param integer $chmod The value for the CHMOD operation
 	 * @return boolean Whether or not the operation was successful
 	 */
 	public function chmod($ftp_file, $chmod)
@@ -1025,7 +1025,7 @@ 
 	 *
 	 * @param string $ftp_path The path to the directory
 	 * @param bool $search Whether or not to get a recursive directory listing
-	 * @return string|boolean The results of the command or false if unsuccessful
+	 * @return false|string The results of the command or false if unsuccessful
 	 */
 	public function list_dir($ftp_path = '', $search = false)
 	{
@@ -1070,7 +1070,7 @@ 
 	 *
 	 * @param string $file The name of a file
 	 * @param string $listing A directory listing or null to generate one
-	 * @return string|boolean The name of the file or false if it wasn't found
+	 * @return string|false The name of the file or false if it wasn't found
 	 */
 	public function locate($file, $listing = null)
 	{

Sources/Load.php

Doc Comments +5 added lines, -5 removed lines

@@ -2225,9 +2225,9 @@ 
  *
  * @uses the template_include() function to include the file.
  * @param string $template_name The name of the template to load
- * @param array|string $style_sheets The name of a single stylesheet or an array of names of stylesheets to load
+ * @param string $style_sheets The name of a single stylesheet or an array of names of stylesheets to load
  * @param bool $fatal If true, dies with an error message if the template cannot be found
- * @return boolean Whether or not the template was loaded
+ * @return boolean|null Whether or not the template was loaded
  */
 function loadTemplate($template_name, $style_sheets = array(), $fatal = true)
 {
@@ -2411,7 +2411,7 @@ 
  * - all code added with this function is added to the same <style> tag so do make sure your css is valid!
  *
  * @param string $css Some css code
- * @return void|bool Adds the CSS to the $context['css_header'] array or returns if no CSS is specified
+ * @return false|null Adds the CSS to the $context['css_header'] array or returns if no CSS is specified
  */
 function addInlineCss($css)
 {
@@ -2427,7 +2427,7 @@ 
 /**
  * Add a Javascript file for output later
 
- * @param string $filename The name of the file to load
+ * @param string $fileName The name of the file to load
  * @param array $params An array of parameter info
  * Keys are the following:
  * 	- ['external'] (true/false): define if the file is a externally located file. Needs to be set to true if you are loading an external file
@@ -2525,7 +2525,7 @@ 
  *
  * @param string $javascript Some JS code
  * @param bool $defer Whether the script should load in <head> or before the closing <html> tag
- * @return void|bool Adds the code to one of the $context['javascript_inline'] arrays or returns if no JS was specified
+ * @return false|null Adds the code to one of the $context['javascript_inline'] arrays or returns if no JS was specified
  */
 function addInlineJavaScript($javascript, $defer = false)
 {

Sources/Subs.php

Doc Comments +3 added lines, -3 removed lines

@@ -676,7 +676,7 @@ 
  * - caches the formatting data from the setting for optimization.
  *
  * @param float $number A number
- * @param bool|int $override_decimal_count If set, will use the specified number of decimal places. Otherwise it's automatically determined
+ * @param integer $override_decimal_count If set, will use the specified number of decimal places. Otherwise it's automatically determined
  * @return string A formatted number
  */
 function comma_format($number, $override_decimal_count = false)
@@ -5015,7 +5015,7 @@ 
 
 /**
  * @param string $ip_address An IP address in IPv4, IPv6 or decimal notation
- * @return binary The IP address in binary or false
+ * @return string The IP address in binary or false
  */
 function inet_ptod($ip_address)
 {
@@ -5413,7 +5413,7 @@ 
  * It assumes the data is already a string.
  * @param string $data The data to print
  * @param string $type The content type. Defaults to Json.
- * @return void
+ * @return false|null
  */
 function smf_serverResponse($data = '', $type = 'Content-Type: application/json')
 {