From: moodler <moodler>
Date: Thu, 14 Sep 2006 04:31:05 +0000 (+0000)
Subject: Fixing up comments on debugging()
X-Git-Url: http://git.mjollnir.org/gw?a=commitdiff_plain;h=2fca6e0b2637fb9d22641d8639b5b8e9da532088;p=moodle.git

Fixing up comments on debugging()
---

diff --git a/lib/weblib.php b/lib/weblib.php
index f3519c8d45..a635b186d3 100644
--- a/lib/weblib.php
+++ b/lib/weblib.php
@@ -5218,12 +5218,12 @@ function page_doc_link($text='', $iconpath='') {
  * to the specified level: E_NOTICE, E_ALL, E_STRICT etc
  * eg use like this:
  *
- * if (debugging()) { echo "some normal debug info" } 
- *
- * debugging("something really picky", E_STRICT);
+ * 1)  debugging('a normal notice');
+ * 2)  debugging('something really picky', E_STRICT);
+ * 3)  if (debugging()) { echo "a bunch of commands could be here" } 
  *
+ * @param string $message a message to print
  * @param int $level the level at which this debugging statement should show
- * @param string $message a message to print if possible
  * @return bool
  */
 function debugging($message='', $level=E_NOTICE) {