aboutsummaryrefslogtreecommitdiffstats
path: root/phpBB
diff options
context:
space:
mode:
authorbrunoais <brunoaiss@gmail.com>2013-08-17 20:06:43 +0100
committerbrunoais <brunoaiss@gmail.com>2013-08-17 20:11:26 +0100
commit7a02a8bcf20b79feb996c2508e647c21f3a0ac70 (patch)
tree741fd68343f17b68fb57716dbeea6dad5251b659 /phpBB
parent53888ec540a7f7b1aeabcb4ef2d1a6afce121c06 (diff)
downloadforums-7a02a8bcf20b79feb996c2508e647c21f3a0ac70.tar
forums-7a02a8bcf20b79feb996c2508e647c21f3a0ac70.tar.gz
forums-7a02a8bcf20b79feb996c2508e647c21f3a0ac70.tar.bz2
forums-7a02a8bcf20b79feb996c2508e647c21f3a0ac70.tar.xz
forums-7a02a8bcf20b79feb996c2508e647c21f3a0ac70.zip
[ticket/11663] Add the doc block about the parameters.
PHPBB3-11663
Diffstat (limited to 'phpBB')
-rw-r--r--phpBB/includes/functions_content.php8
1 files changed, 8 insertions, 0 deletions
diff --git a/phpBB/includes/functions_content.php b/phpBB/includes/functions_content.php
index 593d2eb045..7e501de9c8 100644
--- a/phpBB/includes/functions_content.php
+++ b/phpBB/includes/functions_content.php
@@ -481,6 +481,14 @@ 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
+*
+* @param string $text The text to be replaced with the parsed one
+* @param string $uid The BBCode uid for this parse
+* @param string $bitfield The BBCode bitfield for this parse
+* @param int $flags The allow_bbcode, allow_urls and allow_smilies compiled into a single integer.
+* @param bool $allow_bbcode If BBCode is allowed (i.e. if BBCode is parsed)
+* @param bool $allow_urls If urls is allowed
+* @param bool $allow_smilies If smilies are allowed
*
* @return array An array of string with the errors that occurred while parsing
*/