aboutsummaryrefslogtreecommitdiffstats
path: root/phpBB
diff options
context:
space:
mode:
authorbrunoais <brunoaiss@gmail.com>2013-08-14 10:44:45 +0100
committerbrunoais <brunoaiss@gmail.com>2013-08-14 10:44:45 +0100
commit53888ec540a7f7b1aeabcb4ef2d1a6afce121c06 (patch)
treee17ca38c7bdc67de23bd34e41e97452534ade9d6 /phpBB
parentb6d6938b9fd99020dd4e5b92ef5fc8dc21a81a78 (diff)
downloadforums-53888ec540a7f7b1aeabcb4ef2d1a6afce121c06.tar
forums-53888ec540a7f7b1aeabcb4ef2d1a6afce121c06.tar.gz
forums-53888ec540a7f7b1aeabcb4ef2d1a6afce121c06.tar.bz2
forums-53888ec540a7f7b1aeabcb4ef2d1a6afce121c06.tar.xz
forums-53888ec540a7f7b1aeabcb4ef2d1a6afce121c06.zip
[ticket/11663] Add the doc block about the return value.
generate_text_for_storage does not return anything, all returned values are outputted using the parameters so this uses the returned value with the same idea as many C language functions where the returned value is if all went well or not and if it didn't what went wrong. PHPBB3-11663
Diffstat (limited to 'phpBB')
-rw-r--r--phpBB/includes/functions_content.php2
1 files changed, 2 insertions, 0 deletions
diff --git a/phpBB/includes/functions_content.php b/phpBB/includes/functions_content.php
index c2cfabe983..593d2eb045 100644
--- a/phpBB/includes/functions_content.php
+++ b/phpBB/includes/functions_content.php
@@ -481,6 +481,8 @@ function generate_text_for_display($text, $uid, $bitfield, $flags, $censor_text
* For parsing custom parsed text to be stored within the database.
* This function additionally returns the uid and bitfield that needs to be stored.
* Expects $text to be the value directly from request_var() and in it's non-parsed form
+*
+* @return array An array of string with the errors that occurred while parsing
*/
function generate_text_for_storage(&$text, &$uid, &$bitfield, &$flags, $allow_bbcode = false, $allow_urls = false, $allow_smilies = false)
{