From 10df61a89bb3d2c990bff2fd542fb075cb47d314 Mon Sep 17 00:00:00 2001 From: kaldari Date: Thu, 18 Jul 2013 19:06:48 -0700 Subject: [PATCH] More accurate function descriptions Change-Id: I633a7740996b8933778aa32036cb429026f75ebe --- includes/User.php | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/includes/User.php b/includes/User.php index 685bce741f..973e7cc88b 100644 --- a/includes/User.php +++ b/includes/User.php @@ -1828,8 +1828,14 @@ class User { } /** - * Return the revision and link for the oldest new talk page message for - * this user. + * Return the data needed to construct links for new talk page message + * alerts. If there are new messages, this will return an associative array + * with the following data: + * wiki: The database name of the wiki + * link: Root-relative link to the user's talk page + * rev: The last talk page revision that the user has seen or null. This + * is useful for building diff links. + * If there are no new messages, it returns an empty array. * @note This function was designed to accomodate multiple talk pages, but * currently only returns a single link and revision. * @return Array @@ -1853,8 +1859,9 @@ class User { } /** - * Get the revision ID for the oldest new talk page message for this user - * @return int|null Revision id or null if there are no new messages + * Get the revision ID for the last talk page revision viewed by the talk + * page owner. + * @return int|null Revision ID or null */ public function getNewMessageRevisionId() { $newMessageRevisionId = null; -- 2.20.1