SimpleMachines / SMF2.1

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-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;

Spacing +7 added lines, -7 removed lines

@@ -38,8 +38,8 @@ 
 		$this->MAX_LZW_BITS = 12;
 		unset($this->Next, $this->Vals, $this->Stack, $this->Buf);
 
-		$this->Next  = range(0, (1 << $this->MAX_LZW_BITS)       - 1);
-		$this->Vals  = range(0, (1 << $this->MAX_LZW_BITS)       - 1);
+		$this->Next  = range(0, (1 << $this->MAX_LZW_BITS) - 1);
+		$this->Vals  = range(0, (1 << $this->MAX_LZW_BITS) - 1);
 		$this->Stack = range(0, (1 << ($this->MAX_LZW_BITS + 1)) - 1);
 		$this->Buf   = range(0, 279);
 	}
@@ -278,9 +278,9 @@ 
 		for ($i = 0; $i < $this->m_nColors; $i++)
 		{
 			$ret .=
-				chr(($this->m_arColors[$i] & 0x000000FF))       . // R
-				chr(($this->m_arColors[$i] & 0x0000FF00) >>  8) . // G
-				chr(($this->m_arColors[$i] & 0x00FF0000) >> 16);  // B
+				chr(($this->m_arColors[$i] & 0x000000FF)) . // R
+				chr(($this->m_arColors[$i] & 0x0000FF00) >> 8) . // G
+				chr(($this->m_arColors[$i] & 0x00FF0000) >> 16); // B
 		}
 
 		return $ret;
@@ -290,14 +290,14 @@ 
 	{
 		$rgb  = intval($rgb) & 0xFFFFFF;
 		$r1   = ($rgb & 0x0000FF);
-		$g1   = ($rgb & 0x00FF00) >>  8;
+		$g1   = ($rgb & 0x00FF00) >> 8;
 		$b1   = ($rgb & 0xFF0000) >> 16;
 		$idx  = -1;
 
 		for ($i = 0; $i < $this->m_nColors; $i++)
 		{
 			$r2 = ($this->m_arColors[$i] & 0x000000FF);
-			$g2 = ($this->m_arColors[$i] & 0x0000FF00) >>  8;
+			$g2 = ($this->m_arColors[$i] & 0x0000FF00) >> 8;
 			$b2 = ($this->m_arColors[$i] & 0x00FF0000) >> 16;
 			$d  = abs($r2 - $r1) + abs($g2 - $g1) + abs($b2 - $b1);
 

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);
 }

Spacing +4 added lines, -4 removed lines

@@ -223,7 +223,7 @@ 
 
 		global $smcFunc;
 
