From 2bb276f07d2f291413fd41e0c62872ef39caed6e Mon Sep 17 00:00:00 2001 From: Reedy Date: Thu, 27 Dec 2018 20:29:14 +0000 Subject: [PATCH] Improve documentation of wfDeprecated Change-Id: I20b7724f0cf2b0221ae27412844e4019ae451b61 --- includes/GlobalFunctions.php | 9 ++++----- includes/debug/MWDebug.php | 2 +- 2 files changed, 5 insertions(+), 6 deletions(-) diff --git a/includes/GlobalFunctions.php b/includes/GlobalFunctions.php index a5f4def18f..9f29114b7b 100644 --- a/includes/GlobalFunctions.php +++ b/includes/GlobalFunctions.php @@ -1063,15 +1063,14 @@ function wfLogDBError( $text, array $context = [] ) { /** * Throws a warning that $function is deprecated * - * @param string $function + * @param string $function Function that is deprecated. * @param string|bool $version Version of MediaWiki that the function * was deprecated in (Added in 1.19). - * @param string|bool $component Added in 1.19. + * @param string|bool $component Component to which the function belongs. + * If false, it is assumed the function is in MediaWiki core (Added in 1.19). * @param int $callerOffset How far up the call stack is the original * caller. 2 = function that called the function that called - * wfDeprecated (Added in 1.20) - * - * @return null + * wfDeprecated (Added in 1.20). */ function wfDeprecated( $function, $version = false, $component = false, $callerOffset = 2 ) { MWDebug::deprecated( $function, $version, $component, $callerOffset + 1 ); diff --git a/includes/debug/MWDebug.php b/includes/debug/MWDebug.php index ae7f948f29..e8778362ec 100644 --- a/includes/debug/MWDebug.php +++ b/includes/debug/MWDebug.php @@ -185,7 +185,7 @@ class MWDebug { * @param string $function Function that is deprecated. * @param string|bool $version Version in which the function was deprecated. * @param string|bool $component Component to which the function belongs. - * If false, it is assumbed the function is in MediaWiki core. + * If false, it is assumed the function is in MediaWiki core. * @param int $callerOffset How far up the callstack is the original * caller. 2 = function that called the function that called * MWDebug::deprecated() (Added in 1.20). -- 2.20.1