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

Indentation +69 added lines, -69 removed lines

@@ -94,12 +94,12 @@ 
 	public $headers;
 
 	/**
-	* Start the curl object
-	* - allow for user override values
-	*
-	* @param array $options An array of cURL options
-	* @param int $max_redirect Maximum number of redirects
-	*/
+	 * Start the curl object
+	 * - allow for user override values
+	 *
+	 * @param array $options An array of cURL options
+	 * @param int $max_redirect Maximum number of redirects
+	 */
 	public function __construct($options = array(), $max_redirect = 3)
 	{
 		// Initialize class variables
@@ -108,16 +108,16 @@ 
 	}
 
 	/**
-	* Main calling function,
-	*  - will request the page data from a given $url
-	*  - optionally will post data to the page form if post data is supplied
-	*  - passed arrays will be converted to a post string joined with &'s
-	*  - 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
-	*/
+	 * Main calling function,
+	 *  - will request the page data from a given $url
+	 *  - optionally will post data to the page form if post data is supplied
+	 *  - passed arrays will be converted to a post string joined with &'s
+	 *  - 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
+	 */
 	public function get_url_data($url, $post_data = array())
 	{
 		// POSTing some data perhaps?
@@ -134,14 +134,14 @@ 
 	}
 
 	/**
-	* Makes the actual cURL call
-	*  - stores responses (url, code, error, headers, body) in the response array
-	*  - detects 301, 302, 307 codes and will redirect to the given response header location
-	*
-	* @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
-	*/
+	 * Makes the actual cURL call
+	 *  - stores responses (url, code, error, headers, body) in the response array
+	 *  - detects 301, 302, 307 codes and will redirect to the given response header location
+	 *
+	 * @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
+	 */
 	private function curl_request($url, $redirect = false)
 	{
 		// we do have a url I hope
@@ -193,12 +193,12 @@ 
 	}
 
 	/**
-	* Used if being redirected to ensure we have a fully qualified address
-	*
-	* @param string $last_url The URL we went to
-	* @param string $new_url The URL we were redirected to
-	* @return string The new URL that was in the HTTP header
-	*/
+	 * Used if being redirected to ensure we have a fully qualified address
+	 *
+	 * @param string $last_url The URL we went to
+	 * @param string $new_url The URL we were redirected to
+	 * @return string The new URL that was in the HTTP header
+	 */
 	private function get_redirect_url($last_url = '', $new_url = '')
 	{
 		// Get the elements for these urls
@@ -216,13 +216,13 @@ 
 	}
 
 	/**
-	* Used to return the results to the calling program
-	*  - called as ->result() will return the full final array
-	*  - called as ->result('body') to just return the page source of the result
-	*
-	* @param string $area Used to return an area such as body, header, error
-	* @return string The response
-	*/
+	 * Used to return the results to the calling program
+	 *  - called as ->result() will return the full final array
+	 *  - called as ->result('body') to just return the page source of the result
+	 *
+	 * @param string $area Used to return an area such as body, header, error
+	 * @return string The response
+	 */
 	public function result($area = '')
 	{
 		$max_result = count($this->response) - 1;
@@ -235,13 +235,13 @@ 
 	}
 
 	/**
-	* Will return all results from all loops (redirects)
-	*  - Can be called as ->result_raw(x) where x is a specific loop results.
-	*  - Call as ->result_raw() for everything.
-	*
-	* @param string $response_number Which response we want to get
-	* @return array|string The entire response array or just the specified response
-	*/
+	 * Will return all results from all loops (redirects)
+	 *  - Can be called as ->result_raw(x) where x is a specific loop results.
+	 *  - Call as ->result_raw() for everything.
+	 *
+	 * @param string $response_number Which response we want to get
+	 * @return array|string The entire response array or just the specified response
+	 */
 	public function result_raw($response_number = '')
 	{
 		if (!is_numeric($response_number))
@@ -254,13 +254,13 @@ 
 	}
 
 	/**
-	* Takes supplied POST data and url encodes it
-	*  - forms the date (for post) in to a string var=xyz&var2=abc&var3=123
-	*  - drops vars with @ since we don't support sending files (uploading)
-	*
-	* @param array|string $post_data The raw POST data
-	* @return string A string of post data
-	*/
+	 * Takes supplied POST data and url encodes it
+	 *  - forms the date (for post) in to a string var=xyz&var2=abc&var3=123
+	 *  - drops vars with @ since we don't support sending files (uploading)
+	 *
+	 * @param array|string $post_data The raw POST data
+	 * @return string A string of post data
+	 */
 	private function build_post_data($post_data)
 	{
 		if (is_array($post_data))
@@ -279,11 +279,11 @@ 
 	}
 
 	/**
-	* Sets the final cURL options for the current call
-	*  - overwrites our default values with user supplied ones or appends new user ones to what we have
-	*  - sets the callback function now that $this is existing
-	* @return void
-	*/
+	 * Sets the final cURL options for the current call
+	 *  - overwrites our default values with user supplied ones or appends new user ones to what we have
+	 *  - sets the callback function now that $this is existing
+	 * @return void
+	 */
 	private function set_options()
 	{
 		// Callback to parse the returned headers, if any
@@ -308,12 +308,12 @@ 
 	}
 
 	/**
-	* Called to initiate a redirect from a 301, 302 or 307 header
-	*  - resets the cURL options for the loop, sets the referrer flag
-	*
-	* @param string $target_url The URL we want to redirect to
-	* @param string $referer_url The URL that we're redirecting from
-	*/
+	 * Called to initiate a redirect from a 301, 302 or 307 header
+	 *  - resets the cURL options for the loop, sets the referrer flag
+	 *
+	 * @param string $target_url The URL we want to redirect to
+	 * @param string $referer_url The URL that we're redirecting from
+	 */
 	private function redirect($target_url, $referer_url)
 	{
 		// no no I last saw that over there ... really, 301, 302, 307
@@ -323,13 +323,13 @@ 
 	}
 
 	/**
-	* Callback function to parse returned headers
-	*  - lowercases everything to make it consistent
-	*
-	* @param type $cr Not sure what this is used for?
-	* @param string $header The header
-	* @return int The length of the header
-	*/
+	 * Callback function to parse returned headers
+	 *  - lowercases everything to make it consistent
+	 *
+	 * @param type $cr Not sure what this is used for?
+	 * @param string $header The header
+	 * @return int The length of the header
+	 */
 	private function header_callback($cr, $header)
 	{
 		$_header = trim($header);

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

Indentation +2 added lines, -2 removed lines

@@ -793,7 +793,7 @@ 
 		if (!$this->connection)
 		{
 			$this->error = 'bad_server';
-            		$this->last_message = 'Invalid Server';
+					$this->last_message = 'Invalid Server';
 			return;
 		}
 
@@ -801,7 +801,7 @@ 
 		if (!$this->check_response(220))
 		{
 			$this->error = 'bad_response';
-		        $this->last_message = 'Bad Response';
+				$this->last_message = 'Bad Response';
 			return;
 		}
 

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)
 {
@@ -393,7 +393,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)
 {
@@ -427,7 +427,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)
 {
@@ -511,7 +511,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)
 {
@@ -664,7 +664,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

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