Bug 13208: [FOLLOW-UP] Perl documentation for modules

Signed-off-by: Katrin Fischer <katrin.fischer.83@web.de>
Signed-off-by: David Bourgault <david.bourgault@inlibro.com>
Signed-off-by: Nick Clemens <nick@bywatersolutions.com>
Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org>

diff --git a/Koha/Acquisition/Basket.pm b/Koha/Acquisition/Basket.pm
index ae95d2c..3925fc6 100644 (file)
--- a/Koha/Acquisition/Basket.pm
+++ b/Koha/Acquisition/Basket.pm
@@ -1,19 +1,63 @@
 package Koha::Acquisition::Basket;
 
+# Copyright 2017 Aleisha Amohia <aleisha@catalyst.net.nz>
+#
+# 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 base qw( Koha::Object );
 
+=head1 NAME
+
+Koha::Acquisition::Basket - Koha Basket Object class
+
+=head1 API
+
+=head2 Class Methods
+
+=cut
+
+=head3 bookseller
+
+Returns the vendor
+
+=cut
+
 sub bookseller {
     my ($self) = @_;
     my $bookseller_rs = $self->_result->booksellerid;
     return Koha::Acquisition::Bookseller->_new_from_dbic( $bookseller_rs );
 }
 
+=head3 type
+
+=cut
+
 sub _type {
     return 'Aqbasket';
 }
 
+=head1 AUTHOR
+
+Aleisha Amohia <aleisha@catalyst.net.nz>
+Catalyst IT
+
+=cut
+
 1;

diff --git a/Koha/Acquisition/Baskets.pm b/Koha/Acquisition/Baskets.pm
index ebeb6c7..1e4def1 100644 (file)
--- a/Koha/Acquisition/Baskets.pm
+++ b/Koha/Acquisition/Baskets.pm
@@ -1,5 +1,22 @@
 package Koha::Acquisition::Baskets;
 
+# Copyright 2017 Aleisha Amohia <aleisha@catalyst.net.nz>
+#
+# 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;
@@ -7,12 +24,37 @@ use Koha::Acquisition::Basket;
 
 use base qw( Koha::Objects );
 
+=head1 NAME
+
+Koha::Acquisition::Baskets - Koha Baskets object set class
+
+=head1 API
+
+=head2 Class Methods
+
+=cut
+
+=head3 type
+
+=cut
+
 sub _type {
     return 'Aqbasket';
 }
 
+=head3 object_class
+
+=cut
+
 sub object_class {
     return 'Koha::Acquisition::Basket';
 }
 
+=head1 AUTHOR
+
+Aleisha Amohia <aleisha@catalyst.net.nz>
+Catalyst IT
+
+=cut
+
 1;