Update docs for DifferenceEngine::getDiff()
authorSiebrand Mazeland <s.mazeland@xs4all.nl>
Wed, 5 Dec 2012 14:21:58 +0000 (15:21 +0100)
committerSiebrand Mazeland <s.mazeland@xs4all.nl>
Wed, 5 Dec 2012 14:21:58 +0000 (15:21 +0100)
Previous docs were incorrect and misleading.

Change-Id: I6403c7c7c3b9803cc7e10cc45999244ff78dc14d

includes/diff/DifferenceEngine.php

index 384b4f6..6fcf0e8 100644 (file)
@@ -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
         */