summaryrefslogtreecommitdiff
path: root/includes
diff options
context:
space:
mode:
authorDries Buytaert <dries@buytaert.net>2010-06-25 21:28:47 +0000
committerDries Buytaert <dries@buytaert.net>2010-06-25 21:28:47 +0000
commit60883871aab067f13bd3411bfd2874b50cfe7978 (patch)
tree36e5a0ea6ab9c0bb852efa11d137fde06c70968f /includes
parent3a843af2ae21e351b6f403e1d84531a7c5d9d3e1 (diff)
downloadbrdo-60883871aab067f13bd3411bfd2874b50cfe7978.tar.gz
brdo-60883871aab067f13bd3411bfd2874b50cfe7978.tar.bz2
- Patch #782442 by nenne, jhodgdon: watchdog should document better.
Diffstat (limited to 'includes')
-rw-r--r--includes/bootstrap.inc6
1 files changed, 4 insertions, 2 deletions
diff --git a/includes/bootstrap.inc b/includes/bootstrap.inc
index 7d84e993f..babc4f624 100644
--- a/includes/bootstrap.inc
+++ b/includes/bootstrap.inc
@@ -1603,7 +1603,8 @@ function watchdog_exception($type, Exception $exception, $message = NULL, $varia
* Log a system message.
*
* @param $type
- * The category to which this message belongs.
+ * The category to which this message belongs. Can be any string, but the
+ * general practice is to use the name of the module calling watchdog().
* @param $message
* The message to store in the log. Keep $message translatable
* by not concatenating dynamic values into it! Variables in the
@@ -1615,7 +1616,8 @@ function watchdog_exception($type, Exception $exception, $message = NULL, $varia
* NULL if message is already translated or not possible to
* translate.
* @param $severity
- * The severity of the message, as per RFC 3164.
+ * The severity of the message, as per RFC 3164. Possible values are
+ * WATCHDOG_ERROR, WATCHDOG_WARNING, etc.
* @param $link
* A link to associate with the message.
*