From 04217e67e0d365245828e8826c84f81bd19335aa Mon Sep 17 00:00:00 2001 From: Colin Kuskie Date: Wed, 1 Apr 2009 04:10:14 +0000 Subject: [PATCH] Fix POD typos and add POD to get to 100% POD coverage. --- lib/WebGUI/Asset/File/ZipArchive.pm | 20 ++++++++++++++++++-- lib/WebGUI/Asset/MatrixListing.pm | 2 +- lib/WebGUI/Operation/Admin.pm | 2 +- lib/WebGUI/Operation/VersionTag.pm | 11 +++++++++++ lib/WebGUI/Shop/Pay.pm | 12 ++++++++++++ 5 files changed, 43 insertions(+), 4 deletions(-) diff --git a/lib/WebGUI/Asset/File/ZipArchive.pm b/lib/WebGUI/Asset/File/ZipArchive.pm index cc1303a07..8f8de4c22 100644 --- a/lib/WebGUI/Asset/File/ZipArchive.pm +++ b/lib/WebGUI/Asset/File/ZipArchive.pm @@ -45,6 +45,22 @@ These methods are available from this class: =cut #------------------------------------------------------------------- + +=head2 unzip ( $storage, $filename ) + +Uncompress and/or expand an archive, based on the file extension of the filename. +Returns 1 if the unzip was successful. Returns 0 if there were problems. + +=head3 $storage + +A WebGUI::Storage object containing the archive. + +=head3 $filename + +The filename of the archive. + +=cut + sub unzip { my $self = shift; my $storage = shift; @@ -78,8 +94,8 @@ sub unzip { =head2 addRevision ( ) - This method exists for demonstration purposes only. The superclass - handles revisions to ZipArchive Assets. +This method exists for demonstration purposes only. The superclass +handles revisions to ZipArchive Assets. =cut diff --git a/lib/WebGUI/Asset/MatrixListing.pm b/lib/WebGUI/Asset/MatrixListing.pm index 8d9698dfc..9a14d0111 100644 --- a/lib/WebGUI/Asset/MatrixListing.pm +++ b/lib/WebGUI/Asset/MatrixListing.pm @@ -574,7 +574,7 @@ sub setRatings { #------------------------------------------------------------------- -=head2 view ( hasRated ) +=head2 updateScore ( ) Updates the score of a MatrixListing. diff --git a/lib/WebGUI/Operation/Admin.pm b/lib/WebGUI/Operation/Admin.pm index 2fee67391..a42b1fb8b 100644 --- a/lib/WebGUI/Operation/Admin.pm +++ b/lib/WebGUI/Operation/Admin.pm @@ -58,7 +58,7 @@ sub www_switchOffAdmin { #------------------------------------------------------------------- -=head2 www_adminConsole ( ) +=head2 www_switchOnAdmin ( ) If the current user is in the Turn On Admin Group, then allow them to turn on Admin mode. diff --git a/lib/WebGUI/Operation/VersionTag.pm b/lib/WebGUI/Operation/VersionTag.pm index 5bdf71d1d..bc0a95341 100644 --- a/lib/WebGUI/Operation/VersionTag.pm +++ b/lib/WebGUI/Operation/VersionTag.pm @@ -451,6 +451,17 @@ sub www_commitVersionTagConfirm { } #------------------------------------------------------------------- + +=head2 www_leaveVersionTag ( session ) + +Clears the current working version tag, and returns the user to www_manageVersions. + +=head3 session + +A reference to the current session. + +=cut + sub www_leaveVersionTag { my $session = shift; WebGUI::VersionTag->getWorking($session)->clearWorking; diff --git a/lib/WebGUI/Shop/Pay.pm b/lib/WebGUI/Shop/Pay.pm index 0705b3cea..a34931ee7 100644 --- a/lib/WebGUI/Shop/Pay.pm +++ b/lib/WebGUI/Shop/Pay.pm @@ -226,6 +226,18 @@ Returns a reference to the current session. =cut #------------------------------------------------------------------- + +=head2 www_addPaymentGateway ( $session ) + +Add a new payment gateway, based on the className form variable. It will throw +an error, WebGUI::Error::InvalidParram if no className is passed. + +=head3 $session + +A reference to the current session object. + +=cut + sub www_addPaymentGateway { my $self = shift; my $session = $self->session;