From: Alexandre Emsenhuber <ialex@users.mediawiki.org>
Date: Thu, 20 Aug 2009 21:35:22 +0000 (+0000)
Subject: Document wfWarn() function
X-Git-Tag: 1.31.0-rc.0~40171
X-Git-Url: http://git.cyclocoop.org/%7B%24www_url%7Dadmin/compta/operations/recherche.php?a=commitdiff_plain;h=4d2ccdcfddba142a2c10a294fdcc5f466d6c3668;p=lhc%2Fweb%2Fwiklou.git

Document wfWarn() function
---

diff --git a/includes/GlobalFunctions.php b/includes/GlobalFunctions.php
index 8de5d9b11d..580b510b07 100644
--- a/includes/GlobalFunctions.php
+++ b/includes/GlobalFunctions.php
@@ -3053,6 +3053,16 @@ function wfDeprecated( $function ) {
 	}
 }
 
+/**
+ * Send a warning either to the debug log or in a PHP error depending on
+ * $wgDevelopmentWarnings
+ *
+ * @param $msg String: message to send
+ * @param $callerOffset Integer: number of itmes to go back in the backtrace to
+ *        find the correct caller (1 = function calling wfWarn, ...)
+ * @param $level Integer: PHP error level; only used when $wgDevelopmentWarnings
+ *        is true
+ */
 function wfWarn( $msg, $callerOffset = 1, $level = E_USER_NOTICE ) {
 	$callers = wfDebugBacktrace();
 	if( isset( $callers[$callerOffset+1] ) ){