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;

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/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())
 {

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

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/PersonalMessage.php

Doc Comments +1 added lines, -1 removed lines

@@ -4070,7 +4070,7 @@
  *
  * @param int $pmID The ID of the PM
  * @param string $validFor Which folders this is valud for - can be 'inbox', 'outbox' or 'in_or_outbox'
- * @return boolean Whether the PM is accessible in that folder for the current user
+ * @return boolean|null Whether the PM is accessible in that folder for the current user
  */
 function isAccessiblePM($pmID, $validFor = 'in_or_outbox')
 {