albertlast / SMF2.1

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

Sources/Profile-Modify.php

Doc Comments +6 added lines, -6 removed lines

@@ -2183,7 +2183,7 @@ 
  * Deletes a single or a group of alerts by ID
  *
  * @param int|array The ID of a single alert to delete or an array containing the IDs of multiple alerts. The function will convert integers into an array for better handling.
- * @param bool|int $memID The user ID. Used to update the user unread alerts count.
+ * @param integer $memID The user ID. Used to update the user unread alerts count.
  * @return void|int If the $memID param is set, returns the new amount of unread alerts.
  */
 function alert_delete($toDelete, $memID = false)
@@ -2839,7 +2839,7 @@ 
 /**
  * Handles the "manage groups" section of the profile
  *
- * @return true Always returns true
+ * @return boolean Always returns true
  */
 function profileLoadGroups()
 {
@@ -2896,7 +2896,7 @@ 
 /**
  * Load key signature context data.
  *
- * @return true Always returns true
+ * @return boolean Always returns true
  */
 function profileLoadSignatureData()
 {
@@ -2960,7 +2960,7 @@ 
 /**
  * Load avatar context data.
  *
- * @return true Always returns true
+ * @return boolean Always returns true
  */
 function profileLoadAvatarData()
 {
@@ -3033,7 +3033,7 @@ 
  * Save a members group.
  *
  * @param int &$value The ID of the (new) primary group
- * @return true Always returns true
+ * @return boolean Always returns true
  */
 function profileSaveGroups(&$value)
 {
@@ -3138,7 +3138,7 @@ 
  * @todo argh, the avatar here. Take this out of here!
  *
  * @param string &$value What kind of avatar we're expecting. Can be 'none', 'server_stored', 'gravatar', 'external' or 'upload'
- * @return bool|string False if success (or if memID is empty and password authentication failed), otherwise a string indicating what error occurred
+ * @return false|string False if success (or if memID is empty and password authentication failed), otherwise a string indicating what error occurred
  */
 function profileSaveAvatarData(&$value)
 {

Sources/Subs.php

Doc Comments +2 added lines, -2 removed lines

@@ -676,7 +676,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)
@@ -5527,7 +5527,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')
 {

Indentation +1 added lines, -3 removed lines

@@ -5495,7 +5495,6 @@ 
 
 /**
  * Tries different modes to make file/dirs writable. Wrapper function for chmod()
-
  * @param string $file The file/dir full path.
  * @param int $value Not needed, added for legacy reasons.
  * @return boolean  true if the file/dir is already writable or the function was able to make it writable, false if the function couldn't make the file/dir writable.
@@ -5535,7 +5534,6 @@ 
 
 /**
  * Wrapper function for json_decode() with error handling.
-
  * @param string $json The string to decode.
  * @param bool $returnAsArray To return the decoded string as an array or an object, SMF only uses Arrays but to keep on compatibility with json_decode its set to false as default.
  * @param bool $logIt To specify if the error will be logged if theres any.
@@ -6028,7 +6026,7 @@ 
 		$cont = stream_context_get_params($read);
 		$result = isset($cont['options']['ssl']['peer_certificate']) ? true : false;
 	}
-    return $result;
+	return $result;
 }
 
 /**

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