Some POD fixups.
authorJason Stephenson <jason@sigio.com>
Sat, 6 Sep 2014 00:31:27 +0000 (20:31 -0400)
committerJason Stephenson <jason@sigio.com>
Sat, 6 Sep 2014 00:31:27 +0000 (20:31 -0400)
Use verbatim paragraphs instead of formatted blocks for the code
examples when describing methods.

Signed-off-by: Jason Stephenson <jason@sigio.com>
lib/NCIP/Header.pm
lib/NCIP/ILS.pm

index d7d5646..aecfd1d 100644 (file)
 package NCIP::Header;
 use parent qw(Class::Accessor);
 
 package NCIP::Header;
 use parent qw(Class::Accessor);
 
-# This is a NCIP ResponseHeader object.  We do not implement an
-# initator, so we do not implement the InitiationHeader and we do not
-# attempt to make this object generic enough to handle that field.
-# The fields are as defined in Z39.83-1-2012.  Ext is provided but is
-# not used by the current iteration of NCIPServer.
+=head1 NAME
+
+Header - Response Header as Defined in z39.83-1-2012
+
+=head1 SYNOPSIS
+
+
+
+=head1 DESCRIPTION
+
+This is a NCIP ResponseHeader object.  We do not implement an
+initator, so we do not implement the InitiationHeader and we do not
+attempt to make this object generic enough to handle that field.
+The fields are as defined in Z39.83-1-2012.  Ext is provided but is
+not used by the current iteration of NCIPServer.
+
+=head1 FIELDS
+
+=head2 FromSystemId
+
+Not used in the current implementation.
+
+=head2 FromSystemAuthentication
+
+Not used in the current implementation.
+
+=head2 FromAgencyId
+
+AgencyId of the agency sending the message.
+
+=head2 FromAgencyAuthentication
+
+Not used in the current implementation.
+
+=head2 ToSystemId
+
+Not used in the current implementation.
+
+=head2 ToAgencyId
+
+AgencyId of the agency receiving the message.
+
+=head2 Ext
+
+Not used in the current implementation.
+
+
+=cut
 
 NCIP::Header->mk_accessors(qw(FromSystemId FromSystemAuthentication
                                FromAgencyId FromAgencyAuthentication
 
 NCIP::Header->mk_accessors(qw(FromSystemId FromSystemAuthentication
                                FromAgencyId FromAgencyAuthentication
index 73f26a0..49c9c3a 100644 (file)
@@ -30,9 +30,9 @@ NCIP::ILS - A base class for NIPServer ILS drivers.
 
 =head1 SYNOPSIS
 
 
 =head1 SYNOPSIS
 
-C<use NCIP::ILS;>
+    use NCIP::ILS;
 
 
-C<my $ils = NCIP::ILS-E<gt>new(name =E<gt> $config-E<gt>{NCIP.ils.value});>
+    $ils = NCIP::ILS->new(name => $config->{NCIP.ils.value});
 
 =head1 DESCRIPTION
 
 
 =head1 DESCRIPTION
 
@@ -207,7 +207,7 @@ subclass.
 
 =head2 unsupportedservice
 
 
 =head2 unsupportedservice
 
-C<my $response = $ils-E<gt>unsupportedservice($request);>
+    $response = $ils->unsupportedservice($request);
 
 This method has the same signature as a regular service handler
 method.  It returns a response containing an Unsupported Service
 
 This method has the same signature as a regular service handler
 method.  It returns a response containing an Unsupported Service
@@ -237,7 +237,7 @@ sub unsupportedservice {
 
 =head2 make_header
 
 
 =head2 make_header
 
-C<$response-E<gt>header($ils-E<gt>make_header($request));>
+    $response->header($ils->make_header($request));
 
 All subclasses will possibly want to create a ResponseHeader for the
 response message.  Since the code for that could be highly redundant
 
 All subclasses will possibly want to create a ResponseHeader for the
 response message.  Since the code for that could be highly redundant
@@ -273,7 +273,7 @@ sub make_header {
 
 =head2 parse_request_type
 
 
 =head2 parse_request_type
 
-C<my $type = $ils-E<gt>parse_request_type($request);>
+    $type = $ils->parse_request_type($request);
 
 Given the request hashref object, parse_request_type will return the
 service being requested in the message.  This method is called by
 
 Given the request hashref object, parse_request_type will return the
 service being requested in the message.  This method is called by
@@ -301,7 +301,7 @@ sub parse_request_type {
 
 =head2 find_user_barcode
 
 
 =head2 find_user_barcode
 
-C<my $barcode = $ils-E<gt>find_user_barcode($request);>
+    $barcode = $ils->find_user_barcode($request);
 
 If you have a request type that includes a user barcode identifier
 value, this routine will find it.
 
 If you have a request type that includes a user barcode identifier
 value, this routine will find it.
@@ -364,7 +364,7 @@ sub find_user_barcode {
 
 =head2 find_item_barcode
 
 
 =head2 find_item_barcode
 
-C<my $barcode = $ils-E<gt>find_item_barcode($request);>
+    $barcode = $ils->find_item_barcode($request);
 
 If you have a request type that includes an item barcode identifier
 value, this routine will find it.
 
 If you have a request type that includes an item barcode identifier
 value, this routine will find it.