SimpleMachines / 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;
@@ -2128,6 +2134,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;
@@ -2414,6 +2423,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;
@@ -3043,6 +3055,9 @@ 
 	$upcontext['current_step'] = 1;
 }
 
+/**
+ * @param string $message
+ */
 function print_error($message, $fatal = false)
 {
 	static $fp = null;
@@ -3056,6 +3071,9 @@ 
 		exit;
 }
 
+/**
+ * @param string $message
+ */
 function throw_error($message)
 {
 	global $upcontext;

Sources/CacheAPI-smf.php

Doc Comments +1 added lines, -1 removed lines

@@ -180,7 +180,7 @@
 	 *
 	 * @access public
 	 * @param string $dir A valid path
-	 * @return boolean If this was successful or not.
+	 * @return boolean|null If this was successful or not.
 	 */
 	public function setCachedir($dir = null)
 	{

Sources/Class-CurlFetchWeb.php

Doc Comments +4 added lines, -4 removed lines

@@ -62,7 +62,7 @@ 
 	* Start the curl object
 	* - allow for user override values
 	*
-	* @param array $options An array of cURL options
+	* @param integer[] $options An array of cURL options
 	* @param int $max_redirect Maximum number of redirects
 	* @return void
 	*/
@@ -81,8 +81,8 @@ 
 	*  - calls set_options to set the curl opts array values based on the defaults and user input
 	*
 	* @param string $url the site we are going to fetch
-	* @param array $post_data any post data as form name => value
-	* @return object An instance of the curl_fetch_web_data class
+	* @param string $post_data any post data as form name => value
+	* @return curl_fetch_web_data An instance of the curl_fetch_web_data class
 	*/
 	public function get_url_data($url, $post_data = array())
 	{
@@ -106,7 +106,7 @@ 
 	*
 	* @param string $url The site to fetch
 	* @param bool $redirect Whether or not this was a redirect request
-	* @return void|bool Sets various properties of the class or returns false if the URL isn't specified
+	* @return false|null Sets various properties of the class or returns false if the URL isn't specified
 	*/
 	private function curl_request($url, $redirect = false)
 	{

Sources/Class-Graphics.php

Doc Comments +28 added lines

@@ -44,6 +44,10 @@ 
 		$this->Buf   = range(0, 279);
 	}
 
+	/**
+	 * @param string $data
+	 * @param integer $datLen
+	 */
 	public function decompress($data, &$datLen)
 	{
 		$stLen  = strlen($data);
@@ -63,6 +67,11 @@ 
 		return $ret;
 	}
 
+	/**
+	 * @param boolean $bInit
+	 *
+	 * @return integer
+	 */
 	public function LZWCommand(&$data, $bInit)
 	{
 		if ($bInit)
@@ -253,6 +262,10 @@ 
 		unset($this->m_nColors, $this->m_arColors);
 	}
 
+	/**
+	 * @param string $lpData
+	 * @param integer $num
+	 */
 	public function load($lpData, $num)
 	{
 		$this->m_nColors  = 0;
@@ -324,6 +337,9 @@ 
 		unset($this->m_bSorted, $this->m_nTableSize, $this->m_nBgColor, $this->m_nPixelRatio, $this->m_colorTable);
 	}
 
+	/**
+	 * @param integer $hdrLen
+	 */
 	public function load($lpData, &$hdrLen)
 	{
 		$hdrLen = 0;
@@ -370,6 +386,10 @@ 
 		unset($this->m_bInterlace, $this->m_bSorted, $this->m_nTableSize, $this->m_colorTable);
 	}
 
+	/**
+	 * @param string $lpData
+	 * @param integer $hdrLen
+	 */
 	public function load($lpData, &$hdrLen)
 	{
 		$hdrLen = 0;
@@ -412,6 +432,10 @@ 
 		$this->m_lzw = new gif_lzw_compression();
 	}
 
+	/**
+	 * @param string $data
+	 * @param integer $datLen
+	 */
 	public function load($data, &$datLen)
 	{
 		$datLen = 0;
@@ -464,6 +488,10 @@ 
 		return false;
 	}
 
+	/**
+	 * @param string $data
+	 * @param integer $extLen
+	 */
 	public function skipExt(&$data, &$extLen)
 	{
 		$extLen = 0;

Switch Indentation +66 added lines, -66 removed lines

@@ -425,40 +425,40 @@ 
 			switch ($b)
 			{
 			// Extension...
-			case 0x21:
-				$len = 0;
-				if (!$this->skipExt($data, $len))
-					return false;
+				case 0x21:
+					$len = 0;
+					if (!$this->skipExt($data, $len))
+						return false;
 
-				$datLen += $len;
-				break;
+					$datLen += $len;
+					break;
 
-			// Image...
-			case 0x2C:
-				// Load the header and color table.
-				$len = 0;
-				if (!$this->m_gih->load($data, $len))
-					return false;
+				// Image...
+				case 0x2C:
+					// Load the header and color table.
+					$len = 0;
+					if (!$this->m_gih->load($data, $len))
+						return false;
 
-				$data = substr($data, $len);
-				$datLen += $len;
+					$data = substr($data, $len);
+					$datLen += $len;
 
-				// Decompress the data, and ride on home ;).
-				$len = 0;
-				if (!($this->m_data = $this->m_lzw->decompress($data, $len)))
-					return false;
+					// Decompress the data, and ride on home ;).
+					$len = 0;
+					if (!($this->m_data = $this->m_lzw->decompress($data, $len)))
+						return false;
 
-				$data = substr($data, $len);
-				$datLen += $len;
+					$data = substr($data, $len);
+					$datLen += $len;
 
-				if ($this->m_gih->m_bInterlace)
-					$this->deInterlace();
+					if ($this->m_gih->m_bInterlace)
+						$this->deInterlace();
 
-				return true;
+					return true;
 
-			case 0x3B: // EOF
-			default:
-				return false;
+				case 0x3B: // EOF
+				default:
+					return false;
 			}
 		}
 		return false;
@@ -475,27 +475,27 @@ 
 		switch ($b)
 		{
 		// Graphic Control...
-		case 0xF9:
-			$b = ord($data[1]);
-			$this->m_disp   = ($b & 0x1C) >> 2;
-			$this->m_bUser  = ($b & 0x02) ? true : false;
-			$this->m_bTrans = ($b & 0x01) ? true : false;
-			list ($this->m_nDelay) = array_values(unpack('v', substr($data, 2, 2)));
-			$this->m_nTrans = ord($data[4]);
-			break;
-
-		// Comment...
-		case 0xFE:
-			$this->m_lpComm = substr($data, 1, ord($data[0]));
-			break;
-
-		// Plain text...
-		case 0x01:
-			break;
-
-		// Application...
-		case 0xFF:
-			break;
+			case 0xF9:
+				$b = ord($data[1]);
+				$this->m_disp   = ($b & 0x1C) >> 2;
+				$this->m_bUser  = ($b & 0x02) ? true : false;
+				$this->m_bTrans = ($b & 0x01) ? true : false;
+				list ($this->m_nDelay) = array_values(unpack('v', substr($data, 2, 2)));
+				$this->m_nTrans = ord($data[4]);
+				break;
+
+			// Comment...
+			case 0xFE:
+				$this->m_lpComm = substr($data, 1, ord($data[0]));
+				break;
+
+			// Plain text...
+			case 0x01:
+				break;
+
+			// Application...
+			case 0xFF:
+				break;
 		}
 
 		// Skip default as defs may change.
@@ -521,25 +521,25 @@ 
 		{
 			switch ($i)
 			{
-			case 0:
-				$s = 8;
-				$y = 0;
-				break;
-
-			case 1:
-				$s = 8;
-				$y = 4;
-				break;
-
-			case 2:
-				$s = 4;
-				$y = 2;
-				break;
-
-			case 3:
-				$s = 2;
-				$y = 1;
-				break;
+				case 0:
+					$s = 8;
+					$y = 0;
+					break;
+
+				case 1:
+					$s = 8;
+					$y = 4;
+					break;
+
+				case 2:
+					$s = 4;
+					$y = 2;
+					break;
+
+				case 3:
+					$s = 2;
+					$y = 1;
+					break;
 			}
 
 			for (; $y < $this->m_gih->m_nHeight; $y += $s)

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/Class-SearchAPI.php

Doc Comments +2 added lines, -1 removed lines

@@ -56,6 +56,7 @@ 
 	 * @param array $wordsSearch Search words
 	 * @param array $wordsExclude Words to exclude
 	 * @param bool $isExcluded Whether the specfied word should be excluded
+	 * @return void
 	 */
 	public function prepareIndexes($word, array &$wordsSearch, array &$wordsExclude, $isExcluded);
 
@@ -130,7 +131,7 @@ 
 	 * @param array $excludedIndexWords Indexed words that should be excluded
 	 * @param array $participants
 	 * @param array $searchArray
-	 * @return mixed
+	 * @return integer
 	 */
 	public function searchQuery(array $query_params, array $searchWords, array $excludedIndexWords, array &$participants, array &$searchArray);
 }

Sources/Class-TOTP.php

Doc Comments +2 added lines, -2 removed lines

@@ -279,7 +279,7 @@ 
 	/**
 	 * Generate the timestamp for the calculation
 	 *
-	 * @return integer Timestamp
+	 * @return double Timestamp
 	 */
 	public function generateTimestamp()
 	{
@@ -290,7 +290,7 @@ 
 	 * Truncate the given hash down to just what we need
 	 *
 	 * @param string $hash Hash to truncate
-	 * @return string Truncated hash value
+	 * @return integer Truncated hash value
 	 */
 	public function truncateHash($hash)
 	{

Sources/DbPackages-mysql.php

Doc Comments +1 added lines, -1 removed lines

@@ -382,7 +382,7 @@
  * @param array $parameters Not used?
  * @param string $if_exists What to do if the index exists. If 'update', the definition will be updated.
  * @param string $error
- * @return boolean Whether or not the operation was successful
+ * @return false|null Whether or not the operation was successful
  */
 function smf_db_add_index($table_name, $index_info, $parameters = array(), $if_exists = 'update', $error = 'fatal')
 {

Sources/DbPackages-postgresql.php

Doc Comments +1 added lines, -1 removed lines

@@ -518,7 +518,7 @@
  * @param array $parameters Not used?
  * @param string $if_exists What to do if the index exists. If 'update', the definition will be updated.
  * @param string $error
- * @return boolean Whether or not the operation was successful
+ * @return false|null Whether or not the operation was successful
  */
 function smf_db_add_index($table_name, $index_info, $parameters = array(), $if_exists = 'update', $error = 'fatal')
 {