Document wfVarDump()
authorAntoine Musso <hashar@users.mediawiki.org>
Thu, 9 Oct 2008 21:11:10 +0000 (21:11 +0000)
committerAntoine Musso <hashar@users.mediawiki.org>
Thu, 9 Oct 2008 21:11:10 +0000 (21:11 +0000)
includes/GlobalFunctions.php

index 1bbf4b9..dad1a2c 100644 (file)
@@ -1387,7 +1387,10 @@ function wfDiff( $before, $after, $params = '-u' ) {
 }
 
 /**
- * @todo document
+ * A wrapper around the PHP function var_export().
+ * Either print it or add it to the regular output ($wgOut).
+ *
+ * @param $var A PHP variable to dump.
  */
 function wfVarDump( $var ) {
        global $wgOut;