From: Siebrand Mazeland <s.mazeland@xs4all.nl>
Date: Wed, 5 Dec 2012 14:21:58 +0000 (+0100)
Subject: Update docs for DifferenceEngine::getDiff()
X-Git-Tag: 1.31.0-rc.0~21418^2
X-Git-Url: http://git.cyclocoop.org/%7B%24www_url%7Dadmin/password.php?a=commitdiff_plain;h=c4e761089cc7b7fefd3839770bc1e9b32e453bad;p=lhc%2Fweb%2Fwiklou.git

Update docs for DifferenceEngine::getDiff()

Previous docs were incorrect and misleading.

Change-Id: I6403c7c7c3b9803cc7e10cc45999244ff78dc14d
---

diff --git a/includes/diff/DifferenceEngine.php b/includes/diff/DifferenceEngine.php
index 384b4f672d..6fcf0e8eac 100644
--- a/includes/diff/DifferenceEngine.php
+++ b/includes/diff/DifferenceEngine.php
@@ -613,8 +613,8 @@ class DifferenceEngine extends ContextSource {
 	/**
 	 * Get complete diff table, including header
 	 *
-	 * @param $otitle Title: old title
-	 * @param $ntitle Title: new title
+	 * @param string|bool $otitle Header for old text or false
+	 * @param string|bool $ntitle Header for new text or false
 	 * @param $notice String: HTML between diff header and body
 	 * @return mixed
 	 */