pod updates

bricas · bricas · commit a6220cebc2cd · 2005-12-15T14:30:14.000Z
pod_coverage.t added
updated Changes
diff --git a/Changes b/Changes
@@ -1,5 +1,6 @@
-v0.92 Fri Nov 11 2005
+v0.92 Thu Dec 15 2005
 - updated Catalyst plugin for Catalyst 5.5
+- pod updates
 
 v0.91 Wed Oct  5 2005
 - modified Response/SearchRetrieve.pm to
diff --git a/MANIFEST b/MANIFEST
@@ -23,6 +23,7 @@ t/cgi.t
 t/cgi_app.t
 t/diagnostic.t
 t/pod.t
+t/pod_coverage.t
 t/record.t
 t/request_explain.t
 t/request_scan.t
diff --git a/lib/SRU/Request/Explain.pm b/lib/SRU/Request/Explain.pm
@@ -58,6 +58,10 @@ my @validParams = qw(
     extraRequestData 
 );
 
+=head2 validParams()
+
+=cut
+
 # no pod since this is used in SRU::Request
 sub validParams { return @validParams };
 
diff --git a/lib/SRU/Request/Scan.pm b/lib/SRU/Request/Scan.pm
@@ -61,6 +61,10 @@ my @validParams = qw(
     extraRequestData
 );
 
+=head2 validParams()
+
+=cut
+
 sub validParams { return @validParams; }
 
 SRU::Request::Scan->mk_accessors( @validParams );
diff --git a/lib/SRU/Request/SearchRetrieve.pm b/lib/SRU/Request/SearchRetrieve.pm
@@ -73,6 +73,10 @@ my @validParams = qw(
     extraRequestData
 );
 
+=head2 validParams()
+
+=cut
+
 sub validParams { return @validParams };
 
 SRU::Request::SearchRetrieve->mk_accessors( @validParams );
diff --git a/lib/SRU/Server.pm b/lib/SRU/Server.pm
@@ -79,6 +79,14 @@ my @accessors = qw( request response cql );
 
 __PACKAGE__->mk_accessors( @accessors );
 
+=head1 CGI::APPLICATION METHODS
+
+=head2 setup
+
+Sets the C<run_modes>, C<mode_param> and the default runmode (explain).
+
+=cut
+
 sub setup {
     my $self = shift;
 
@@ -87,6 +95,12 @@ sub setup {
     $self->mode_param( 'operation' );
 }
 
+=head2 cgiapp_prerun
+
+Parses the incoming SRU request and if needed, checks the CQL query.
+
+=cut
+
 sub cgiapp_prerun {
     my $self = shift;
     my $mode = shift;
@@ -115,6 +129,12 @@ sub cgiapp_prerun {
     }
 }
 
+=head2 cgiapp_postrun
+
+Sets the content type (text/xml) and serializes the response.
+
+=cut
+
 sub cgiapp_postrun {
     my $self       = shift;
     my $output_ref = shift;
@@ -124,6 +144,12 @@ sub cgiapp_postrun {
     $$output_ref = $self->response->asXML;
 }
 
+=head2 error_mode
+
+Stub error runmode.
+
+=cut
+
 sub error_mode {
 }
 
diff --git a/lib/SRU/Utils.pm b/lib/SRU/Utils.pm
@@ -6,6 +6,27 @@ use base qw( Exporter );
 
 our @EXPORT_OK = qw( error );
 
+=head1 NAME
+
+SRU::Utils - Utility functions for SRU
+
+=head1 SYNOPSIS
+
+    use SRU::Utils qw( error );
+    return error( "error!" );
+
+=head1 DESCRIPTION
+
+This is a set of utility functions for the SRU objects.
+
+=head1 METHODS
+
+=head2 error( $message )
+
+Sets the C<$SRU::Error> message.
+
+=cut
+
 sub error {
     if ( $_[0] ) { $SRU::Error = $_[0]; };
     return;
diff --git a/lib/SRU/Utils/XML.pm b/lib/SRU/Utils/XML.pm
@@ -6,18 +6,51 @@ use base qw( Exporter );
 
 our @EXPORT_OK = qw( element elementNoEscape escape stylesheet );
 
+=head1 NAME
+
+SRU::Utils::XML - XML utility functions for SRU
+
+=head1 SYNOPSIS
+
+    use SRU::Utils::XML qw( escape );
+    return escape( $text );
+
+=head1 DESCRIPTION
+
+This is a set of utility functions for use with XML data.
+
+=head1 METHODS
+
+=head2 element( $tag, $text )
+
+Creates an xml element named C<$tag> containing escaped data (C<$text>).
+
+=cut
+
 sub element {
-    my ($tag,$text) = @_;
+    my ($tag, $text) = @_;
     return '' if ! defined $text;
     return "<$tag>" . escape($text) . "</$tag>";
 }
 
+=head2 elementNoEscape( $tag, $text )
+
+Similar to C<element>, except that C<$text> is not escaped.
+
+=cut
+
 sub elementNoEscape {
-    my ($tag,$text) = @_;
+    my ($tag, $text) = @_;
     return '' if ! defined $text;
     return "<$tag>$text</$tag>";
 }
 
+=head2 escape( $text )
+
+Does minimal escaping on C<$text>.
+
+=cut
+
 sub escape {
     my $text = shift || '';
     $text =~ s/</&lt;/g;
@@ -26,6 +59,12 @@ sub escape {
     return $text;
 }
 
+=head2 stylesheet( $uri )
+
+A shortcut method to create an xml-stylesheet declaration. 
+
+=cut
+
 sub stylesheet {
     my $uri = shift;
     return qq(<?xml-stylesheet type='text/xsl' href="$uri" ?>);
diff --git a/lib/SRU/Utils/XMLTest.pm b/lib/SRU/Utils/XMLTest.pm
@@ -7,6 +7,27 @@ use base qw( Exporter );
 
 our @EXPORT = qw( wellFormedXML );
 
+=head1 NAME
+
+SRU::Utils::XMLTest - XML testing utility functions
+
+=head1 SYNOPSIS
+
+    use SRU::Utils::XMLText;
+    ok( wellFormedXML($xml), '$xml is well formed' );
+
+=head1 DESCRIPTION
+
+This is a set of utility functions for use with testing XML data.
+
+=head1 METHODS
+
+=head2 wellFormedXML( $xml )
+
+Checks if C<$xml> is welformed.
+
+=cut
+
 sub wellFormedXML {
     my $xml_string = shift;
     eval {  
diff --git a/t/pod_coverage.t b/t/pod_coverage.t
@@ -0,0 +1,4 @@
+use Test::More;
+eval "use Test::Pod::Coverage 1.00";
+plan skip_all => "Test::Pod::Coverage 1.00 required for testing POD coverage" if $@;
+all_pod_coverage_ok();
