albertlast / SMF2.1

Sources/Errors.php

Doc Comments +1 added lines, -1 removed lines

@@ -474,7 +474,7 @@
  * Used by fatal_error(), fatal_lang_error()
  *
  * @param string $error The error
- * @param array $sprintf An array of data to be sprintf()'d into the specified message
+ * @param boolean $sprintf An array of data to be sprintf()'d into the specified message
  */
 function log_error_online($error, $sprintf = array())
 {

Sources/ScheduledTasks.php

Doc Comments +1 added lines, -1 removed lines

@@ -807,7 +807,7 @@
 /**
  * Send a group of emails from the mail queue.
  *
- * @param bool|int $number The number to send each loop through or false to use the standard limits
+ * @param integer $number The number to send each loop through or false to use the standard limits
  * @param bool $override_limit Whether to bypass the limit
  * @param bool $force_send Whether to forcibly send the messages now (useful when using cron jobs)
  * @return bool Whether things were sent

SSI.php

Doc Comments +5 added lines, -5 removed lines

@@ -1717,7 +1717,7 @@ 
 /**
  * Show today's birthdays.
  * @param string $output_method The output method. If 'echo', displays a list of users, otherwise returns an array of info about them.
- * @return void|array Displays a list of users or returns an array of info about them depending on output_method.
+ * @return null|string Displays a list of users or returns an array of info about them depending on output_method.
  */
 function ssi_todaysBirthdays($output_method = 'echo')
 {
@@ -1746,7 +1746,7 @@ 
 /**
  * Shows today's holidays.
  * @param string $output_method The output method. If 'echo', displays a list of holidays, otherwise returns an array of info about them.
- * @return void|array Displays a list of holidays or returns an array of info about them depending on output_method
+ * @return null|string Displays a list of holidays or returns an array of info about them depending on output_method
  */
 function ssi_todaysHolidays($output_method = 'echo')
 {
@@ -1773,7 +1773,7 @@ 
 
 /**
  * @param string $output_method The output method. If 'echo', displays a list of events, otherwise returns an array of info about them.
- * @return void|array Displays a list of events or returns an array of info about them depending on output_method
+ * @return null|string Displays a list of events or returns an array of info about them depending on output_method
  */
 function ssi_todaysEvents($output_method = 'echo')
 {
@@ -1807,7 +1807,7 @@ 
 /**
  * Shows today's calendar items (events, birthdays and holidays)
  * @param string $output_method The output method. If 'echo', displays a list of calendar items, otherwise returns an array of info about them.
- * @return void|array Displays a list of calendar items or returns an array of info about them depending on output_method
+ * @return null|string Displays a list of calendar items or returns an array of info about them depending on output_method
  */
 function ssi_todaysCalendar($output_method = 'echo')
 {
@@ -2198,7 +2198,7 @@ 
  * @param int|string $id The ID or username of a user
  * @param string $password The password to check
  * @param bool $is_username If true, treats $id as a username rather than a user ID
- * @return bool Whether or not the password is correct.
+ * @return null|boolean Whether or not the password is correct.
  */
 function ssi_checkPassword($id = null, $password = null, $is_username = false)
 {

Sources/ManagePosts.php

Indentation -1 removed lines

@@ -273,7 +273,6 @@
  * Modify any setting related to topics.
  * Requires the admin_forum permission.
  * Accessed from ?action=admin;area=postsettings;sa=topics.
-
  * @param bool $return_config Whether or not to return the config_vars array (used for admin search)
  * @return void|array Returns nothing or returns $config_vars if $return_config is true
  * @uses Admin template, edit_topic_settings sub-template.

Sources/ManageMaintenance.php

Indentation -1 removed lines

@@ -694,7 +694,6 @@
  * It shows as the maintain_forum admin area.
  * It is accessed from ?action=admin;area=maintain;sa=database;activity=optimize.
  * It also updates the optimize scheduled task such that the tables are not automatically optimized again too soon.
-
  * @uses the optimize sub template
  */
 function OptimizeTables()

other/upgrade.php

Doc Comments +14 added lines, -1 removed lines

@@ -393,6 +393,9 @@ 
 }
 
 // Used to direct the user to another location.
+/**
+ * @param string $location
+ */
 function redirectLocation($location, $addForm = true)
 {
 	global $upgradeurl, $upcontext, $command_line;
@@ -1573,6 +1576,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;
@@ -1607,6 +1613,10 @@ 
 
 	// Our custom error handler - does nothing but does stop public errors from XML!
 	set_error_handler(
+
+		/**
+		 * @param string $errno
+		 */
 		function ($errno, $errstr, $errfile, $errline) use ($support_js)
 		{
 			if ($support_js)
@@ -1853,6 +1863,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;
@@ -4512,7 +4525,7 @@ 
  * @param int $setSize The amount of entries after which to update the database.
  *
  * newCol needs to be a varbinary(16) null able field
- * @return bool
+ * @return boolean|null
  */
 function MySQLConvertOldIp($targetTable, $oldCol, $newCol, $limit = 50000, $setSize = 100)
 {

Indentation +1 added lines, -1 removed lines

@@ -82,7 +82,7 @@
 
 // The helper is crucial. Include it first thing.
 if (!file_exists($upgrade_path . '/upgrade-helper.php'))
-    die('upgrade-helper.php not found where it was expected: ' . $upgrade_path . '/upgrade-helper.php! Make sure you have uploaded ALL files from the upgrade package. The upgrader cannot continue.');
+	die('upgrade-helper.php not found where it was expected: ' . $upgrade_path . '/upgrade-helper.php! Make sure you have uploaded ALL files from the upgrade package. The upgrader cannot continue.');
 
 require_once($upgrade_path . '/upgrade-helper.php');
 

Themes/default/Calendar.template.php

Doc Comments +3 added lines, -3 removed lines

@@ -68,7 +68,7 @@ 
  * Display a list of upcoming events, birthdays, and holidays.
  *
  * @param string $grid_name The grid name
- * @return void|bool Returns false if the grid doesn't exist.
+ * @return false|null Returns false if the grid doesn't exist.
  */
 function template_show_upcoming_list($grid_name)
 {
@@ -238,7 +238,7 @@ 
  *
  * @param string $grid_name The grid name
  * @param bool $is_mini Is this a mini grid?
- * @return void|bool Returns false if the grid doesn't exist.
+ * @return false|null Returns false if the grid doesn't exist.
  */
 function template_show_month_grid($grid_name, $is_mini = false)
 {
@@ -523,7 +523,7 @@ 
  * Shows a weekly grid
  *
  * @param string $grid_name The name of the grid
- * @return void|bool Returns false if the grid doesn't exist
+ * @return false|null Returns false if the grid doesn't exist
  */
 function template_show_week_grid($grid_name)
 {

Indentation +6 added lines, -6 removed lines

@@ -437,9 +437,9 @@ 
 					{
 						// Sort events by start time (all day events will be listed first)
 						uasort($day['events'], function($a, $b) {
-						    if ($a['start_timestamp'] == $b['start_timestamp'])
-						        return 0;
-						    return ($a['start_timestamp'] < $b['start_timestamp']) ? -1 : 1;
+							if ($a['start_timestamp'] == $b['start_timestamp'])
+								return 0;
+							return ($a['start_timestamp'] < $b['start_timestamp']) ? -1 : 1;
 						});
 
 						echo '
@@ -619,9 +619,9 @@ 
 							{
 								// Sort events by start time (all day events will be listed first)
 								uasort($day['events'], function($a, $b) {
-								    if ($a['start_timestamp'] == $b['start_timestamp'])
-								        return 0;
-								    return ($a['start_timestamp'] < $b['start_timestamp']) ? -1 : 1;
+									if ($a['start_timestamp'] == $b['start_timestamp'])
+										return 0;
+									return ($a['start_timestamp'] < $b['start_timestamp']) ? -1 : 1;
 								});
 
 								foreach ($day['events'] as $event)

Sources/Subs.php

Doc Comments +2 added lines, -2 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)
@@ -5527,7 +5527,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')
 {

Indentation +1 added lines, -3 removed lines

@@ -5475,7 +5475,6 @@ 
 
 /**
  * Tries different modes to make file/dirs writable. Wrapper function for chmod()
-
  * @param string $file The file/dir full path.
  * @param int $value Not needed, added for legacy reasons.
  * @return boolean  true if the file/dir is already writable or the function was able to make it writable, false if the function couldn't make the file/dir writable.
@@ -5515,7 +5514,6 @@ 
 
 /**
  * Wrapper function for json_decode() with error handling.
-
  * @param string $json The string to decode.
  * @param bool $returnAsArray To return the decoded string as an array or an object, SMF only uses Arrays but to keep on compatibility with json_decode its set to false as default.
  * @param bool $logIt To specify if the error will be logged if theres any.
@@ -6006,7 +6004,7 @@ 
 		$cont = stream_context_get_params($read);
 		$result = isset($cont["options"]["ssl"]["peer_certificate"]) ? true : false;
 	}
-    return $result;
+	return $result;
 }
 
 /**

Sources/Load.php

Doc Comments +5 added lines, -5 removed lines

@@ -2259,9 +2259,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)
 {
@@ -2444,7 +2444,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)
 {
@@ -2558,7 +2558,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)
 {
@@ -2791,7 +2791,7 @@ 
  * It will try to choose only utf8 or non-utf8 languages.
  *
  * @param bool $use_cache Whether or not to use the cache
- * @return array An array of information about available languages
+ * @return string An array of information about available languages
  */
 function getLanguages($use_cache = true)
 {