Bug 15253: Add POD to C4/SIP/Logger.pm and C4/SIP/Trapper.pm

Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org>
Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>

diff --git a/C4/SIP/Logger.pm b/C4/SIP/Logger.pm
index 8eff682..4116921 100644 (file)
--- a/C4/SIP/Logger.pm
+++ b/C4/SIP/Logger.pm
@@ -6,11 +6,15 @@ use Modern::Perl;
 our $activeSIPServer;
 our $activeLogger;
 
+=head1 NAME
+
+C4::SIP::Logger - Module for handling SIP server logging
+
 =head2 get_SIPServer
 
     my $sipServer = C4::SIP::SIPServer::get_SIPServer()
 
-@RETURNS C4::SIP::SIPServer, the current server's child-process used to handle this SIP-transaction
+    @RETURNS C4::SIP::SIPServer, the current server's child-process used to handle this SIP-transaction
 
 =cut
 
@@ -18,6 +22,16 @@ sub get_SIPServer {
     return $activeSIPServer;
 }
 
+=head2 _set_SIPServer
+
+    my $sipServer = C4::SIP::SIPServer::_set_SIPServer($sipServer)
+
+    Sets the passed in SIP server as the active SIP server and returns it as well
+
+    @RETURNS C4::SIP::SIPServer, the current server's child-process used to handle this SIP-transaction
+
+=cut
+
 sub _set_SIPServer {
     my ($sipServer) = @_;
     $activeSIPServer = $sipServer;
@@ -36,6 +50,12 @@ sub get_logger {
     return $activeLogger;
 }
 
+=head2 set_logger
+
+    my $logger = C4::SIP::SIPServer::set_logger($logger)
+
+=cut
+
 sub set_logger {
     my ($logger) = @_;
     $activeLogger = $logger;

diff --git a/C4/SIP/Trapper.pm b/C4/SIP/Trapper.pm
index 8dce10e..8f115b5 100644 (file)
--- a/C4/SIP/Trapper.pm
+++ b/C4/SIP/Trapper.pm
@@ -4,11 +4,27 @@ use Modern::Perl;
 
 use Koha::Logger;
 
+=head1 NAME
+
+C4::SIP::Trapper - Module for capturing warnings for the SIP logger
+
+=head2 TIEHANDLE
+
+    Ties the given class to this module.
+
+=cut
+
 sub TIEHANDLE {
     my $class = shift;
     bless [], $class;
 }
 
+=head2 PRINT
+
+    Captures warnings and directs them to Koha::Logger as well as STDERR
+
+=cut
+
 sub PRINT {
     my $self = shift;
     $Log::Log4perl::caller_depth++;