Yoshi2889 / SMF2.1

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

Sources/Drafts.php

Doc Comments +5 added lines, -5 removed lines

@@ -175,7 +175,7 @@ 
  *
  * @param string $post_errors A string of info about errors encountered trying to save this draft
  * @param array $recipientList An array of data about who this PM is being sent to
- * @return boolean false if you can't save the draft, true if we're doing this via XML more than 5 seconds after the last save, nothing otherwise
+ * @return boolean|null false if you can't save the draft, true if we're doing this via XML more than 5 seconds after the last save, nothing otherwise
  */
 function SavePMDraft(&$post_errors, $recipientList)
 {
@@ -392,7 +392,7 @@ 
  *
  * @param int $id_draft The ID of the draft to delete
  * @param boolean $check Whether or not to check that the draft belongs to the current user
- * @return boolean False if it couldn't be deleted (doesn't return anything otherwise)
+ * @return false|null False if it couldn't be deleted (doesn't return anything otherwise)
  */
 function DeleteDraft($id_draft, $check = true)
 {
@@ -426,7 +426,7 @@ 
  * @param int $member_id ID of the member to show drafts for
  * @param boolean|integer If $type is 1, this can be set to only load drafts for posts in the specific topic
  * @param int $draft_type The type of drafts to show - 0 for post drafts, 1 for PM drafts
- * @return boolean False if the drafts couldn't be loaded, nothing otherwise
+ * @return false|null False if the drafts couldn't be loaded, nothing otherwise
  */
 function ShowDrafts($member_id, $topic = false, $draft_type = 0)
 {
@@ -510,7 +510,7 @@ 
  * Allows for the deleting and loading/editing of drafts
  *
  * @param type $memID
- * @param type $draft_type
+ * @param integer $draft_type
  */
 function showProfileDrafts($memID, $draft_type = 0)
 {
@@ -663,7 +663,7 @@ 
  * Uses the showpmdraft template
  * Allows for the deleting and loading/editing of drafts
  *
- * @param type $memID
+ * @param integer $memID
  */
 function showPMDrafts($memID = -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/ManageBans.php

Doc Comments +2 added lines, -2 removed lines

@@ -925,7 +925,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)
@@ -1119,7 +1119,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)
 {

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
  */