SimpleMachines / SMF2.1

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 xmlArray[] 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)
 	{

other/upgrade-helper.php

Doc Comments +2 added lines, -2 removed lines

@@ -81,7 +81,7 @@ 
 /**
  * Make files writable. First try to use regular chmod, but if that fails, try to use FTP.
  *
- * @param $files
+ * @param string[] $files
  * @return bool
  */
 function makeFilesWritable(&$files)
@@ -322,7 +322,7 @@ 
 /**
  * Prints an error to stderr.
  *
- * @param $message
+ * @param string $message
  * @param bool $fatal
  */
 function print_error($message, $fatal = false)

Sources/Drafts.php

Doc Comments +3 added lines, -3 removed lines

@@ -173,7 +173,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)
 {
@@ -388,7 +388,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)
 {
@@ -422,7 +422,7 @@ 
  * @param int $member_id ID of the member to show drafts for
  * @param boolean|integer $topic 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)
 {

Sources/Load.php

Doc Comments +5 added lines, -5 removed lines

@@ -2259,9 +2259,9 @@ 
  *
  * @uses the template_include() function to include the file.
  * @param string $template_name The name of the template to load
- * @param array|string $style_sheets The name of a single stylesheet or an array of names of stylesheets to load
+ * @param string $style_sheets The name of a single stylesheet or an array of names of stylesheets to load
  * @param bool $fatal If true, dies with an error message if the template cannot be found
- * @return boolean Whether or not the template was loaded
+ * @return boolean|null Whether or not the template was loaded
  */
 function loadTemplate($template_name, $style_sheets = array(), $fatal = true)
 {
@@ -2444,7 +2444,7 @@ 
  * - all code added with this function is added to the same <style> tag so do make sure your css is valid!
  *
  * @param string $css Some css code
- * @return void|bool Adds the CSS to the $context['css_header'] array or returns if no CSS is specified
+ * @return false|null Adds the CSS to the $context['css_header'] array or returns if no CSS is specified
  */
 function addInlineCss($css)
 {
@@ -2558,7 +2558,7 @@ 
  *
  * @param string $javascript Some JS code
  * @param bool $defer Whether the script should load in <head> or before the closing <html> tag
- * @return void|bool Adds the code to one of the $context['javascript_inline'] arrays or returns if no JS was specified
+ * @return false|null Adds the code to one of the $context['javascript_inline'] arrays or returns if no JS was specified
  */
 function addInlineJavaScript($javascript, $defer = false)
 {
@@ -2791,7 +2791,7 @@ 
  * It will try to choose only utf8 or non-utf8 languages.
  *
  * @param bool $use_cache Whether or not to use the cache
- * @return array An array of information about available languages
+ * @return string An array of information about available languages
  */
 function getLanguages($use_cache = true)
 {

Sources/Subs-ReportedContent.php

Doc Comments +3 added lines, -3 removed lines

@@ -23,7 +23,7 @@ 
  * @param integer $value The new value to update.
  * @param integer|array $report_id The affected report(s).
  *
- * @return bool
+ * @return false|null
  */
 function updateReport($action, $value, $report_id)
 {
@@ -564,7 +564,7 @@ 
  *
  * @param int $report_id The report ID is used to fire a notification about the event.
  * @param array $data a formatted array of data to be inserted. Should be already properly sanitized.
- * @return bool  Boolean false if no data was provided.
+ * @return false|null  Boolean false if no data was provided.
  */
 function saveModComment($report_id, $data)
 {
@@ -656,7 +656,7 @@ 
  * Deletes a moderator comment from the DB.
  *
  * @param int $comment_id The moderator comment ID used to identify which report will be deleted.
- * @return bool  Boolean false if no data was provided.
+ * @return false|null  Boolean false if no data was provided.
  */
 function deleteModComment($comment_id)
 {

Sources/Subs-Db-postgresql.php

Doc Comments +2 added lines, -2 removed lines

@@ -500,7 +500,7 @@ 
 /**
  * Returns the amount of affected rows for a query.
  *
- * @param mixed $result
+ * @param resource|null $result
  *
  * @return int
  *
@@ -869,7 +869,7 @@ 
  *
  * @param string $db_name The database name
  * @param resource $db_connection The database connection
- * @return true Always returns true
+ * @return boolean Always returns true
  */
 function smf_db_select_db($db_name, $db_connection)
 {

Sources/Class-CurlFetchWeb.php

Doc Comments +3 added lines, -3 removed lines

@@ -115,8 +115,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())
 	{
@@ -140,7 +140,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/Subs.php

Doc Comments +3 added lines, -3 removed lines

@@ -693,7 +693,7 @@ 
  * - caches the formatting data from the setting for optimization.
  *
  * @param float $number A number
- * @param bool|int $override_decimal_count If set, will use the specified number of decimal places. Otherwise it's automatically determined
+ * @param integer $override_decimal_count If set, will use the specified number of decimal places. Otherwise it's automatically determined
  * @return string A formatted number
  */
 function comma_format($number, $override_decimal_count = false)
@@ -5869,7 +5869,7 @@ 
  * It assumes the data is already a string.
  * @param string $data The data to print
  * @param string $type The content type. Defaults to Json.
- * @return void
+ * @return false|null
  */
 function smf_serverResponse($data = '', $type = 'content-type: application/json')
 {
@@ -6351,7 +6351,7 @@ 
  *
  * @param string $iri The IRI to test.
  * @param int $flags Optional flags to pass to filter_var()
- * @return string|bool Either the original IRI, or false if the IRI was invalid.
+ * @return string|false Either the original IRI, or false if the IRI was invalid.
  */
 function validate_iri($iri, $flags = null)
 {

other/upgrade.php

Doc Comments +16 added lines, -5 removed lines

@@ -502,6 +502,9 @@ 
 }
 
 // Used to direct the user to another location.
+/**
+ * @param string $location
+ */
 function redirectLocation($location, $addForm = true)
 {
 	global $upgradeurl, $upcontext, $command_line;
@@ -1745,6 +1748,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;
@@ -1779,6 +1785,10 @@ 
 
 	// Our custom error handler - does nothing but does stop public errors from XML!
 	set_error_handler(
+
+		/**
+		 * @param string $errno
+		 */
 		function ($errno, $errstr, $errfile, $errline) use ($support_js)
 		{
 			if ($support_js)
@@ -1993,6 +2003,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;
@@ -4763,7 +4776,7 @@ 
  * @param int $setSize The amount of entries after which to update the database.
  *
  * newCol needs to be a varbinary(16) null able field
- * @return bool
+ * @return boolean|null
  */
 function MySQLConvertOldIp($targetTable, $oldCol, $newCol, $limit = 50000, $setSize = 100)
 {
@@ -4931,9 +4944,8 @@ 
  * settings file isn't using any advanced configuration setups in the Settings.php file.  A copy is made as Settings_org.php
  * to preserve all changes prior to migration.
  *
- * @param array $config_vars An array of one or more variables to update
  *
- * @return void We either succesfully update the Settings file, or throw a error here.
+ * @return boolean|null We either succesfully update the Settings file, or throw a error here.
  */
 function migrateSettingsFile($changes)
 {
@@ -5343,9 +5355,8 @@ 
  * Prior to checking these settings, we look for advanced setups such as integrations or if variables have been moved
  * to another file.  If these are detected, we abort.
  *
- * @param array $config_vars An array of one or more variables to update
  *
- * @return void We either succesfully update the Settings file, or throw a error here.
+ * @return boolean We either succesfully update the Settings file, or throw a error here.
  */
 
 function detectSettingsFileMigrationNeeded()