albertlast / SMF2.1

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

Sources/tasks/EventNew-Notify.php

Doc Comments +1 added lines, -1 removed lines

@@ -21,7 +21,7 @@
 {
 	/**
      * This executes the task - loads up the information, puts the email in the queue and inserts alerts as needed.
-	 * @return bool Always returns true
+	 * @return boolean|null Always returns true
 	 */
 	public function execute()
  	{

Sources/Xml.php

Doc Comments +1 added lines, -1 removed lines

@@ -80,7 +80,7 @@
 /**
  * Handles retrieving previews of news items, newsletters, signatures and warnings.
  * Calls the appropriate function based on $_POST['item']
- * @return void|bool Returns false if $_POST['item'] isn't set or isn't valid
+ * @return false|null Returns false if $_POST['item'] isn't set or isn't valid
  */
 function RetrievePreview()
 {

SSI.php

Doc Comments +5 added lines, -5 removed lines

@@ -1717,7 +1717,7 @@ 
 /**
  * Show today's birthdays.
  * @param string $output_method The output method. If 'echo', displays a list of users, otherwise returns an array of info about them.
- * @return void|array Displays a list of users or returns an array of info about them depending on output_method.
+ * @return null|string Displays a list of users or returns an array of info about them depending on output_method.
  */
 function ssi_todaysBirthdays($output_method = 'echo')
 {
@@ -1746,7 +1746,7 @@ 
 /**
  * Shows today's holidays.
  * @param string $output_method The output method. If 'echo', displays a list of holidays, otherwise returns an array of info about them.
- * @return void|array Displays a list of holidays or returns an array of info about them depending on output_method
+ * @return null|string Displays a list of holidays or returns an array of info about them depending on output_method
  */
 function ssi_todaysHolidays($output_method = 'echo')
 {
@@ -1773,7 +1773,7 @@ 
 
 /**
  * @param string $output_method The output method. If 'echo', displays a list of events, otherwise returns an array of info about them.
- * @return void|array Displays a list of events or returns an array of info about them depending on output_method
+ * @return null|string Displays a list of events or returns an array of info about them depending on output_method
  */
 function ssi_todaysEvents($output_method = 'echo')
 {
@@ -1807,7 +1807,7 @@ 
 /**
  * Shows today's calendar items (events, birthdays and holidays)
  * @param string $output_method The output method. If 'echo', displays a list of calendar items, otherwise returns an array of info about them.
- * @return void|array Displays a list of calendar items or returns an array of info about them depending on output_method
+ * @return null|string Displays a list of calendar items or returns an array of info about them depending on output_method
  */
 function ssi_todaysCalendar($output_method = 'echo')
 {
@@ -2198,7 +2198,7 @@ 
  * @param int|string $id The ID or username of a user
  * @param string $password The password to check
  * @param bool $is_username If true, treats $id as a username rather than a user ID
- * @return bool Whether or not the password is correct.
+ * @return null|boolean Whether or not the password is correct.
  */
 function ssi_checkPassword($id = null, $password = null, $is_username = false)
 {

Themes/default/GenericControls.template.php

Doc Comments +1 added lines, -1 removed lines

@@ -227,7 +227,7 @@
  * @param int|string $verify_id The verification control ID
  * @param string $display_type What type to display. Can be 'single' to only show one verification option or 'all' to show all of them
  * @param bool $reset Whether to reset the internal tracking counter
- * @return bool False if there's nothing else to show, true if $display_type is 'single', nothing otherwise
+ * @return boolean|null False if there's nothing else to show, true if $display_type is 'single', nothing otherwise
  */
 function template_control_verification($verify_id, $display_type = 'all', $reset = false)
 {