From 2f45f306fb71d8494d72a6029168c7e5589a0f01 Mon Sep 17 00:00:00 2001
From: Scott Walters <scott@slowass.net>
Date: Thu, 5 May 2011 15:08:06 -0400
Subject: [PATCH] Doc improvements

---
 lib/WebGUI/Middleware/StackTrace.pm | 20 ++++++++++++++------
 1 file changed, 14 insertions(+), 6 deletions(-)

diff --git a/lib/WebGUI/Middleware/StackTrace.pm b/lib/WebGUI/Middleware/StackTrace.pm
index 77e345350..6ff33417f 100644
--- a/lib/WebGUI/Middleware/StackTrace.pm
+++ b/lib/WebGUI/Middleware/StackTrace.pm
@@ -353,7 +353,17 @@ Plack^HWebGUI::Middleware::StackTrace - Displays stack trace when your app dies
 This middleware is a copy and modification of L<Plack::Middleware::StackTrace>, a
 middleware which catches exceptions (run-time errors) happening in your
 application and displays nice stack trace screen.
+
 This copy has been extended to display additional WebGUI specific information.
+The stack trace is annotated with titles and object types of assets for
+stack frames running inside of method calls to assets.
+
+This fork of C<StackTrace> also hooks into L<WebGUI::Session::Log>.
+Stack traces are generated on call to C<< $session->log->error >>
+or C<< $session->log->fatal >>.
+L<Plack::Middleware::StackTrace> will (almost) never display a
+stack trace for WebGUI as errors are caught and turned into HTTP
+C<200> replies.
 
 You're recommended to use this middleware during the development and
 use L<Plack::Middleware::HTTPExceptions> in the deployment mode as a
@@ -396,16 +406,14 @@ standard error.
 
 =head1 AUTHOR
 
-Tokuhiro Matsuno
-
-Tatsuhiko Miyagawa
-
 Scott Walters
 
 With code taken from:
 
 Tatsuhiko Miyagawa E<lt>miyagawa@bulknews.netE<gt>
-    
+
+Tokuhiro Matsuno
+
 Shawn M Moore
 
 HTML generation code is ripped off from L<CGI::ExceptionManager> written by Tokuhiro Matsuno and Kazuho Oku.
@@ -414,7 +422,7 @@ HTML generation code is ripped off from L<CGI::ExceptionManager> written by Toku
 
 L<Plack::Middleware::StackTrace>
 
-L<Devel::StackTrace::AsHTML> L<Plack::Middleware> L<Plack::Middleware::HTTPExceptions>
+L<Devel::StackTrace::AsHTML> L<Plack::Middleware> L<Plack::Middleware::HTTPExceptions> L<WebGUI::Session::Log>
 
 =cut