From ff46ba7507fadc9a0735698bf22d283370b68eda Mon Sep 17 00:00:00 2001 From: Tomas Cohen Arazi Date: Tue, 5 Dec 2017 16:35:06 -0300 Subject: [PATCH] Bug 16330: (QA followup) Add missing POD for exceptions This patch adds POD to the exceptions files introduced by this patchset. Note: the qa scripts give false positives on Exceptions. But the patchset was missing them anyway. Signed-off-by: Tomas Cohen Arazi Signed-off-by: Benjamin Rokseth --- Koha/Exceptions/Category.pm | 31 +++++++++++++++++++++++++++++++ Koha/Exceptions/Library.pm | 31 +++++++++++++++++++++++++++++++ Koha/Exceptions/Patron.pm | 31 +++++++++++++++++++++++++++++++ 3 files changed, 93 insertions(+) diff --git a/Koha/Exceptions/Category.pm b/Koha/Exceptions/Category.pm index 3487faa..efd705f 100644 --- a/Koha/Exceptions/Category.pm +++ b/Koha/Exceptions/Category.pm @@ -1,5 +1,20 @@ package Koha::Exceptions::Category; +# 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 Exception::Class ( @@ -14,4 +29,20 @@ use Exception::Class ( }, ); +=head1 NAME + +Koha::Exceptions::Category - Base class for patron categories exceptions + +=head1 Exceptions + +=head2 Koha::Exceptions::Category + +Generic patron category exception + +=head2 Koha::Exceptions::Category::CategorycodeNotFound + +Exception to be used when the required patron category code is not found. + +=cut + 1; diff --git a/Koha/Exceptions/Library.pm b/Koha/Exceptions/Library.pm index 1aea6ad..a9d948e 100644 --- a/Koha/Exceptions/Library.pm +++ b/Koha/Exceptions/Library.pm @@ -1,5 +1,20 @@ package Koha::Exceptions::Library; +# 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 Exception::Class ( @@ -14,4 +29,20 @@ use Exception::Class ( }, ); +=head1 NAME + +Koha::Exceptions::Library - Base class for libraries exceptions + +=head1 Exceptions + +=head2 Koha::Exceptions::Library + +Generic library exception + +=head2 Koha::Exceptions::Library::BranchcodeNotFound + +Exception to be used when the required library code is not found. + +=cut + 1; diff --git a/Koha/Exceptions/Patron.pm b/Koha/Exceptions/Patron.pm index c409b4e..6443034 100644 --- a/Koha/Exceptions/Patron.pm +++ b/Koha/Exceptions/Patron.pm @@ -1,5 +1,20 @@ package Koha::Exceptions::Patron; +# 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 Exception::Class ( @@ -14,4 +29,20 @@ use Exception::Class ( }, ); +=head1 NAME + +Koha::Exceptions::Patron - Base class for patrons exceptions + +=head1 Exceptions + +=head2 Koha::Exceptions::Patron + +Generic patron exception + +=head2 Koha::Exceptions::Patron::DuplicateObject + +Exception to be used when trying to add duplicated data to the patrons DB. + +=cut + 1; -- 2.1.4