Bug 19130: (followup) Add POD

This patch adds POD to the following files:

- Koha/Acquisition/Bookseller.pm
- Koha/Acquisition/Booksellers.pm

Signed-off-by: Kyle M Hall <kyle@bywatersolutions.com>
Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org>

diff --git a/Koha/Acquisition/Bookseller.pm b/Koha/Acquisition/Bookseller.pm
index e32b010..f2f08db 100644 (file)
--- a/Koha/Acquisition/Bookseller.pm
+++ b/Koha/Acquisition/Bookseller.pm
@@ -1,31 +1,84 @@
 package Koha::Acquisition::Bookseller;
 
+# This file is part of Koha.
+#
+# Koha is free software; you can redistribute it and/or modify it under the
+# terms of the GNU General Public License as published by the Free Software
+# Foundation; either version 3 of the License, or (at your option) any later
+# version.
+#
+# Koha is distributed in the hope that it will be useful, but WITHOUT ANY
+# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
+# A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with Koha; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
 use Modern::Perl;
 
-use Koha::Database;
+use Koha::Acquisition::Bookseller::Contacts;
+use Koha::Subscriptions;
+
 use base qw( Koha::Object );
 
-use Koha::DateUtils qw( dt_from_string output_pref );
+=head1 NAME
 
-use Koha::Acquisition::Bookseller::Contacts;
-use Koha::Subscriptions;
+Koha::Acquisition::Bookseller Object class
+
+=head1 API
+
+=head2 Class Methods
+
+=head3 baskets
+
+    my $vendor  = Koha::Acquisition::Booksellers->find( $id );
+    my @baskets = $vendor->baskets();
+
+Returns the list of baskets for the vendor
+
+=cut
 
 sub baskets {
     my ( $self ) = @_;
     return $self->{_result}->aqbaskets;
 }
 
+=head3 contacts
+
+    my $vendor   = Koha::Acquisition::Booksellers->find( $id );
+    my @contacts = $vendor->contacts();
+
+Returns the list of contacts for the vendor
+
+=cut
+
 sub contacts {
     my ($self) = @_;
     return Koha::Acquisition::Bookseller::Contacts->search( { booksellerid => $self->id } );
 }
 
+=head3 subscriptions
+
+    my $vendor        = Koha::Acquisition::Booksellers->find( $id );
+    my @subscriptions = $vendor->subscriptions();
+
+Returns the list of subscriptions for the vendor
+
+=cut
+
 sub subscriptions {
     my ($self) = @_;
 
     return Koha::Subscriptions->search( { aqbooksellerid => $self->id } );
 }
 
+=head2 Internal methods
+
+=head3 _type
+
+=cut
+
 sub _type {
     return 'Aqbookseller';
 }

diff --git a/Koha/Acquisition/Booksellers.pm b/Koha/Acquisition/Booksellers.pm
index 1d1eb48..a46c82e 100644 (file)
--- a/Koha/Acquisition/Booksellers.pm
+++ b/Koha/Acquisition/Booksellers.pm
@@ -23,11 +23,11 @@ use base qw( Koha::Objects );
 
 =head1 NAME
 
-Koha::Acquisition::Booksellers Object set class
+Koha::Acquisition::Booksellers object set class
 
 =head1 API
 
-=head2 Class Methods
+=head2 Internal methods
 
 =head3 _type (internal)