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

Sources/Class-SearchAPI.php

Doc Comments +2 added lines, -1 removed lines

@@ -56,6 +56,7 @@ 
 	 * @param array $wordsSearch Search words
 	 * @param array $wordsExclude Words to exclude
 	 * @param bool $isExcluded Whether the specfied word should be excluded
+	 * @return void
 	 */
 	public function prepareIndexes($word, array &$wordsSearch, array &$wordsExclude, $isExcluded);
 
@@ -130,7 +131,7 @@ 
 	 * @param array $excludedIndexWords Indexed words that should be excluded
 	 * @param array $participants
 	 * @param array $searchArray
-	 * @return mixed
+	 * @return integer
 	 */
 	public function searchQuery(array $query_params, array $searchWords, array $excludedIndexWords, array &$participants, array &$searchArray);
 }

Sources/DbPackages-postgresql.php

Doc Comments +1 added lines, -1 removed lines

@@ -382,7 +382,7 @@
  * @param array $parameters Not used?
  * @param string $if_exists What to do if the index exists. If 'update', the definition will be updated.
  * @param string $error
- * @return boolean Whether or not the operation was successful
+ * @return false|null Whether or not the operation was successful
  */
 function smf_db_add_index($table_name, $index_info, $parameters = array(), $if_exists = 'update', $error = 'fatal')
 {

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)
 {
@@ -3261,7 +3261,7 @@ 
 	 * https://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

@@ -1448,7 +1448,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)
 {
@@ -2261,7 +2261,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)
 {
@@ -2514,7 +2514,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)
 {
@@ -2904,7 +2904,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.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')
 {

Themes/default/Calendar.template.php

Doc Comments +3 added lines, -3 removed lines

@@ -68,7 +68,7 @@ 
  * Display a list of upcoming events, birthdays, and holidays.
  *
  * @param string $grid_name The grid name
- * @return void|bool Returns false if the grid doesn't exist.
+ * @return false|null Returns false if the grid doesn't exist.
  */
 function template_show_upcoming_list($grid_name)
 {
@@ -238,7 +238,7 @@ 
  *
  * @param string $grid_name The grid name
  * @param bool $is_mini Is this a mini grid?
- * @return void|bool Returns false if the grid doesn't exist.
+ * @return false|null Returns false if the grid doesn't exist.
  */
 function template_show_month_grid($grid_name, $is_mini = false)
 {
@@ -523,7 +523,7 @@ 
  * Shows a weekly grid
  *
  * @param string $grid_name The name of the grid
- * @return void|bool Returns false if the grid doesn't exist
+ * @return false|null Returns false if the grid doesn't exist
  */
 function template_show_week_grid($grid_name)
 {

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