From eacdea106ef24b370b4cac485f4f438d90f4b3f8 Mon Sep 17 00:00:00 2001 From: Jason Stephenson Date: Fri, 5 Sep 2014 20:31:27 -0400 Subject: [PATCH] Some POD fixups. Use verbatim paragraphs instead of formatted blocks for the code examples when describing methods. Signed-off-by: Jason Stephenson --- lib/NCIP/Header.pm | 53 ++++++++++++++++++++++++++++++++++++++++++++++++----- lib/NCIP/ILS.pm | 14 +++++++------- 2 files changed, 55 insertions(+), 12 deletions(-) diff --git a/lib/NCIP/Header.pm b/lib/NCIP/Header.pm index d7d5646..aecfd1d 100644 --- a/lib/NCIP/Header.pm +++ b/lib/NCIP/Header.pm @@ -19,11 +19,54 @@ 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 diff --git a/lib/NCIP/ILS.pm b/lib/NCIP/ILS.pm index 73f26a0..49c9c3a 100644 --- a/lib/NCIP/ILS.pm +++ b/lib/NCIP/ILS.pm @@ -30,9 +30,9 @@ NCIP::ILS - A base class for NIPServer ILS drivers. =head1 SYNOPSIS -C + use NCIP::ILS; -Cnew(name =E $config-E{NCIP.ils.value});> + $ils = NCIP::ILS->new(name => $config->{NCIP.ils.value}); =head1 DESCRIPTION @@ -207,7 +207,7 @@ subclass. =head2 unsupportedservice -Cunsupportedservice($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 @@ -237,7 +237,7 @@ sub unsupportedservice { =head2 make_header -C<$response-Eheader($ils-Emake_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 @@ -273,7 +273,7 @@ sub make_header { =head2 parse_request_type -Cparse_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 @@ -301,7 +301,7 @@ sub parse_request_type { =head2 find_user_barcode -Cfind_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. @@ -364,7 +364,7 @@ sub find_user_barcode { =head2 find_item_barcode -Cfind_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. -- 2.11.0