Yoshi2889 / SMF2.1

other/install.php

Doc Comments +13 added lines

@@ -1732,6 +1732,9 @@ 
 		return true;
 	}
 
+	/**
+	 * @param integer $chmod
+	 */
 	function chmod($ftp_file, $chmod)
 	{
 		if (!is_resource($this->connection))
@@ -1748,6 +1751,9 @@ 
 		return true;
 	}
 
+	/**
+	 * @param string $ftp_file
+	 */
 	function unlink($ftp_file)
 	{
 		// We are actually connected, right?
@@ -1816,6 +1822,9 @@ 
 		return true;
 	}
 
+	/**
+	 * @param string $ftp_file
+	 */
 	function create_file($ftp_file)
 	{
 		// First, we have to be connected... very important.
@@ -1887,6 +1896,10 @@ 
 		return $data;
 	}
 
+	/**
+	 * @param string $file
+	 * @param false|string $listing
+	 */
 	function locate($file, $listing = null)
 	{
 		if ($listing === null)

other/upgrade.php

Doc Comments +31 added lines

@@ -205,6 +205,9 @@ 
 // MD5 Encryption.
 if (!function_exists('md5_hmac'))
 {
+	/**
+	 * @param string $key
+	 */
 	function md5_hmac($data, $key)
 	{
 		if (strlen($key) > 64)
@@ -293,6 +296,9 @@ 
 			return true;
 		}
 
+		/**
+		 * @param integer $chmod
+		 */
 		function chmod($ftp_file, $chmod)
 		{
 			if (!is_resource($this->connection))
@@ -309,6 +315,9 @@ 
 			return true;
 		}
 
+		/**
+		 * @param string $ftp_file
+		 */
 		function unlink($ftp_file)
 		{
 			// We are actually connected, right?
@@ -377,6 +386,9 @@ 
 			return true;
 		}
 
+		/**
+		 * @param string $ftp_file
+		 */
 		function create_file($ftp_file)
 		{
 			// First, we have to be connected... very important.
@@ -448,6 +460,10 @@ 
 			return $data;
 		}
 
+		/**
+		 * @param string $file
+		 * @param false|string $listing
+		 */
 		function locate($file, $listing = null)
 		{
 			if ($listing === null)
@@ -756,6 +772,9 @@ 
 }
 
 // Used to direct the user to another location.
+/**
+ * @param string $location
+ */
 function redirectLocation($location, $addForm = true)
 {
 	global $upgradeurl, $upcontext, $command_line;
@@ -2437,6 +2456,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;
@@ -2723,6 +2745,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;
@@ -3349,6 +3374,9 @@ 
 	$upcontext['current_step'] = 1;
 }
 
+/**
+ * @param string $message
+ */
 function print_error($message, $fatal = false)
 {
 	static $fp = null;
@@ -3362,6 +3390,9 @@ 
 		exit;
 }
 
+/**
+ * @param string $message
+ */
 function throw_error($message)
 {
 	global $upcontext;

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

Doc Comments +4 added lines, -1 removed lines

@@ -252,6 +252,9 @@ 
 	return $tree;
 }
 
+/**
+ * @param integer $count
+ */
 function mama_init_dir (&$tree, &$count)
 {
 	$directory = '';
@@ -448,7 +451,7 @@ 
  * Performs various checks on an uploaded file.
  * - Requires that $_SESSION['temp_attachments'][$attachID] be properly populated.
  *
- * @param $attachID
+ * @param string $attachID
  */
 function attachmentChecks($attachID)
 {

Sources/Class-CurlFetchWeb.php

Doc Comments +5 added lines, -4 removed lines

@@ -86,6 +86,7 @@ 
 	*
 	* @param type $url, the site we are going to fetch
 	* @param type $post_data, any post data as form name => value
+	* @param string $url
 	*/
 	public function get_url_data($url, $post_data = array())
 	{
@@ -109,7 +110,7 @@ 
 	*
 	* @param type $url, site to fetch
 	* @param type $redirect, flag to indicate if this was a redirect request or not
-	* @return boolean
+	* @return false|null
 	*/
 	private function curl_request($url, $redirect = false)
 	{
@@ -165,7 +166,7 @@ 
 	*
 	* @param type $last_url, where we went to
 	* @param type $new_url, where we were redirected to
-	* @return new url location
+	* @return string url location
 	*/
 	private function get_redirect_url($last_url = '', $new_url = '')
 	{
@@ -279,7 +280,7 @@ 
 	* Called to initiate a redirect from a 301, 302 or 307 header
 	*  - resets the cURL options for the loop, sets the referrer flag
 	*
-	* @param type $target_url
+	* @param string $target_url
 	* @param type $referer_url
 	*/
 	private function redirect($target_url, $referer_url)
@@ -296,7 +297,7 @@ 
 	*
 	* @param type $cr
 	* @param type $header
-	* @return type
+	* @return integer
 	*/
 	private function header_callback($cr, $header)
 	{

Sources/Class-Package.php

Doc Comments +17 added lines, -4 removed lines

@@ -241,7 +241,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)
@@ -470,7 +470,7 @@ 
 	/**
 	 * Get a specific element's xml. (privately used...)
 	 * @param $array
-	 * @param $indent
+	 * @param null|integer $indent
 	 */
 	protected function _xml($array, $indent)
 	{
@@ -543,7 +543,7 @@ 
 
 	/**
 	 * Parse out CDATA tags. (htmlspecialchars them...)
-	 * @param $data
+	 * @param string $data
 	 */
 	function _to_cdata($data)
 	{
@@ -579,7 +579,7 @@ 
 
 	/**
 	 * Turn the CDATAs back to normal text.
-	 * @param $data
+	 * @param string $data
 	 */
 	protected function _from_cdata($data)
 	{
@@ -765,6 +765,9 @@ 
 		return true;
 	}
 
+	/**
+	 * @param integer $chmod
+	 */
 	public function chmod($ftp_file, $chmod)
 	{
 		if (!is_resource($this->connection))
@@ -784,6 +787,9 @@ 
 		return true;
 	}
 
+	/**
+	 * @param string $ftp_file
+	 */
 	public function unlink($ftp_file)
 	{
 		// We are actually connected, right?
@@ -852,6 +858,9 @@ 
 		return true;
 	}
 
+	/**
+	 * @param string $ftp_file
+	 */
 	public function create_file($ftp_file)
 	{
 		// First, we have to be connected... very important.
@@ -923,6 +932,10 @@ 
 		return $data;
 	}
 
+	/**
+	 * @param string $file
+	 * @param false|string $listing
+	 */
 	public function locate($file, $listing = null)
 	{
 		if ($listing === null)

Sources/DbExtra-mysql.php

Doc Comments +1 added lines, -1 removed lines

@@ -170,7 +170,7 @@
 /**
  * This function optimizes a table.
  * @param string $table - the table to be optimized
- * @return how much it was gained
+ * @return integer much it was gained
  */
 function smf_db_optimize_table($table)
 {

Sources/DbExtra-postgresql.php

Doc Comments +1 added lines, -1 removed lines

@@ -83,7 +83,7 @@
 /**
  * This function optimizes a table.
  * @param string $table - the table to be optimized
- * @return how much it was gained
+ * @return integer much it was gained
  */
 function smf_db_optimize_table($table)
 {

Sources/DbExtra-sqlite.php

Doc Comments +1 added lines, -1 removed lines

@@ -131,7 +131,7 @@
 /**
  * This function optimizes a table.
  * @param string $table - the table to be optimized
- * @return how much it was gained
+ * @return integer much it was gained
  */
 function smf_db_optimize_table($table)
 {