SimpleMachines / SMF2.1

other/upgrade.php

Doc Comments +16 added lines, -5 removed lines

@@ -502,6 +502,9 @@ 
 }
 
 // Used to direct the user to another location.
+/**
+ * @param string $location
+ */
 function redirectLocation($location, $addForm = true)
 {
 	global $upgradeurl, $upcontext, $command_line;
@@ -1745,6 +1748,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;
@@ -1779,6 +1785,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)
@@ -1993,6 +2003,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;
@@ -4763,7 +4776,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)
 {
@@ -4931,9 +4944,8 @@ 
  * settings file isn't using any advanced configuration setups in the Settings.php file.  A copy is made as Settings_org.php
  * to preserve all changes prior to migration.
  *
- * @param array $config_vars An array of one or more variables to update
  *
- * @return void We either succesfully update the Settings file, or throw a error here.
+ * @return boolean|null We either succesfully update the Settings file, or throw a error here.
  */
 function migrateSettingsFile($changes)
 {
@@ -5343,9 +5355,8 @@ 
  * Prior to checking these settings, we look for advanced setups such as integrations or if variables have been moved
  * to another file.  If these are detected, we abort.
  *
- * @param array $config_vars An array of one or more variables to update
  *
- * @return void We either succesfully update the Settings file, or throw a error here.
+ * @return boolean We either succesfully update the Settings file, or throw a error here.
  */
 
 function detectSettingsFileMigrationNeeded()