From 4b6b41a1e5cb3d4ba7c896dfa4d72082aa2f069e Mon Sep 17 00:00:00 2001
From: Joas Schilling <nickvergessen@gmx.de>
Date: Fri, 13 Apr 2012 16:26:41 +0200
Subject: [PATCH] [ticket/10605] Add parameter documentation to
 phpbb_delete_user_pms

PHPBB3-10605
---
 phpBB/includes/functions_privmsgs.php | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/phpBB/includes/functions_privmsgs.php b/phpBB/includes/functions_privmsgs.php
index 14a6d83b2a..00bec11569 100644
--- a/phpBB/includes/functions_privmsgs.php
+++ b/phpBB/includes/functions_privmsgs.php
@@ -1085,6 +1085,10 @@ function delete_pm($user_id, $msg_ids, $folder_id)
 
 /**
 * Delete all PM(s) for a given user and delete the ones without references
+*
+* @param	int		$user_id	ID of the user whose private messages we want to delete
+*
+* @return	boolean		False if there were no pms found, true otherwise.
 */
 function phpbb_delete_user_pms($user_id)
 {