[Koha-patches] [PATCH 4/4] More POD cleanups
Andrew Elwell
andrew.elwell at gmail.com
Sun Jun 6 19:47:14 CEST 2010
Signed-off-by: Andrew Elwell <Andrew.Elwell at gmail.com>
---
C4/Cache.pm | 25 +++++++++-------
C4/Calendar.pm | 56 +++++++++++++++++-------------------
C4/ClassSource.pm | 26 ++++++++--------
C4/Context.pm | 76 +++++++++++++++++++++----------------------------
C4/Debug.pm | 8 +++--
C4/Maintainance.pm | 19 ++++++------
C4/Overdues.pm | 67 +++++++++++++++++++++----------------------
C4/Reports.pm | 8 +----
C4/Ris.pm | 12 +------
C4/SMS.pm | 4 --
C4/Tags.pm | 2 +
C4/VirtualShelves.pm | 42 ++++++++++++---------------
C4/XISBN.pm | 2 +
C4/XSLT.pm | 10 ++++--
14 files changed, 167 insertions(+), 190 deletions(-)
diff --git a/C4/Cache.pm b/C4/Cache.pm
index c07db16..ebe881a 100644
--- a/C4/Cache.pm
+++ b/C4/Cache.pm
@@ -19,22 +19,25 @@ package C4::Cache;
=head1 NAME
- C4::Cache - Handling caching of html and Objects for Koha
+C4::Cache - Handling caching of html and Objects for Koha
=head1 SYNOPSIS
use C4::Cache (cache_type => $cache_type, %params );
-
=head1 DESCRIPTION
- Base class for C4::Cache::X. Subclasses need to provide the following methods
+Base class for C4::Cache::X. Subclasses need to provide the following methods
+
+B<_cache_handle ($params_hr)> - cache handle creator
+
+B<set_in_cache ($key, $value, $expiry)>
- B<_cache_handle ($params_hr)> - cache handle creator
- B<set_in_cache ($key, $value, $expiry)>
- B<get_from_cache ($key)>
- B<clear_from_cache ($key)>
- B<flush_all ()>
+B<get_from_cache ($key)>
+
+B<clear_from_cache ($key)>
+
+B<flush_all ()>
=head1 FUNCTIONS
@@ -64,11 +67,11 @@ sub new {
=head2 EXPORT
- None by default.
+None by default.
=head1 SEE ALSO
-
- C4::Cache::Memcached
+
+C4::Cache::Memcached
=head1 AUTHOR
diff --git a/C4/Calendar.pm b/C4/Calendar.pm
index d919c9d..b5a3436 100644
--- a/C4/Calendar.pm
+++ b/C4/Calendar.pm
@@ -58,15 +58,14 @@ C4::Calendar::Calendar - Koha module dealing with holidays.
=head1 DESCRIPTION
-This package is used to deal with holidays. Through this package, you can set all kind of holidays for the library.
+This package is used to deal with holidays. Through this package, you can set
+all kind of holidays for the library.
=head1 FUNCTIONS
-=over 2
+=head2 new
-=item new
-
- $calendar = C4::Calendar->new(branchcode => $branchcode);
+ $calendar = C4::Calendar->new(branchcode => $branchcode);
Each library branch has its own Calendar.
C<$branchcode> specifies which Calendar you want.
@@ -140,9 +139,9 @@ sub _init {
return $self;
}
-=item get_week_days_holidays
+=head2 get_week_days_holidays
- $week_days_holidays = $calendar->get_week_days_holidays();
+ $week_days_holidays = $calendar->get_week_days_holidays();
Returns a hash reference to week days holidays.
@@ -154,9 +153,9 @@ sub get_week_days_holidays {
return $week_days_holidays;
}
-=item get_day_month_holidays
-
- $day_month_holidays = $calendar->get_day_month_holidays();
+=head2 get_day_month_holidays
+
+ $day_month_holidays = $calendar->get_day_month_holidays();
Returns a hash reference to day month holidays.
@@ -168,8 +167,8 @@ sub get_day_month_holidays {
return $day_month_holidays;
}
-=item get_exception_holidays
-
+=head2 get_exception_holidays
+
$exception_holidays = $calendar->exception_holidays();
Returns a hash reference to exception holidays. This kind of days are those
@@ -184,8 +183,8 @@ sub get_exception_holidays {
return $exception_holidays;
}
-=item get_single_holidays
-
+=head2 get_single_holidays
+
$single_holidays = $calendar->get_single_holidays();
Returns a hash reference to single holidays. This kind of holidays are those which
@@ -199,7 +198,7 @@ sub get_single_holidays {
return $single_holidays;
}
-=item insert_week_day_holiday
+=head2 insert_week_day_holiday
insert_week_day_holiday(weekday => $weekday,
title => $title,
@@ -227,7 +226,7 @@ sub insert_week_day_holiday {
return $self;
}
-=item insert_day_month_holiday
+=head2 insert_day_month_holiday
insert_day_month_holiday(day => $day,
month => $month,
@@ -258,7 +257,7 @@ sub insert_day_month_holiday {
return $self;
}
-=item insert_single_holiday
+=head2 insert_single_holiday
insert_single_holiday(day => $day,
month => $month,
@@ -293,7 +292,7 @@ sub insert_single_holiday {
return $self;
}
-=item insert_exception_holiday
+=head2 insert_exception_holiday
insert_exception_holiday(day => $day,
month => $month,
@@ -328,7 +327,7 @@ sub insert_exception_holiday {
return $self;
}
-=item ModWeekdayholiday
+=head2 ModWeekdayholiday
ModWeekdayholiday(weekday =>$weekday,
title => $title,
@@ -354,7 +353,7 @@ sub ModWeekdayholiday {
return $self;
}
-=item ModDaymonthholiday
+=head2 ModDaymonthholiday
ModDaymonthholiday(day => $day,
month => $month,
@@ -385,7 +384,7 @@ sub ModDaymonthholiday {
return $self;
}
-=item ModSingleholiday
+=head2 ModSingleholiday
ModSingleholiday(day => $day,
month => $month,
@@ -420,7 +419,7 @@ sub ModSingleholiday {
return $self;
}
-=item ModExceptionholiday
+=head2 ModExceptionholiday
ModExceptionholiday(day => $day,
month => $month,
@@ -455,7 +454,7 @@ sub ModExceptionholiday {
return $self;
}
-=item delete_holiday
+=head2 delete_holiday
delete_holiday(weekday => $weekday
day => $day,
@@ -530,10 +529,9 @@ sub delete_holiday {
return $self;
}
-=item isHoliday
-
- $isHoliday = isHoliday($day, $month $year);
+=head2 isHoliday
+ $isHoliday = isHoliday($day, $month $year);
C<$day> Is the day to check whether if is a holiday or not.
@@ -569,7 +567,7 @@ sub isHoliday {
}
-=item addDate
+=head2 addDate
my ($day, $month, $year) = $calendar->addDate($date, $offset)
@@ -606,7 +604,7 @@ sub addDate {
return(C4::Dates->new( sprintf("%04d-%02d-%02d",$year,$month,$day),'iso'));
}
-=item daysBetween
+=head2 daysBetween
my $daysBetween = $calendar->daysBetween($startdate, $enddate)
@@ -641,8 +639,6 @@ sub daysBetween ($$$) {
__END__
-=back
-
=head1 AUTHOR
Koha Physics Library UNLP <matias_veleda at hotmail.com>
diff --git a/C4/ClassSource.pm b/C4/ClassSource.pm
index 2dcaf78..13c2186 100644
--- a/C4/ClassSource.pm
+++ b/C4/ClassSource.pm
@@ -188,22 +188,22 @@ sub DelClassSource {
my $sort_rules = GetClassSortRules();
- Returns reference to hash of references to
- the class sorting rules, keyed on class_sort_rule
-
+Returns reference to hash of references to
+the class sorting rules, keyed on class_sort_rule
+
=head3 Example
-my $sort_rules = GetClassSortRules();
-my @sort_rules = ();
-foreach my $sort_rule (sort keys %$sort_rules) {
- my $sort_rule = $sort_rules->{$sort_rule};
- push @sort_rules,
- {
- rule => $sort_rule->{'class_sort_rule'},
- description => $sort_rule->{'description'},
- sort_routine => $sort_rule->{'sort_routine'}
+ my $sort_rules = GetClassSortRules();
+ my @sort_rules = ();
+ foreach my $sort_rule (sort keys %$sort_rules) {
+ my $sort_rule = $sort_rules->{$sort_rule};
+ push @sort_rules,
+ {
+ rule => $sort_rule->{'class_sort_rule'},
+ description => $sort_rule->{'description'},
+ sort_routine => $sort_rule->{'sort_routine'}
}
-}
+ }
=cut
diff --git a/C4/Context.pm b/C4/Context.pm
index 926c1a5..fa69c76 100644
--- a/C4/Context.pm
+++ b/C4/Context.pm
@@ -137,8 +137,6 @@ environment variable to the pathname of a configuration file to use.
=head1 METHODS
-=over 2
-
=cut
#'
@@ -186,8 +184,9 @@ $context = undef; # Initially, no context is set
@context_stack = (); # Initially, no saved contexts
-=item KOHAVERSION
- returns the kohaversion stored in kohaversion.pl file
+=head2 KOHAVERSION
+
+returns the kohaversion stored in kohaversion.pl file
=cut
@@ -203,9 +202,7 @@ sub KOHAVERSION {
do $cgidir."/kohaversion.pl" || die "NO $cgidir/kohaversion.pl";
return kohaversion();
}
-=item read_config_file
-
-=over 4
+=head2 read_config_file
Reads the specified Koha config file.
@@ -228,8 +225,6 @@ The elements nested within the <server> element:
Returns undef in case of error.
-=back
-
=cut
sub read_config_file { # Pass argument naming config file to read
@@ -270,7 +265,7 @@ sub import {
1;
}
-=item new
+=head2 new
$context = new C4::Context;
$context = new C4::Context("/path/to/koha-conf.xml");
@@ -332,7 +327,7 @@ sub new {
return $self;
}
-=item set_context
+=head2 set_context
$context = new C4::Context;
$context->set_context();
@@ -380,7 +375,7 @@ sub set_context
$context = $new_context;
}
-=item restore_context
+=head2 restore_context
&restore_context;
@@ -406,7 +401,7 @@ sub restore_context
# that was current when this was called?
}
-=item config
+=head2 config
$value = C4::Context->config("config_variable");
@@ -444,7 +439,7 @@ sub ModZebrations {
return _common_config($_[1],'serverinfo');
}
-=item preference
+=head2 preference
$sys_preference = C4::Context->preference('some_variable');
@@ -493,13 +488,13 @@ sub boolean_preference ($) {
return defined($it)? C4::Boolean::true_p($it): undef;
}
-=item clear_syspref_cache
+=head2 clear_syspref_cache
C4::Context->clear_syspref_cache();
- cleans the internal cache of sysprefs. Please call this method if
- you update the systempreferences table. Otherwise, your new changes
- will not be seen by this process.
+cleans the internal cache of sysprefs. Please call this method if
+you update the systempreferences table. Otherwise, your new changes
+will not be seen by this process.
=cut
@@ -507,12 +502,12 @@ sub clear_syspref_cache {
%sysprefs = ();
}
-=item set_preference
+=head2 set_preference
C4::Context->set_preference( $variable, $value );
- This updates a preference's value both in the systempreferences table and in
- the sysprefs cache.
+This updates a preference's value both in the systempreferences table and in
+the sysprefs cache.
=cut
@@ -556,9 +551,9 @@ sub AUTOLOAD
return $self->config($AUTOLOAD);
}
-=item Zconn
+=head2 Zconn
-$Zconn = C4::Context->Zconn
+ $Zconn = C4::Context->Zconn
Returns a connection to the Zebra database for the current
context. If no connection has yet been made, this method
@@ -599,7 +594,7 @@ sub Zconn {
}
}
-=item _new_Zconn
+=head2 _new_Zconn
$context->{"Zconn"} = &_new_Zconn($server,$async);
@@ -711,7 +706,7 @@ sub _new_dbh
return $dbh;
}
-=item dbh
+=head2 dbh
$dbh = C4::Context->dbh;
@@ -742,7 +737,7 @@ sub dbh
return $context->{"dbh"};
}
-=item new_dbh
+=head2 new_dbh
$dbh = C4::Context->new_dbh;
@@ -763,7 +758,7 @@ sub new_dbh
return &_new_dbh();
}
-=item set_dbh
+=head2 set_dbh
$my_dbh = C4::Connect->new_dbh;
C4::Connect->set_dbh($my_dbh);
@@ -794,7 +789,7 @@ sub set_dbh
$context->{"dbh"} = $new_dbh;
}
-=item restore_dbh
+=head2 restore_dbh
C4::Context->restore_dbh;
@@ -821,7 +816,7 @@ sub restore_dbh
# return something, then this function should, too.
}
-=item marcfromkohafield
+=head2 marcfromkohafield
$dbh = C4::Context->marcfromkohafield;
@@ -862,7 +857,7 @@ sub _new_marcfromkohafield
return $marcfromkohafield;
}
-=item stopwords
+=head2 stopwords
$dbh = C4::Context->stopwords;
@@ -903,7 +898,7 @@ sub _new_stopwords
return $stopwordlist;
}
-=item userenv
+=head2 userenv
C4::Context->userenv;
@@ -934,9 +929,10 @@ sub userenv {
}
}
-=item set_userenv
+=head2 set_userenv
- C4::Context->set_userenv($usernum, $userid, $usercnum, $userfirstname, $usersurname, $userbranch, $userflags, $emailaddress);
+ C4::Context->set_userenv($usernum, $userid, $usercnum, $userfirstname,
+ $usersurname, $userbranch, $userflags, $emailaddress);
Establish a hash of user environment variables.
@@ -985,7 +981,7 @@ sub get_shelves_userenv () {
return ($totshelves, $pubshelves, $barshelves);
}
-=item _new_userenv
+=head2 _new_userenv
C4::Context->_new_userenv($session); # FIXME: This calling style is wrong for what looks like an _internal function
@@ -1006,7 +1002,7 @@ sub _new_userenv
$context->{"activeuser"}=$sessionID;
}
-=item _unset_userenv
+=head2 _unset_userenv
C4::Context->_unset_userenv;
@@ -1023,7 +1019,7 @@ sub _unset_userenv
}
-=item get_versions
+=head2 get_versions
C4::Context->get_versions
@@ -1055,18 +1051,12 @@ sub get_versions {
1;
__END__
-=back
-
=head1 ENVIRONMENT
-=over 4
-
-=item C<KOHA_CONF>
+=head2 C<KOHA_CONF>
Specifies the configuration file to read.
-=back
-
=head1 SEE ALSO
XML::Simple
diff --git a/C4/Debug.pm b/C4/Debug.pm
index dad8873..2cbb350 100644
--- a/C4/Debug.pm
+++ b/C4/Debug.pm
@@ -74,8 +74,8 @@ BEGIN {
__END__
=head1 NAME
-
- C4::Debug - Standardized, centralized, exported debug switches.
+
+C4::Debug - Standardized, centralized, exported debug switches.
=head1 SYNOPSIS
@@ -116,7 +116,7 @@ The general purpose debug switch.
=over
=item environmental variable DEBUG or KOHA_DEBUG. In bash, you might do:
-
+
export KOHA_DEBUG=1;
perl t/Auth.t;
@@ -159,6 +159,8 @@ emailing yourself a test message would all be bad actions to tie to $cgi_debug.
=head2 System Preferences
+=cut
+
=head2 Database Debug
Debugging at the database level might be useful. Koha does not currently integrate any such
diff --git a/C4/Maintainance.pm b/C4/Maintainance.pm
index 740163f..570a413 100644
--- a/C4/Maintainance.pm
+++ b/C4/Maintainance.pm
@@ -47,15 +47,13 @@ miscategorized items, etc.
=head1 FUNCTIONS
-=over 2
-
=cut
@ISA = qw(Exporter);
@EXPORT = qw(&listsubjects &shiftgroup &deletedbib &undeletebib
&updatetype &logaction);
-=item listsubjects
+=head2 listsubjects
($count, $results) = &listsubjects($subject, $n, $offset);
@@ -74,6 +72,7 @@ C<&listsubject> returns up to C<$n> items, starting at C<$offset>. If
C<$n> is 0, it will return all matching subjects.
=cut
+
#'
# FIXME - This API is bogus. The way it's currently used, it should
# just return a list of strings.
@@ -101,7 +100,7 @@ sub listsubjects {
return($i,\@results);
}
-=item shiftgroup
+=head2 shiftgroup
&shiftgroup($biblionumber, $biblioitemnumber);
@@ -110,6 +109,7 @@ C<$biblioitemnumber> is the number of the biblioitem to change.
C<$biblionumber> is the biblionumber to associate it with.
=cut
+
#'
sub shiftgroup{
my ($biblionumber,$bi)=@_;
@@ -122,7 +122,7 @@ sub shiftgroup{
$sth->finish;
}
-=item deletedbib
+=head2 deletedbib
($count, $results) = &deletedbib($title);
@@ -134,6 +134,7 @@ the fields of the deletedbiblio table in the Koha database. C<$count>
is the number of elements in C<$results>.
=cut
+
#'
sub deletedbib{
my ($title)=@_;
@@ -150,7 +151,7 @@ sub deletedbib{
return($i,\@results);
}
-=item undeletebib
+=head2 undeletebib
&undeletebib($biblionumber);
@@ -159,6 +160,7 @@ biblionumber in the deletedbiblio table of the Koha database, and
moves its entry to the biblio table.
=cut
+
#'
sub undeletebib{
my ($biblionumber)=@_;
@@ -183,7 +185,7 @@ sub undeletebib{
$sth->finish;
}
-=item updatetype
+=head2 updatetype
&updatetype($biblioitemnumber, $itemtype);
@@ -191,6 +193,7 @@ Changes the type of the item with the given biblioitemnumber to be
C<$itemtype>.
=cut
+
#'
sub updatetype{
my ($bi,$type)=@_;
@@ -205,8 +208,6 @@ END { } # module clean-up code here (global destructor)
1;
__END__
-=back
-
=head1 AUTHOR
Koha Development Team <info at koha.org>
diff --git a/C4/Overdues.pm b/C4/Overdues.pm
index 7ea969c..fc0af93 100644
--- a/C4/Overdues.pm
+++ b/C4/Overdues.pm
@@ -156,7 +156,7 @@ LEFT JOIN biblioitems USING (biblioitemnumber)
=head2 checkoverdues
-($count, $overdueitems) = checkoverdues($borrowernumber);
+ ($count, $overdueitems) = checkoverdues($borrowernumber);
Returns a count and a list of overdueitems for a given borrowernumber
@@ -180,8 +180,9 @@ sub checkoverdues {
=head2 CalcFine
- ($amount, $chargename, $daycount, $daycounttotal) =
- &CalcFine($item, $categorycode, $branch, $days_overdue, $description, $start_date, $end_date );
+ ($amount, $chargename, $daycount, $daycounttotal) = &CalcFine($item,
+ $categorycode, $branch, $days_overdue,
+ $description, $start_date, $end_date );
Calculates the fine for a book.
@@ -277,7 +278,7 @@ sub CalcFine {
=head2 GetSpecialHolidays
-&GetSpecialHolidays($date_dues,$itemnumber);
+ &GetSpecialHolidays($date_dues,$itemnumber);
return number of special days between date of the day and date due
@@ -335,7 +336,7 @@ AND branchcode=?
=head2 GetRepeatableHolidays
-&GetRepeatableHolidays($date_dues, $itemnumber, $difference,);
+ &GetRepeatableHolidays($date_dues, $itemnumber, $difference,);
return number of day closed between date of the day and date due
@@ -373,7 +374,7 @@ sub GetRepeatableHolidays {
=head2 GetWayFromItemnumber
-&Getwdayfromitemnumber($itemnumber);
+ &Getwdayfromitemnumber($itemnumber);
return the different week day from repeatable_holidays table
@@ -401,7 +402,7 @@ sub GetWdayFromItemnumber {
=head2 GetIssuesIteminfo
-&GetIssuesIteminfo($itemnumber);
+ &GetIssuesIteminfo($itemnumber);
return all data from issues about item
@@ -425,7 +426,7 @@ sub GetIssuesIteminfo {
=head2 UpdateFine
- &UpdateFine($itemnumber, $borrowernumber, $amount, $type, $description);
+ &UpdateFine($itemnumber, $borrowernumber, $amount, $type, $description);
(Note: the following is mostly conjecture and guesswork.)
@@ -552,7 +553,7 @@ sub UpdateFine {
=head2 BorType
- $borrower = &BorType($borrowernumber);
+ $borrower = &BorType($borrowernumber);
Looks up a patron by borrower number.
@@ -578,7 +579,7 @@ sub BorType {
=head2 ReplacementCost
- $cost = &ReplacementCost($itemnumber);
+ $cost = &ReplacementCost($itemnumber);
Returns the replacement cost of the item with the given item number.
@@ -599,7 +600,7 @@ sub ReplacementCost {
=head2 GetFine
-$data->{'sum(amountoutstanding)'} = &GetFine($itemnum,$borrowernumber);
+ $data->{'sum(amountoutstanding)'} = &GetFine($itemnum,$borrowernumber);
return the total of fine
@@ -628,7 +629,7 @@ sub GetFine {
FIXME - This sub should be deprecated and removed.
It ignores branch and defaults.
-$data = &GetIssuingRules($itemtype,$categorycode);
+ $data = &GetIssuingRules($itemtype,$categorycode);
Looks up for all issuingrules an item info
@@ -675,7 +676,7 @@ sub ReplacementCost2 {
=head2 GetNextIdNotify
-($result) = &GetNextIdNotify($reference);
+ ($result) = &GetNextIdNotify($reference);
Returns the new file number
@@ -714,7 +715,7 @@ sub GetNextIdNotify {
=head2 NumberNotifyId
-(@notify) = &NumberNotifyId($borrowernumber);
+ (@notify) = &NumberNotifyId($borrowernumber);
Returns amount for all file per borrowers
C<@notify> array contains all file per borrowers
@@ -740,7 +741,7 @@ sub NumberNotifyId{
=head2 AmountNotify
-($totalnotify) = &AmountNotify($notifyid);
+ ($totalnotify) = &AmountNotify($notifyid);
Returns amount for all file per borrowers
C<$notifyid> is the file number
@@ -767,7 +768,7 @@ sub AmountNotify{
=head2 GetNotifyId
-($notify_id) = &GetNotifyId($borrowernumber,$itemnumber);
+ ($notify_id) = &GetNotifyId($borrowernumber,$itemnumber);
Returns the file number per borrower and itemnumber
@@ -797,7 +798,9 @@ sub GetNotifyId {
=head2 CreateItemAccountLine
-() = &CreateItemAccountLine($borrowernumber,$itemnumber,$date,$amount,$description,$accounttype,$amountoutstanding,$timestamp,$notify_id,$level);
+ () = &CreateItemAccountLine($borrowernumber, $itemnumber, $date, $amount,
+ $description, $accounttype, $amountoutstanding,
+ $timestamp, $notify_id, $level);
update the account lines with file number or with file level
@@ -850,7 +853,7 @@ sub CreateItemAccountLine {
=head2 UpdateAccountLines
-() = &UpdateAccountLines($notify_id,$notify_level,$borrowernumber,$itemnumber);
+ () = &UpdateAccountLines($notify_id,$notify_level,$borrowernumber,$itemnumber);
update the account lines with file number or with file level
@@ -893,7 +896,7 @@ sub UpdateAccountLines {
=head2 GetItems
-($items) = &GetItems($itemnumber);
+ ($items) = &GetItems($itemnumber);
Returns the list of all delays from overduerules.
@@ -922,7 +925,7 @@ sub GetItems {
=head2 GetOverdueDelays
-(@delays) = &GetOverdueDelays($categorycode);
+ (@delays) = &GetOverdueDelays($categorycode);
Returns the list of all delays from overduerules.
@@ -945,14 +948,10 @@ sub GetOverdueDelays {
=head2 GetBranchcodesWithOverdueRules
-=over 4
-
-my @branchcodes = C4::Overdues::GetBranchcodesWithOverdueRules()
+ my @branchcodes = C4::Overdues::GetBranchcodesWithOverdueRules()
returns a list of branch codes for branches with overdue rules defined.
-=back
-
=cut
sub GetBranchcodesWithOverdueRules {
@@ -965,7 +964,7 @@ sub GetBranchcodesWithOverdueRules {
=head2 CheckAccountLineLevelInfo
-($exist) = &CheckAccountLineLevelInfo($borrowernumber,$itemnumber,$accounttype,notify_level);
+ ($exist) = &CheckAccountLineLevelInfo($borrowernumber,$itemnumber,$accounttype,notify_level);
Check and Returns the list of all overdue books.
@@ -999,7 +998,7 @@ sub CheckAccountLineLevelInfo {
=head2 GetOverduerules
-($overduerules) = &GetOverduerules($categorycode);
+ ($overduerules) = &GetOverduerules($categorycode);
Returns the value of borrowers (debarred or not) with notify level
@@ -1026,7 +1025,7 @@ sub GetOverduerules {
=head2 CheckBorrowerDebarred
-($debarredstatus) = &CheckBorrowerDebarred($borrowernumber);
+ ($debarredstatus) = &CheckBorrowerDebarred($borrowernumber);
Check if the borrowers is already debarred
@@ -1053,7 +1052,7 @@ sub CheckBorrowerDebarred {
=head2 UpdateBorrowerDebarred
-($borrowerstatut) = &UpdateBorrowerDebarred($borrowernumber);
+ ($borrowerstatut) = &UpdateBorrowerDebarred($borrowernumber);
update status of borrowers in borrowers table (field debarred)
@@ -1076,7 +1075,7 @@ sub UpdateBorrowerDebarred{
=head2 CheckExistantNotifyid
- ($exist) = &CheckExistantNotifyid($borrowernumber,$itemnumber,$accounttype,$notify_id);
+ ($exist) = &CheckExistantNotifyid($borrowernumber,$itemnumber,$accounttype,$notify_id);
Check and Returns the notify id if exist else return 0.
@@ -1103,7 +1102,7 @@ sub CheckExistantNotifyid {
=head2 CheckAccountLineItemInfo
- ($exist) = &CheckAccountLineItemInfo($borrowernumber,$itemnumber,$accounttype,$notify_id);
+ ($exist) = &CheckAccountLineItemInfo($borrowernumber,$itemnumber,$accounttype,$notify_id);
Check and Returns the list of all overdue items from the same file number(notify_id).
@@ -1228,9 +1227,9 @@ sub GetOverduesForBranch {
=head2 AddNotifyLine
-&AddNotifyLine($borrowernumber, $itemnumber, $overduelevel, $method, $notifyId)
+ &AddNotifyLine($borrowernumber, $itemnumber, $overduelevel, $method, $notifyId)
-Creat a line into notify, if the method is phone, the notification_send_date is implemented to
+Create a line into notify, if the method is phone, the notification_send_date is implemented to
=cut
@@ -1258,7 +1257,7 @@ sub AddNotifyLine {
=head2 RemoveNotifyLine
-&RemoveNotifyLine( $borrowernumber, $itemnumber, $notify_date );
+ &RemoveNotifyLine( $borrowernumber, $itemnumber, $notify_date );
Cancel a notification
diff --git a/C4/Reports.pm b/C4/Reports.pm
index ab23f19..3e2f195 100644
--- a/C4/Reports.pm
+++ b/C4/Reports.pm
@@ -36,7 +36,7 @@ BEGIN {
}
=head1 NAME
-
+
C4::Reports - Module for generating reports
=head1 DESCRIPTION
@@ -47,11 +47,7 @@ This module contains functions common to reports.
=head2 GetDelimiterChoices
-=over 4
-
-my $delims = GetDelimiterChoices;
-
-=back
+ my $delims = GetDelimiterChoices;
This will return a list of all the available delimiters.
diff --git a/C4/Ris.pm b/C4/Ris.pm
index c5c4806..fcb5b89 100644
--- a/C4/Ris.pm
+++ b/C4/Ris.pm
@@ -74,22 +74,14 @@ $VERSION = 3.00;
);
-=head2 marc2bibtex - Convert from UNIMARC to RIS
+=head1 marc2bibtex - Convert from UNIMARC to RIS
-=over 4
-
-my ($ris) = marc2ris($record);
+ my ($ris) = marc2ris($record);
Returns a RIS scalar
-=over 2
-
C<$record> - a MARC::Record object
-=back
-
-=back
-
=cut
sub marc2ris {
diff --git a/C4/SMS.pm b/C4/SMS.pm
index 457a662..35d687b 100644
--- a/C4/SMS.pm
+++ b/C4/SMS.pm
@@ -90,10 +90,6 @@ sub send_sms {
=head2 driver
-=over 4
-
-=back
-
=cut
sub driver {
diff --git a/C4/Tags.pm b/C4/Tags.pm
index ecd9758..a260383 100644
--- a/C4/Tags.pm
+++ b/C4/Tags.pm
@@ -581,6 +581,8 @@ More verose debugging messages are sent in the presence of non-zero $ENV{"DEBUG"
=head3 TO DO: Add real perldoc
+=cut
+
=head2 External Dictionary (Ispell) [Recommended]
An external dictionary can be used as a means of "pre-populating" and tracking
diff --git a/C4/VirtualShelves.pm b/C4/VirtualShelves.pm
index e47b4b8..97cd150 100644
--- a/C4/VirtualShelves.pm
+++ b/C4/VirtualShelves.pm
@@ -71,9 +71,7 @@ items to and from virtualshelves.
=head1 FUNCTIONS
-=over 2
-
-=item GetShelves
+=head2 GetShelves
($shelflist, $totshelves) = &GetShelves($mincategory, $row_count, $offset, $owner);
($shelfnumber, $shelfhash) = each %{$shelflist};
@@ -85,7 +83,7 @@ When C<$mincategory> is 2 or 3, supply undef as argument for C<$owner>.
C<$shelflist>is a reference-to-hash. The keys are the virtualshelves numbers (C<$shelfnumber>, above),
and the values (C<$shelfhash>, above) are themselves references-to-hash, with the following keys:
-=over 4
+=over
=item C<$shelfhash-E<gt>{shelfname}>
@@ -137,7 +135,7 @@ sub GetShelves ($$$$) {
return ( \%shelflist, $total );
}
-=item GetShelvesSummary
+=head2 GetShelvesSummary
($shelves, $total) = GetShelvesSummary($mincategory, $row_count, $offset, $owner)
@@ -186,7 +184,7 @@ sub GetShelvesSummary ($$$$) {
# 2|6|Josh Ferraro|51|en_fuego|106
}
-=item GetRecentShelves
+=head2 GetRecentShelves
($shelflist) = GetRecentShelves(1, $limit, $owner)
@@ -214,7 +212,7 @@ sub GetRecentShelves ($$$) {
return ( \@shelflist, $total );
}
-=item GetShelf
+=head2 GetShelf
(shelfnumber,shelfname,owner,category,sortfield) = &GetShelf($shelfnumber);
@@ -237,7 +235,7 @@ sub GetShelf ($) {
return $sth->fetchrow;
}
-=item GetShelfContents
+=head2 GetShelfContents
$itemlist = &GetShelfContents($shelfnumber);
@@ -295,7 +293,7 @@ sub GetShelfContents ($;$$$) {
# or newer, for your version of DBI.
}
-=item AddShelf
+=head2 AddShelf
$shelfnumber = &AddShelf( $shelfname, $owner, $category);
@@ -329,7 +327,7 @@ sub AddShelf {
return ($shelfnumber);
}
-=item AddToShelf
+=head2 AddToShelf
&AddToShelf($biblionumber, $shelfnumber);
@@ -366,12 +364,12 @@ sub AddToShelf {
$sth->execute( $shelfnumber );
}
-=item AddToShelfFromBiblio
-
+=head2 AddToShelfFromBiblio
+
&AddToShelfFromBiblio($biblionumber, $shelfnumber)
- this function allow to add a virtual into the shelf number $shelfnumber
- from biblionumber.
+this function allow to add a virtual into the shelf number $shelfnumber
+from biblionumber.
=cut
@@ -402,7 +400,7 @@ sub AddToShelfFromBiblio {
}
}
-=item ModShelf
+=head2 ModShelf
ModShelf($shelfnumber, $hashref)
@@ -451,7 +449,7 @@ sub ModShelf {
$sth->execute( @bind_params );
}
-=item ShelfPossibleAction
+=head2 ShelfPossibleAction
ShelfPossibleAction($loggedinuser, $shelfnumber, $action);
@@ -484,7 +482,7 @@ sub ShelfPossibleAction {
return 0;
}
-=item DelFromShelf
+=head2 DelFromShelf
&DelFromShelf( $biblionumber, $shelfnumber);
@@ -505,7 +503,7 @@ sub DelFromShelf {
$sth->execute( $shelfnumber, $biblionumber );
}
-=item DelShelf (old version)
+=head2 DelShelf (old version)
($status, $msg) = &DelShelf($shelfnumber);
@@ -516,7 +514,7 @@ Returns a two-element array, where C<$status> is 0 if the operation
was successful, or non-zero otherwise. C<$msg> is "Done" in case of
success, or an error message giving the reason for failure.
-=item DelShelf (current version)
+=head2 DelShelf (current version)
$Number = DelShelf($shelfnumber);
@@ -533,7 +531,7 @@ sub DelShelf {
return $sth->execute(shift);
}
-=item GetBibShelves
+=head2 GetBibShelves
This finds all the public lists that this bib record is in.
@@ -553,7 +551,7 @@ sub GetBibliosShelves {
return $sth->fetchall_arrayref({});
}
-=item RefreshShelvesSummary
+=head2 RefreshShelvesSummary
($total, $pubshelves, $barshelves) = RefreshShelvesSummary($sessionID, $loggedinuser, $row_count);
@@ -628,8 +626,6 @@ sub each_biblionumbers (&$) {
__END__
-=back
-
=head1 AUTHOR
Koha Development Team <info at koha.org>
diff --git a/C4/XISBN.pm b/C4/XISBN.pm
index 17e1394..4f3f488 100644
--- a/C4/XISBN.pm
+++ b/C4/XISBN.pm
@@ -180,6 +180,8 @@ __END__
=head1 NOTES
+=cut
+
=head1 AUTHOR
Joshua Ferraro <jmf at liblime.com>
diff --git a/C4/XSLT.pm b/C4/XSLT.pm
index 6fd93b4..d454981 100644
--- a/C4/XSLT.pm
+++ b/C4/XSLT.pm
@@ -49,9 +49,9 @@ C4::XSLT - Functions for displaying XSLT-generated content
=head1 FUNCTIONS
-=head1 transformMARCXML4XSLT
+=head2 transformMARCXML4XSLT
-=head2 replaces codes with authorized values in a MARC::Record object
+Replaces codes with authorized values in a MARC::Record object
=cut
@@ -88,9 +88,9 @@ sub transformMARCXML4XSLT {
return $record;
}
-=head1 getAuthorisedValues4MARCSubfields
+=head2 getAuthorisedValues4MARCSubfields
-=head2 returns an ref of hash of ref of hash for tag -> letter controled bu authorised values
+Returns a ref of hash of ref of hash for tag -> letter controled by authorised values
=cut
@@ -230,6 +230,8 @@ __END__
=head1 NOTES
+=cut
+
=head1 AUTHOR
Joshua Ferraro <jmf at liblime.com>
--
1.7.0.4
More information about the Koha-patches
mailing list