From 57ca3f132f22b977566a45a515978f11bf19550f Mon Sep 17 00:00:00 2001
From: Dries Buytaert <dries@buytaert.net>
Date: Sun, 25 Feb 2001 17:17:26 +0000
Subject: - added some documentation

---
 modules/watchdog.module          | 15 ++++++++++++++-
 modules/watchdog/watchdog.module | 15 ++++++++++++++-
 2 files changed, 28 insertions(+), 2 deletions(-)

(limited to 'modules')

diff --git a/modules/watchdog.module b/modules/watchdog.module
index 26714ed20..9980a9c36 100644
--- a/modules/watchdog.module
+++ b/modules/watchdog.module
@@ -1,8 +1,16 @@
 <?
 
-$module = array("cron" => "watchdog_cron",
+$module = array("help" => "watchdog_help",
+                "cron" => "watchdog_cron",
                 "admin" => "watchdog_admin");
 
+function watchdog_help() {
+ ?>
+  <P>The watchdog module monitors your website, captures system events in a log and records them to be reviewed by an authorized individual at a later time.  The watchdog log is simply a list of events recorded during operation and contains usage data, performance data, errors, warnings and operational information.  It is vital to check the watchdog report on a regular basis as it is often the only way to tell what is going on.</P>
+  <P>To ease administration, the watchdog will automatically remove old logs.</P>
+ <?
+}
+
 function watchdog_cron() {
   watchdog_clean();
 }
@@ -63,7 +71,12 @@ function watchdog_view($id) {
 function watchdog_admin() {
   global $op, $id, $order;
 
+  print "<SMALL><A HREF=\"admin.php?mod=watchdog\">overview</A> | <A HREF=\"admin.php?mod=watchdog&op=help\">help</A></SMALL><HR>\n";
+
   switch ($op) {
+    case "help":
+      watchdog_help();
+      break;
     case "view":
       watchdog_view($id);
       break;
diff --git a/modules/watchdog/watchdog.module b/modules/watchdog/watchdog.module
index 26714ed20..9980a9c36 100644
--- a/modules/watchdog/watchdog.module
+++ b/modules/watchdog/watchdog.module
@@ -1,8 +1,16 @@
 <?
 
-$module = array("cron" => "watchdog_cron",
+$module = array("help" => "watchdog_help",
+                "cron" => "watchdog_cron",
                 "admin" => "watchdog_admin");
 
+function watchdog_help() {
+ ?>
+  <P>The watchdog module monitors your website, captures system events in a log and records them to be reviewed by an authorized individual at a later time.  The watchdog log is simply a list of events recorded during operation and contains usage data, performance data, errors, warnings and operational information.  It is vital to check the watchdog report on a regular basis as it is often the only way to tell what is going on.</P>
+  <P>To ease administration, the watchdog will automatically remove old logs.</P>
+ <?
+}
+
 function watchdog_cron() {
   watchdog_clean();
 }
@@ -63,7 +71,12 @@ function watchdog_view($id) {
 function watchdog_admin() {
   global $op, $id, $order;
 
+  print "<SMALL><A HREF=\"admin.php?mod=watchdog\">overview</A> | <A HREF=\"admin.php?mod=watchdog&op=help\">help</A></SMALL><HR>\n";
+
   switch ($op) {
+    case "help":
+      watchdog_help();
+      break;
     case "view":
       watchdog_view($id);
       break;
-- 
cgit v1.2.3