From: Alexandre Emsenhuber <ialex.wiki@gmail.com>
Date: Sat, 22 Dec 2012 12:27:19 +0000 (+0100)
Subject: Documentation improvements in ChangesList.php
X-Git-Tag: 1.31.0-rc.0~21230
X-Git-Url: http://git.cyclocoop.org/%7B%24www_url%7Dadmin/compta/exercices/?a=commitdiff_plain;h=9a741ee4a097ef1c112d93786b0038f71e737247;p=lhc%2Fweb%2Fwiklou.git

Documentation improvements in ChangesList.php

Change-Id: I7e2a35d2f15ed72338779b39e7dd64f4ee5a3989
---

diff --git a/includes/ChangesList.php b/includes/ChangesList.php
index 0bd16f7dc0..1d2f362f5e 100644
--- a/includes/ChangesList.php
+++ b/includes/ChangesList.php
@@ -286,6 +286,10 @@ class ChangesList extends ContextSource {
 		}
 	}
 
+	/**
+	 * @param $s string HTML to update
+	 * @param $rc_timestamp mixed
+	 */
 	public function insertDateHeader( &$s, $rc_timestamp ) {
 		# Make date header if necessary
 		$date = $this->getLanguage()->userDate( $rc_timestamp, $this->getUser() );
@@ -299,6 +303,11 @@ class ChangesList extends ContextSource {
 		}
 	}
 
+	/**
+	 * @param $s string HTML to update
+	 * @param $title Title
+	 * @param $logtype string
+	 */
 	public function insertLog( &$s, $title, $logtype ) {
 		$page = new LogPage( $logtype );
 		$logname = $page->getName()->escaped();
@@ -306,7 +315,7 @@ class ChangesList extends ContextSource {
 	}
 
 	/**
-	 * @param $s
+	 * @param $s string HTML to update
 	 * @param $rc RecentChange
 	 * @param $unpatrolled
 	 */
@@ -349,7 +358,7 @@ class ChangesList extends ContextSource {
 	}
 
 	/**
-	 * @param $s
+	 * @param $s string HTML to update
 	 * @param $rc RecentChange
 	 * @param $unpatrolled
 	 * @param $watched
@@ -384,7 +393,11 @@ class ChangesList extends ContextSource {
 	}
 
 	/**
+	 * Get the timestamp from $rc formatted with current user's settings
+	 * and a separator
+	 *
 	 * @param $rc RecentChange
+	 * @return string HTML fragment
 	 */
 	public function getTimestamp( $rc ) {
 		return $this->message['semicolon-separator'] . '<span class="mw-changeslist-date">' .
@@ -392,7 +405,9 @@ class ChangesList extends ContextSource {
 	}
 
 	/**
-	 * @param $s
+	 * Insert time timestamp string from $rc into $s
+	 *
+	 * @param $s string HTML to update
 	 * @param $rc RecentChange
 	 */
 	public function insertTimestamp( &$s, $rc ) {