Permalink
Browse files

POD fixes.

  • Loading branch information...
1 parent eee3c9d commit 4527323914b40f1a2bf2016202a6944373a2bbc1 @dolmen committed Oct 26, 2010
Showing with 43 additions and 17 deletions.
  1. +43 −17 lib/POE/Component/Logger.pm
@@ -92,7 +92,7 @@ And later in an event handler:
=head1 DESCRIPTION
POE::Component::Logger provides a simple logging component
-that uses Log::Dispatch::Config to drive it, allowing you
+that uses L<Log::Dispatch::Config> to drive it, allowing you
to log to multiple places at once (e.g. to STDERR and Syslog
at the same time) and also to flexibly define your logger's
output.
@@ -113,45 +113,45 @@ goes back to the kernel so it can process the next event.
=head1 OPTIONS and METHODS
-=head2 spawn
+=head2 C<spawn>
The spawn class method can take two options. A required
B<ConfigFile> option, which specifies the location of the
-config file as passed to Log::Dispatch::Config's
+config file as passed to L<Log::Dispatch::Config>'s
C<configure()> method (note that you can also use an object
here, see L<Log::Dispatch::Config> for more details). The
other available option is B<Alias> which you can use if you
wish to have more than one logger in your POE application.
Note though that if you specify an alias other than the
default 'logger' alias, you will not be able to use the
-C<Logger-E<lt>log> shortcut, and will have to use direct
+C<Logger-E<gt>log> shortcut, and will have to use direct
method calls instead.
-=head2 Logger->log
+=head2 C<Logger-E<gt>log> / C<POE::Component::Logger-E<gt>log>
This is used to perform a logging action. You may either
pass a string, or a hashref. If you pass in a string it
is logged at the level specified in
C<$POE::Component::Logger::DefaultLevel>, which is
-'warning' by default. If you pass in a hashref it is passed
-as a hash to Log::Dispatch's C<log()> method.
+'warning' by default. If you pass in a hashref it is expanded
+as a hash and passed to Log::Dispatch's C<log()> method.
=head1 LOGGING STATES
-The following states are available on the logging session:
+The following states are available on the POE logging session:
-=head2 log
+=head2 C<log>
-Same as C<Logger-E<lt>log()>, except you may use a different
+Same as C<Logger-E<gt>log()>, except you may use a different
alias if posting direct to the kernel, for example:
$kernel->post( 'error.log', 'log', "Some error");
$kernel->post( 'access.log', 'log', "Access Details");
-=head2 debug
+=head2 C<debug>
-And also C<notice> C<warning>, C<info>, C<error>, C<critical>,
-C<alert> and C<emergency>.
+And also C<notice>, C<info>, C<warning>, C<error>, C<critical>,
+C<emergency> and C<alert>.
These states simply log at a different level. See
L<Log::Dispatch> for further details.
@@ -171,16 +171,42 @@ L<Log::Dispatch> for further details.
class = Log::Dispatch::Syslog
min_level = warning
+
+=head1 SUPPORT
+
+You can look for information at:
+
+=over 4
+
+=item * RT: CPAN's request tracker
+
+L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=POE-Component-Logger>:
+post bug report there.
+
+=item * CPAN Ratings
+
+L<http://cpanratings.perl.org/p/POE-Component-Logger>:
+if you use this distibution, please add comments on your experience for other
+users.
+
+=item * Search CPAN
+
+L<http://search.cpan.org/dist/POE-Component-Logger/>
+
+=item * GitHub
+
+L<http://github.com/dolmen/POE-Component-Logger>:
+the source code repository.
+
+=back
+
+
=head1 AUTHORS
Matt Sergeant, C<matt@sergeant.org>.
Olivier MenguE<eacute>, C<dolmen@cpan.org>.
-=head1 BUGS
-
-Please use http://rt.cpan.org/ for bugs.
-
=head1 COPYRIGHT & LICENSE
Copyright E<copy> 2002 Matt Sergeant.

0 comments on commit 4527323

Please sign in to comment.