-		$result = $smcFunc['db_query']('','
+		$result = $smcFunc['db_query']('', '
 			SELECT DISTINCT id_search
 			FROM {db_prefix}log_search_results
 			WHERE id_msg = {int:id_msg}',
@@ -239,7 +239,7 @@ 
 		if (count($id_searchs) < 1)
 			return;
 
-		$smcFunc['db_query']('','
+		$smcFunc['db_query']('', '
 			DELETE FROM {db_prefix}log_search_results
 			WHERE id_search in ({array_int:id_searchs})',
 			array(
@@ -247,7 +247,7 @@ 
 			)
 		);
 
-		$smcFunc['db_query']('','
+		$smcFunc['db_query']('', '
 			DELETE FROM {db_prefix}log_search_topics
 			WHERE id_search in ({array_int:id_searchs})',
 			array(
@@ -255,7 +255,7 @@ 
 			)
 		);
 
-		$smcFunc['db_query']('','
+		$smcFunc['db_query']('', '
 			DELETE FROM {db_prefix}log_search_messages
 			WHERE id_search in ({array_int:id_searchs})',
 			array(

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')
 {

Spacing +8 added lines, -8 removed lines

@@ -126,9 +126,9 @@ 
 		{
 			$smcFunc['db_transaction']('begin');
 			$db_trans = true;
-			$smcFunc['db_drop_table']($table_name.'_old');
-			$smcFunc['db_query']('','
-				RENAME TABLE '. $table_name .' TO ' . $table_name . '_old',
+			$smcFunc['db_drop_table']($table_name . '_old');
+			$smcFunc['db_query']('', '
+				RENAME TABLE '. $table_name . ' TO ' . $table_name . '_old',
 				array(
 					'security_override' => true,
 				)
@@ -202,15 +202,15 @@ 
 	{
 		$same_col = array();
 
-		$request = $smcFunc['db_query']('','
+		$request = $smcFunc['db_query']('', '
 			SELECT count(*), column_name
 			FROM information_schema.columns
 			WHERE table_name in ({string:table1},{string:table2}) AND table_schema = {string:schema}
 			GROUP BY column_name
 			HAVING count(*) > 1',
-			array (
+			array(
 				'table1' => $table_name,
-				'table2' => $table_name.'_old',
+				'table2' => $table_name . '_old',
 				'schema' => $db_name,
 			)
 		);
@@ -220,8 +220,8 @@ 
 			$same_col[] = $row['column_name'];
 		}
 
-		$smcFunc['db_query']('','
-			INSERT INTO ' . $table_name .'('
+		$smcFunc['db_query']('', '
+			INSERT INTO ' . $table_name . '('
 			. implode($same_col, ',') .
 			')
 			SELECT '. implode($same_col, ',') . '

Sources/Errors.php

Doc Comments +1 added lines, -1 removed lines

@@ -475,7 +475,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())
 {

Spacing +2 added lines, -2 removed lines

@@ -45,7 +45,7 @@ 
 		$backtrace = debug_backtrace();
 
 	// are we in a loop?
-	if($error_call > 2)
+	if ($error_call > 2)
 	{
 		var_dump($backtrace);
 		die('Error loop.');
@@ -549,7 +549,7 @@ 
 		$url['error'] = $error;
 		// Url field got a max length of 1024 in db
 		if (strlen($url['error']) > 500)
-			$url['error'] = substr($url['error'],0,500);
+			$url['error'] = substr($url['error'], 0, 500);
 
 		if (!empty($sprintf))
 			$url['error_params'] = $sprintf;

Sources/ManageBans.php

Doc Comments +2 added lines, -2 removed lines

@@ -929,7 +929,7 @@ 
  * Doesn't clean the inputs
  *
  * @param array $items_ids The items to remove
- * @param bool|int $group_id The ID of the group these triggers are associated with or false if deleting them from all groups
+ * @param integer $group_id The ID of the group these triggers are associated with or false if deleting them from all groups
  * @return bool Always returns true
  */
 function removeBanTriggers($items_ids = array(), $group_id = false)
@@ -1123,7 +1123,7 @@ 
  * Errors in $context['ban_errors']
  *
  * @param array $triggers The triggers to validate
- * @return array An array of riggers and log info ready to be used
+ * @return integer An array of riggers and log info ready to be used
  */
 function validateTriggers(&$triggers)
 {

Spacing +5 added lines, -5 removed lines

@@ -283,11 +283,11 @@ 
 			if (removeItems == 0)
 			{
 				e.preventDefault();
-				return alert("'. $txt['select_item_check'] .'");
+				return alert("'. $txt['select_item_check'] . '");
 			}
 
 
-			return confirm("'. $txt['ban_remove_selected_confirm'] .'");
+			return confirm("'. $txt['ban_remove_selected_confirm'] . '");
 		});',
 	);
 
@@ -486,7 +486,7 @@ 
 					array(
 						'position' => 'below_table_data',
 						'value' => '
-						<input type="submit" name="remove_selection" value="' . $txt['ban_remove_selected_triggers'] . '" class="button"> <a class="button" href="' . $scripturl	. '?action=admin;area=ban;sa=edittrigger;bg=' . $ban_group_id . '">' . $txt['ban_add_trigger'] . '</a>',
+						<input type="submit" name="remove_selection" value="' . $txt['ban_remove_selected_triggers'] . '" class="button"> <a class="button" href="' . $scripturl . '?action=admin;area=ban;sa=edittrigger;bg=' . $ban_group_id . '">' . $txt['ban_add_trigger'] . '</a>',
 						'style' => 'text-align: right;',
 					),
 					array(
@@ -506,11 +506,11 @@ 
 			if (removeItems == 0)
 			{
 				e.preventDefault();
-				return alert("'. $txt['select_item_check'] .'");
+				return alert("'. $txt['select_item_check'] . '");
 			}
 
 
-			return confirm("'. $txt['ban_remove_selected_confirm'] .'");
+			return confirm("'. $txt['ban_remove_selected_confirm'] . '");
 		});',
 			);
 			createList($listOptions);

Sources/ManagePaid.php

Doc Comments +1 added lines, -1 removed lines

@@ -1452,7 +1452,7 @@
  *
  * @param int $id_subscribe The subscription ID
  * @param int $id_member The ID of the member
- * @param int|string $renewal 0 if we're forcing start/end time, otherwise a string indicating how long to renew the subscription for ('D', 'W', 'M' or 'Y')
+ * @param integer $renewal 0 if we're forcing start/end time, otherwise a string indicating how long to renew the subscription for ('D', 'W', 'M' or 'Y')
  * @param int $forceStartTime If set, forces the subscription to start at the specified time
  * @param int $forceEndTime If set, forces the subscription to end at the specified time
  */

Sources/Profile-Modify.php

Doc Comments +6 added lines, -6 removed lines

@@ -2183,7 +2183,7 @@ 
  * Deletes a single or a group of alerts by ID
  *
  * @param int|array The ID of a single alert to delete or an array containing the IDs of multiple alerts. The function will convert integers into an array for better handling.
- * @param bool|int $memID The user ID. Used to update the user unread alerts count.
+ * @param integer $memID The user ID. Used to update the user unread alerts count.
  * @return void|int If the $memID param is set, returns the new amount of unread alerts.
  */
 function alert_delete($toDelete, $memID = false)
@@ -2839,7 +2839,7 @@ 
 /**
  * Handles the "manage groups" section of the profile
  *
- * @return true Always returns true
+ * @return boolean Always returns true
  */
 function profileLoadGroups()
 {
@@ -2896,7 +2896,7 @@ 
 /**
  * Load key signature context data.
  *
- * @return true Always returns true
+ * @return boolean Always returns true
  */
 function profileLoadSignatureData()
 {
@@ -2960,7 +2960,7 @@ 
 /**
  * Load avatar context data.
  *
- * @return true Always returns true
+ * @return boolean Always returns true
  */
 function profileLoadAvatarData()
 {
@@ -3033,7 +3033,7 @@ 
  * Save a members group.
  *
  * @param int &$value The ID of the (new) primary group
- * @return true Always returns true
+ * @return boolean Always returns true
  */
 function profileSaveGroups(&$value)
 {
@@ -3138,7 +3138,7 @@ 
  * @todo argh, the avatar here. Take this out of here!
  *
  * @param string &$value What kind of avatar we're expecting. Can be 'none', 'server_stored', 'gravatar', 'external' or 'upload'
- * @return bool|string False if success (or if memID is empty and password authentication failed), otherwise a string indicating what error occurred
+ * @return false|string False if success (or if memID is empty and password authentication failed), otherwise a string indicating what error occurred
  */
 function profileSaveAvatarData(&$value)
 {

Spacing +2 added lines, -2 removed lines

@@ -1256,7 +1256,7 @@ 
 			);
 			if (empty($value))
 			{
-				$deletes = array('id_theme' => 1 , 'variable' => $row['col_name'], 'id_member' => $memID);
+				$deletes = array('id_theme' => 1, 'variable' => $row['col_name'], 'id_member' => $memID);
 				unset($user_profile[$memID]['options'][$row['col_name']]);
 			}
 			else
@@ -1284,7 +1284,7 @@ 
 				array('id_theme', 'variable', 'id_member')
 			);
 		if (!empty($deletes))
-			$smcFunc['db_query']('','
+			$smcFunc['db_query']('', '
 				DELETE FROM {db_prefix}themes
 				WHERE id_theme = {int:id_theme} AND
 						variable = {string:variable} AND