Update documentation

git-svn-id: https://svn.code.sf.net/p/squirrelmail/code/trunk/squirrelmail@10707 7612ce4b-ef26-0410-bec9-ea0150e637f0

diff --git a/class/error.class.php b/class/error.class.php
index aabea017f17294f5552fcd255b4b4b1fed0f8f11..af241e362c9e0db16ddeda90c8a311c7fa044ea1 100644 (file)
--- a/class/error.class.php
+++ b/class/error.class.php
@@ -63,7 +63,9 @@ class ErrorHandler {
     }
 
     /**
-     * Sets the error template
+     * Store errors generated in a previous script but couldn't be displayed
+     * due to a header redirect. This requires storing of aDelayedErrors in the session
+     * @param array $aDelayedErrors array with errors stored in the $this->aErrors format.
      * @since 1.5.1
      */
     function AssignDelayedErrors(&$aDelayedErrors) {
@@ -194,7 +196,7 @@ class ErrorHandler {
         // Show the error immediate in case of fatal errors
         if ($iType == SQM_ERROR) {
             if (!$this->header_sent) {
-                // replace this with template that can be assigned
+                // TODO replace this with template that can be assigned
                 displayHtmlHeader(_("Error"),'',false);
             }
             $this->DisplayErrors();