From cd026245fe1c1b8e7f135dbdf5de3eef36ec907b Mon Sep 17 00:00:00 2001 From: Marc Alexander Date: Mon, 26 Dec 2022 13:55:36 +0100 Subject: [PATCH] [ticket/16955] Improve minor docblock quirks PHPBB3-16955 --- phpBB/includes/functions_content.php | 4 ++-- phpBB/includes/functions_display.php | 2 +- phpBB/phpbb/db/driver/driver_interface.php | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/phpBB/includes/functions_content.php b/phpBB/includes/functions_content.php index f95d092c5b..783fa67044 100644 --- a/phpBB/includes/functions_content.php +++ b/phpBB/includes/functions_content.php @@ -1527,8 +1527,8 @@ function truncate_string($string, $max_length = 60, $max_store_length = 255, $al * @param int $user_id The users id * @param string $username The users name * @param string $username_colour The users colour -* @param string $guest_username optional parameter to specify the guest username. It will be used in favor of the GUEST language variable then. -* @param string $custom_profile_url optional parameter to specify a profile url. The user id get appended to this url as &u={user_id} +* @param string|false $guest_username optional parameter to specify the guest username. It will be used in favor of the GUEST language variable then. +* @param string|false $custom_profile_url optional parameter to specify a profile url. The user id get appended to this url as &u={user_id} * * @return string A string consisting of what is wanted based on $mode. */ diff --git a/phpBB/includes/functions_display.php b/phpBB/includes/functions_display.php index 6b8f812afa..9a1f33db37 100644 --- a/phpBB/includes/functions_display.php +++ b/phpBB/includes/functions_display.php @@ -1490,7 +1490,7 @@ function watch_topic_forum($mode, &$s_watching, $user_id, $forum_id, $topic_id, * Get user rank title and image * * @param array $user_data the current stored users data -* @param int $user_posts the users number of posts +* @param int|false $user_posts the users number of posts or false if guest * * @return array An associative array containing the rank title (title), the rank image as full img tag (img) and the rank image source (img_src) * diff --git a/phpBB/phpbb/db/driver/driver_interface.php b/phpBB/phpbb/db/driver/driver_interface.php index e269fac585..6d95f61c16 100644 --- a/phpBB/phpbb/db/driver/driver_interface.php +++ b/phpBB/phpbb/db/driver/driver_interface.php @@ -291,7 +291,7 @@ interface driver_interface /** * Get last inserted id after insert statement * - * @return string Autoincrement value of the last inserted row + * @return int|false Autoincrement value of the last inserted row */ public function sql_nextid();