improve it::error docs

1 files changed, 20 insertions, 15 deletions

diff --git a/it.class b/it.class
index f302bce..e2ddd4c 100644
--- a/it.class
+++ b/it.class
@@ -123,21 +123,26 @@ static function timerlog($label = '')
 /**
  * If display_errors is on or stdout is a tty, shows error in page or on stdout respectively
  * If display_errors is off, mails (with rate limiting) diagnostics to .diffnotice addresses or file owner or SERVER_ADMIN
- * @param $p either error title or assoc array of params, see below
- * @param $p['title'] error title, one line. also accepted in $p[0] (with priority). false means ignore error
- * @param $p['body'] error body: multiline string or any data type (will be dumped)
- * @param $p['to'] comma separated recipient list
- * @param $p['id'] id of error, used with timewindow, defaults to file and line of caller
- * @param $p['graceperiod'] in seconds. deprecated, see $p['timewindow']
- * @param $p['timewindow'] in secs. "5-35" means for an notice to be sent, a second error must occur 5 to 35 seconds after first err
- * @param $p['blockmailid'] block mail for $p['blockmail'] seconds with same id. Default: $p['to']
- * @param $p['blockmail'] number of seconds to block mails after having sent a mail [3600]
- * @param $p['backtraceskip'] number of stack levels to drop
- * @param $p['skipfiles'] files to skip in backtrace
- * @param $p['okstate'] give current ok label and ok state, e.g. telresult=1 for working. see failcount
- * @param $p['failcount'] give number of consecutive okstate failures needed for creating an error [2]
- * @param $p['omitdebuginfo'] value 1 omits long stack and var dumps, value 2 also minimal infos
- * @param $p['fatal'] exit after displaying error
+ *
+ * Controlling error mail content
+ *  @param $p either error title or assoc array of params, see below
+ *  @param $p['title'] error title, one line. also accepted in $p[0] (with priority). false means suppress error
+ *  @param $p['body'] error body: multiline string or any data type (will be dumped)
+ *  @param $p['backtraceskip'] number of stack levels to drop
+ *  @param $p['skipfiles'] files to skip in backtrace
+ *  @param $p['omitdebuginfo'] value 1 omits long stack and var dumps, value 2 also minimal infos
+ *
+ * Controlling the sending of mails
+ *  @param $p['to'] comma separated recipient list
+ *  @param $p['timewindow'] in secs. "5-35" means for an mail to be sent, another err must occur 5 to 35 seconds after first one
+ *  @param $p['id'] id of error, used with timewindow, defaults to file and line of caller
+ *  @param $p['blockmailid'] block mail for $p['blockmail'] seconds with same id. Default: $p['to']
+ *  @param $p['blockmail'] number of seconds to block mails after having sent a mail [3600]
+ *  @param $p['okstate'] give current ok label and ok state, e.g. telresult=1 for working. see failcount
+ *  @param $p['failcount'] give number of consecutive okstate failures needed for creating an error [2]
+ *  @param $p['fatal'] exit after displaying error
+ *  @param $p['graceperiod'] in seconds. DEPRECATED, see $p['timewindow']
+ *
  * @return always null (so users can return it::error() in error cases)
  *
  * TIMEWINDOW 5-35 (x = error occurs, no mail; m = error occurs, mail sent)