Improve deprecation comment for MW_DIFF_VERSION
authorKunal Mehta <legoktm@member.fsf.org>
Wed, 12 Oct 2016 05:36:22 +0000 (22:36 -0700)
committerTim Starling <tstarling@wikimedia.org>
Sat, 15 Oct 2016 05:57:36 +0000 (05:57 +0000)
IDEs will now recognize it as deprecated.

Change-Id: Iac96449fb204a1e4b1e707138b3f0b5697bdfab4

includes/diff/DifferenceEngine.php

index cd644cb..16e9a44 100644 (file)
@@ -21,7 +21,7 @@
  * @ingroup DifferenceEngine
  */
 
-// Deprecated, use class constant instead
+/** @deprecated use class constant instead */
 define( 'MW_DIFF_VERSION', '1.11a' );
 
 /**
@@ -176,7 +176,7 @@ class DifferenceEngine extends ContextSource {
         *
         * @param int $id Revision ID
         *
-        * @return mixed URL or false
+        * @return string|bool Link HTML or false
         */
        public function deletedLink( $id ) {
                if ( $this->getUser()->isAllowed( 'deletedhistory' ) ) {