From c0183cabd09994839170238fd5e2a87f1b48880b Mon Sep 17 00:00:00 2001
From: Andreas Fischer <bantu@phpbb.com>
Date: Sun, 27 Jun 2010 21:25:43 +0200
Subject: [PATCH] [ticket/9534] Update function documentation for
 user_ipwhois().

PHPBB3-9534
---
 phpBB/includes/functions_user.php | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)

diff --git a/phpBB/includes/functions_user.php b/phpBB/includes/functions_user.php
index c2ea8445d1..467668d3ee 100644
--- a/phpBB/includes/functions_user.php
+++ b/phpBB/includes/functions_user.php
@@ -1229,9 +1229,13 @@ function user_unban($mode, $ban)
 }
 
 /**
-* Whois facility
+* Internet Protocol Address Whois
+* RFC3912: WHOIS Protocol Specification
 *
-* @link http://tools.ietf.org/html/rfc3912 RFC3912: WHOIS Protocol Specification
+* @param string $ip		Ip address, either IPv4 or IPv6.
+*
+* @return string		Empty string if not a valid ip address.
+*						Otherwise make_clickable()'ed whois result.
 */
 function user_ipwhois($ip)
 {