SimpleMachines /
SMF2.1
@@ -173,7 +173,7 @@ discard block |
||
| 173 | 173 | * |
| 174 | 174 | * @param string $post_errors A string of info about errors encountered trying to save this draft |
| 175 | 175 | * @param array $recipientList An array of data about who this PM is being sent to |
| 176 | - * @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 |
|
| 176 | + * @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 |
|
| 177 | 177 | */ |
| 178 | 178 | function SavePMDraft(&$post_errors, $recipientList) |
| 179 | 179 | { |
@@ -388,7 +388,7 @@ discard block |
||
| 388 | 388 | * |
| 389 | 389 | * @param int $id_draft The ID of the draft to delete |
| 390 | 390 | * @param boolean $check Whether or not to check that the draft belongs to the current user |
| 391 | - * @return boolean False if it couldn't be deleted (doesn't return anything otherwise) |
|
| 391 | + * @return false|null False if it couldn't be deleted (doesn't return anything otherwise) |
|
| 392 | 392 | */ |
| 393 | 393 | function DeleteDraft($id_draft, $check = true) |
| 394 | 394 | { |
@@ -422,7 +422,7 @@ discard block |
||
| 422 | 422 | * @param int $member_id ID of the member to show drafts for |
| 423 | 423 | * @param boolean|integer $topic If $type is 1, this can be set to only load drafts for posts in the specific topic |
| 424 | 424 | * @param int $draft_type The type of drafts to show - 0 for post drafts, 1 for PM drafts |
| 425 | - * @return boolean False if the drafts couldn't be loaded, nothing otherwise |
|
| 425 | + * @return false|null False if the drafts couldn't be loaded, nothing otherwise |
|
| 426 | 426 | */ |
| 427 | 427 | function ShowDrafts($member_id, $topic = false, $draft_type = 0) |
| 428 | 428 | { |
@@ -2259,9 +2259,9 @@ discard block |
||
| 2259 | 2259 | * |
| 2260 | 2260 | * @uses the template_include() function to include the file. |
| 2261 | 2261 | * @param string $template_name The name of the template to load |
| 2262 | - * @param array|string $style_sheets The name of a single stylesheet or an array of names of stylesheets to load |
|
| 2262 | + * @param string $style_sheets The name of a single stylesheet or an array of names of stylesheets to load |
|
| 2263 | 2263 | * @param bool $fatal If true, dies with an error message if the template cannot be found |
| 2264 | - * @return boolean Whether or not the template was loaded |
|
| 2264 | + * @return boolean|null Whether or not the template was loaded |
|
| 2265 | 2265 | */ |
| 2266 | 2266 | function loadTemplate($template_name, $style_sheets = array(), $fatal = true) |
| 2267 | 2267 | { |
@@ -2444,7 +2444,7 @@ discard block |
||
| 2444 | 2444 | * - all code added with this function is added to the same <style> tag so do make sure your css is valid! |
| 2445 | 2445 | * |
| 2446 | 2446 | * @param string $css Some css code |
| 2447 | - * @return void|bool Adds the CSS to the $context['css_header'] array or returns if no CSS is specified |
|
| 2447 | + * @return false|null Adds the CSS to the $context['css_header'] array or returns if no CSS is specified |
|
| 2448 | 2448 | */ |
| 2449 | 2449 | function addInlineCss($css) |
| 2450 | 2450 | { |
@@ -2558,7 +2558,7 @@ discard block |
||
| 2558 | 2558 | * |
| 2559 | 2559 | * @param string $javascript Some JS code |
| 2560 | 2560 | * @param bool $defer Whether the script should load in <head> or before the closing <html> tag |
| 2561 | - * @return void|bool Adds the code to one of the $context['javascript_inline'] arrays or returns if no JS was specified |
|
| 2561 | + * @return false|null Adds the code to one of the $context['javascript_inline'] arrays or returns if no JS was specified |
|
| 2562 | 2562 | */ |
| 2563 | 2563 | function addInlineJavaScript($javascript, $defer = false) |
| 2564 | 2564 | { |
@@ -2791,7 +2791,7 @@ discard block |
||
| 2791 | 2791 | * It will try to choose only utf8 or non-utf8 languages. |
| 2792 | 2792 | * |
| 2793 | 2793 | * @param bool $use_cache Whether or not to use the cache |
| 2794 | - * @return array An array of information about available languages |
|
| 2794 | + * @return string An array of information about available languages |
|
| 2795 | 2795 | */ |
| 2796 | 2796 | function getLanguages($use_cache = true) |
| 2797 | 2797 | { |
@@ -501,7 +501,7 @@ discard block |
||
| 501 | 501 | * affected_rows |
| 502 | 502 | * |
| 503 | 503 | * !!! Not sure what this is supposed to do. |
| 504 | - * @param mixed $result |
|
| 504 | + * @param resource|null $result |
|
| 505 | 505 | * |
| 506 | 506 | * @return int |
| 507 | 507 | * |
@@ -870,7 +870,7 @@ discard block |
||
| 870 | 870 | * |
| 871 | 871 | * @param string $db_name The database name |
| 872 | 872 | * @param resource $db_connection The database connection |
| 873 | - * @return true Always returns true |
|
| 873 | + * @return boolean Always returns true |
|
| 874 | 874 | */ |
| 875 | 875 | function smf_db_select_db($db_name, $db_connection) |
| 876 | 876 | { |
@@ -23,7 +23,7 @@ discard block |
||
| 23 | 23 | * @param integer $value The new value to update. |
| 24 | 24 | * @param integer|array $report_id The affected report(s). |
| 25 | 25 | * |
| 26 | - * @return bool |
|
| 26 | + * @return false|null |
|
| 27 | 27 | */ |
| 28 | 28 | function updateReport($action, $value, $report_id) |
| 29 | 29 | { |
@@ -564,7 +564,7 @@ discard block |
||
| 564 | 564 | * |
| 565 | 565 | * @param int $report_id The report ID is used to fire a notification about the event. |
| 566 | 566 | * @param array $data a formatted array of data to be inserted. Should be already properly sanitized. |
| 567 | - * @return bool Boolean false if no data was provided. |
|
| 567 | + * @return false|null Boolean false if no data was provided. |
|
| 568 | 568 | */ |
| 569 | 569 | function saveModComment($report_id, $data) |
| 570 | 570 | { |
@@ -656,7 +656,7 @@ discard block |
||
| 656 | 656 | * Deletes a moderator comment from the DB. |
| 657 | 657 | * |
| 658 | 658 | * @param int $comment_id The moderator comment ID used to identify which report will be deleted. |
| 659 | - * @return bool Boolean false if no data was provided. |
|
| 659 | + * @return false|null Boolean false if no data was provided. |
|
| 660 | 660 | */ |
| 661 | 661 | function deleteModComment($comment_id) |
| 662 | 662 | { |
