albertlast / SMF2.1

Sources/Subs-Membergroups.php

Doc Comments +1 added lines

@@ -243,6 +243,7 @@
  * @param null|array The groups to remove the member(s) from. If null, the specified members are stripped from all their membergroups.
  * @param bool $permissionCheckDone Whether we've already checked permissions prior to calling this function
  * @param bool $ignoreProtected Whether to ignore protected groups
+ * @param integer $groups
  * @return bool Whether the operation was successful
  */
 function removeMembersFromGroups($members, $groups = null, $permissionCheckDone = false, $ignoreProtected = false)

Sources/Subs-Menu.php

Doc Comments +1 added lines, -1 removed lines

@@ -286,7 +286,7 @@
 /**
  * Delete a menu.
  * @param string $menu_id The ID of the menu to destroy or 'last' for the most recent one
- * @return bool|void False if the menu doesn't exist, nothing otherwise
+ * @return false|null False if the menu doesn't exist, nothing otherwise
  */
 function destroyMenu($menu_id = 'last')
 {

Sources/Subs-Package.php

Doc Comments +3 added lines, -3 removed lines

@@ -28,7 +28,7 @@ 
  * @param bool $single_file If true returns the contents of the file specified by destination if it exists
  * @param bool $overwrite Whether to overwrite existing files
  * @param null|array $files_to_extract Specific files to extract
- * @return array|false An array of information about extracted files or false on failure
+ * @return string An array of information about extracted files or false on failure
  */
 function read_tgz_file($gzfilename, $destination, $single_file = false, $overwrite = false, $files_to_extract = null)
 {
@@ -59,7 +59,7 @@ 
  * @param bool $single_file Whether to only extract a single file
  * @param bool $overwrite Whether to overwrite existing data
  * @param null|array $files_to_extract If set, only extracts the specified files
- * @return array|false An array of information about the extracted files or false on failure
+ * @return string An array of information about the extracted files or false on failure
  */
 function read_tgz_data($gzfilename, $destination, $single_file = false, $overwrite = false, $files_to_extract = null)
 {
@@ -3251,7 +3251,7 @@ 
 	 * http://www.php.net/crc32#79567
 	 *
 	 * @param string $number
-	 * @return string The crc32
+	 * @return integer The crc32
 	 */
 	function smf_crc32($number)
 	{

Sources/Subs-Post.php

Doc Comments +4 added lines, -4 removed lines

@@ -1445,7 +1445,7 @@ 
  * @param resource $socket Socket to send on
  * @param string $code The expected response code
  * @param string $response The response from the SMTP server
- * @return bool Whether it responded as such.
+ * @return string|boolean Whether it responded as such.
  */
 function server_parse($message, $socket, $code, &$response = null)
 {
@@ -2259,7 +2259,7 @@ 
  * @param array $msgs Array of message ids
  * @param bool $approve Whether to approve the posts (if false, posts are unapproved)
  * @param bool $notify Whether to notify users
- * @return bool Whether the operation was successful
+ * @return null|boolean Whether the operation was successful
  */
 function approvePosts($msgs, $approve = true, $notify = true)
 {
@@ -2512,7 +2512,7 @@ 
  *
  * @param array $topics Array of topic ids
  * @param bool $approve Whether to approve the topics. If false, unapproves them instead
- * @return bool Whether the operation was successful
+ * @return null|boolean Whether the operation was successful
  */
 function approveTopics($topics, $approve = true)
 {
@@ -2902,7 +2902,7 @@ 
  *
  * @param resource $dict An enchant or pspell dictionary resource set up by {@link spell_init()}
  * @param string $word A word to check the spelling of
- * @return bool Whether or not the specified word is spelled properly
+ * @return boolean|null Whether or not the specified word is spelled properly
  */
 function spell_check($dict, $word)
 {

Sources/Subs-ReportedContent.php

Doc Comments +4 added lines, -4 removed lines

@@ -566,7 +566,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)
 {
@@ -632,8 +632,8 @@ 
  * Saves the new information whenever a moderator comment is edited.
  *
  * @param int $comment_id The edited moderator comment ID.
- * @param array $data The new data to de inserted. Should be already properly sanitized.
- * @return bool  Boolean false if no data or no comment ID was provided.
+ * @param string $edited_comment
+ * @return false|null  Boolean false if no data or no comment ID was provided.
  */
 function editModComment($comment_id, $edited_comment)
 {
@@ -657,7 +657,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-Sound.php

Doc Comments +1 added lines, -1 removed lines

@@ -24,7 +24,7 @@
  * Used by VerificationCode() (Register.php).
  *
  * @param string $word
- * @return boolean false on failure
+ * @return null|false false on failure
  */
 
 function createWaveFile($word)

Sources/Subs-Themes.php

Doc Comments +1 added lines, -1 removed lines

@@ -425,7 +425,7 @@
  *
  * This is a recursive function, it will call itself if there are subdirs inside the main directory.
  * @param string $path The absolute path to the directory to be removed
- * @return bool true when success, false on error.
+ * @return false|null true when success, false on error.
  */
 function remove_dir($path)
 {

Sources/Subs.php

Doc Comments +3 added lines, -3 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)
@@ -5092,7 +5092,7 @@ 
 
 /**
  * @param string $ip_address An IP address in IPv4, IPv6 or decimal notation
- * @return binary The IP address in binary or false
+ * @return string The IP address in binary or false
  */
 function inet_ptod($ip_address)
 {
@@ -5490,7 +5490,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')
 {

Sources/Subscriptions-PayPal.php

Doc Comments +1 added lines, -1 removed lines

@@ -402,7 +402,7 @@
 	 * A private function to find out the subscription details.
 	 *
 	 * @access private
-	 * @return boolean|void False on failure, otherwise just sets $_POST['item_number']
+	 * @return false|null False on failure, otherwise just sets $_POST['item_number']
 	 */
 	private function _findSubscription()
 	{