From 5b180880dfcd4aac258a18fc15a02a49173c3d73 Mon Sep 17 00:00:00 2001
From: Robert Sesek <rsesek@bluestatic.org>
Date: Sat, 22 Oct 2005 22:33:58 +0000
Subject: [PATCH] Documented the entire printer.php class

---
 printer.php | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/printer.php b/printer.php
index 743f1fa..5d1e69f 100644
--- a/printer.php
+++ b/printer.php
@@ -54,6 +54,12 @@ class Printer
 		$this->registry =& $registry;
 	}
 	
+	/**
+	* Creates a redirect to another page; constructs the header and footer (therefore execution stops)
+	*
+	* @param	string	Location to redirect to
+	* @param	integer	Time to wait before the redirect
+	*/
 	function redirect($location, $timeout = 10)
 	{
 		$timeout = $timeout * 200;
@@ -88,6 +94,11 @@ EOD;
 		$this->page_end();
 	}
 	
+	/**
+	* Throws a fatal error; constructs the header and footer
+	*
+	* @param	string	Error messsage text
+	*/
 	function error($message)
 	{
 		$this->page_start($this->registry->modules['localize']->string('Error'));
-- 
2.22.5