[Jifty-commit] r6436 - in jifty/trunk: lib/Jifty/Plugin

[Jifty commits]

Author: alexmv
Date: Wed Feb 25 01:03:43 2009
New Revision: 6436

Modified:
   jifty/trunk/   (props changed)
   jifty/trunk/lib/Jifty/Plugin/LeakTracker.pm

Log:
 r42598 at kohr-ah:  chmrr | 2009-02-25 00:57:46 -0500
 POD nits for LeakTracker


Modified: jifty/trunk/lib/Jifty/Plugin/LeakTracker.pm
==============================================================================
--- jifty/trunk/lib/Jifty/Plugin/LeakTracker.pm	(original)
+++ jifty/trunk/lib/Jifty/Plugin/LeakTracker.pm	Wed Feb 25 01:03:43 2009
@@ -9,6 +9,38 @@
 
 Jifty::Plugin::LeakTracker - Leak tracker plugin
 
+=head1 DESCRIPTION
+
+Memory leak detection and reporting for your Jifty app
+
+=head1 USAGE
+
+Add the following to your site_config.yml
+
+ framework:
+   Plugins:
+     - LeakTracker: {}
+
+This makes the following URLs available:
+
+View the top-level leak report (how much each request has leaked)
+
+    http://your.app/__jifty/admin/leaks
+
+View the top-level leak report, including zero-leak requests
+
+    http://your.app/__jifty/admin/leaks/all
+
+View an individual request's detailed leak report (which objects were leaked)
+
+    http://your.app/__jifty/admin/leaks/3
+
+=head1 WARNING
+
+If you use this in production, be sure to block off 'leaks' from
+non-administrators. The full Data::Dumper output of the objects
+leaked is available, which may of course contain sensitive information.
+
 =cut
 
 BEGIN {
@@ -28,9 +60,12 @@
 
 my $empty_array = total_size([]);
 
+=head1 METHODS
+
 =head2 init
 
 init installs the triggers needed around each HTTP request
+
 =cut
 
 sub init {
@@ -114,44 +149,10 @@
     $self->tracker(undef);
 }
 
-=head1 NAME
-
-Jifty::Plugin::LeakTracker
-
-=head1 DESCRIPTION
-
-Memory leak detection and reporting for your Jifty app
-
-=head1 USAGE
-
-Add the following to your site_config.yml
-
- framework:
-   Plugins:
-     - LeakTracker: {}
-
-This makes the following URLs available:
-
-View the top-level leak report (how much each request has leaked)
-
-    http://your.app/__jifty/admin/leaks
-
-View the top-level leak report, including zero-leak requests
-
-    http://your.app/__jifty/admin/leaks/all
-
-View an individual request's detailed leak report (which objects were leaked)
-
-    http://your.app/__jifty/admin/leaks/3
-
-=head1 WARNING
-
-If you use this in production, be sure to block off 'leaks' from
-non-administrators. The full Data::Dumper output of the objects
-leaked is available, which may of course contain sensitive information.
-
 =head1 SEE ALSO
 
+L<Jifty::Plugin::Gladiator>
+
 L<Jifty::Plugin::LeakTracker::View>, L<Jifty::Plugin::LeakTracker::Dispatcher>
 
 =head1 COPYRIGHT AND LICENSE