diff --git a/lib/WebGUI/Attachment.pm b/lib/WebGUI/Attachment.pm index de8f731d4..0c6c142bd 100644 --- a/lib/WebGUI/Attachment.pm +++ b/lib/WebGUI/Attachment.pm @@ -36,19 +36,23 @@ use WebGUI::Utility; Package WebGUI::Attachment +=head1 DESCRIPTION + +Package to manipulate WebGUI Attachments. + =head1 SYNOPSIS use WebGUI::Attachment; $attachment = WebGUI::Attachment->new("file.txt","100","20"); - $html = $attachment->box; - $string = $attachment->getFilename; - $url = $attachment->getIcon; - $string = $attachment->getPath; - $integer = $attachment->getSize; - $url = $attachment->getThumbnail; - $string = $attachment->getType; - $url = $attachment->getURL; - $boolean = $attachment->isImage; + $html = $attachment->box; + $string = $attachment->getFilename; + $url = $attachment->getIcon; + $string = $attachment->getPath; + $integer = $attachment->getSize; + $url = $attachment->getThumbnail; + $string = $attachment->getType; + $url = $attachment->getURL; + $boolean = $attachment->isImage; $attachment->copy("files","10"); $attachment->createThumbnail; $attachment->delete; @@ -58,10 +62,6 @@ Package WebGUI::Attachment $filename = $attachment->save("formImage"); $filename = $attachment->saveFromFilesystem($pathToFile); -=head1 DESCRIPTION - -Package to manipulate WebGUI Attachments. - =head1 METHODS These methods are available from this class: diff --git a/lib/WebGUI/Authentication.pm b/lib/WebGUI/Authentication.pm index 7a0d0d038..38e4768cb 100644 --- a/lib/WebGUI/Authentication.pm +++ b/lib/WebGUI/Authentication.pm @@ -26,6 +26,10 @@ use WebGUI::SQL; Package WebGUI::Authentication +=head1 DESCRIPTION + +This package is used to access WebGUI's pluggable authentication system. + =head1 SYNOPSIS use WebGUI::Authentication; @@ -52,10 +56,6 @@ Package WebGUI::Authentication WebGUI::Authentication::userFormSave(); $error = WebGUI::Authentication::userFormValidate(); -=head1 DESCRIPTION - -This package is used to access WebGUI's pluggable authentication system. - =head1 METHODS These functions are available from this package: diff --git a/lib/WebGUI/DateTime.pm b/lib/WebGUI/DateTime.pm index 938a7be66..63934a2d4 100644 --- a/lib/WebGUI/DateTime.pm +++ b/lib/WebGUI/DateTime.pm @@ -30,28 +30,28 @@ our @EXPORT = qw(&localtime &time &addToTime &addToDate &epochToHuman &epochToSe Package WebGUI::DateTime -=head1 SYNOPSIS - - use WebGUI::DateTime; - $epoch = WebGUI::DateTime::addToDate($epoch, $years, $months, $days); - $epoch = WebGUI::DateTime::addToTime($epoch, $hours, $minutes, $seconds); - ($startEpoch, $endEpoch) = WebGUI::DateTime::dayStartEnd($epoch); - $dateString = WebGUI::DateTime::epochToHuman($epoch, $formatString); - $setString = WebGUI::DateTime::epochToSet($epoch); - $day = WebGUI::DateTime::getDayName($dayInteger); - $month = WebGUI::DateTime::getMonthName($monthInteger); - $epoch = WebGUI::DateTime::humanToEpoch($dateString); - $seconds = WebGUI::DateTime::intervalToSeconds($interval, $units); - @date = WebGUI::DateTime::localtime($epoch); - ($startEpoch, $endEpoch) = WebGUI::DateTime::monthStartEnd($epoch); - ($interval, $units) = WebGUI::DateTime::secondsToInterval($seconds); - $epoch = WebGUI::DateTime::setToEpoch($setString); - $epoch = WebGUI::DateTime::time(); - =head1 DESCRIPTION This package provides easy to use date math functions, which are normally a complete pain. +=head1 SYNOPSIS + + use WebGUI::DateTime; + $epoch = WebGUI::DateTime::addToDate($epoch, $years, $months, $days); + $epoch = WebGUI::DateTime::addToTime($epoch, $hours, $minutes, $seconds); + ($startEpoch, $endEpoch) = WebGUI::DateTime::dayStartEnd($epoch); + $dateString = WebGUI::DateTime::epochToHuman($epoch, $formatString); + $setString = WebGUI::DateTime::epochToSet($epoch); + $day = WebGUI::DateTime::getDayName($dayInteger); + $month = WebGUI::DateTime::getMonthName($monthInteger); + $epoch = WebGUI::DateTime::humanToEpoch($dateString); + $seconds = WebGUI::DateTime::intervalToSeconds($interval, $units); + @date = WebGUI::DateTime::localtime($epoch); + ($startEpoch, $endEpoch) = WebGUI::DateTime::monthStartEnd($epoch); + ($interval, $units) = WebGUI::DateTime::secondsToInterval($seconds); + $epoch = WebGUI::DateTime::setToEpoch($setString); + $epoch = WebGUI::DateTime::time(); + =head1 METHODS These functions are available from this package: diff --git a/lib/WebGUI/Discussion.pm b/lib/WebGUI/Discussion.pm index bec6dc523..33679360b 100644 --- a/lib/WebGUI/Discussion.pm +++ b/lib/WebGUI/Discussion.pm @@ -26,11 +26,11 @@ use WebGUI::URL; use WebGUI::User; -=head1 WebGUI Discussions -This package implements WebGUI's discussion system. However it is outdated and cludgy. We recommend not coding any new systems against this package, but instead wait for the new package that will be created in 6.0.0. +### NOTE: This package implements WebGUI's discussion system. However it is +### outdated and cludgy. We recommend not coding any new systems against this +### package, but instead wait for the new package that will be created in 6.0.0. -=cut #------------------------------------------------------------------- sub _deleteReplyTree { diff --git a/lib/WebGUI/ErrorHandler.pm b/lib/WebGUI/ErrorHandler.pm index 5501df8f5..0a40cab01 100644 --- a/lib/WebGUI/ErrorHandler.pm +++ b/lib/WebGUI/ErrorHandler.pm @@ -20,7 +20,11 @@ use WebGUI::Session; =head1 NAME -WebGUI::ErrorHandler +Package WebGUI::ErrorHandler + +=head1 DESCRIPTION + +This package provides simple but effective error handling and logging for WebGUI. =head1 SYNOPSIS @@ -30,10 +34,6 @@ WebGUI::ErrorHandler WebGUI::ErrorHandler::security(message); WebGUI::ErrorHandler::warn(message); -=head1 DESCRIPTION - -This package provides simple but effective error handling and logging for WebGUI. - =head1 METHODS These functions are available from this package: diff --git a/lib/WebGUI/Form.pm b/lib/WebGUI/Form.pm index 129ce5d04..c35ce294b 100644 --- a/lib/WebGUI/Form.pm +++ b/lib/WebGUI/Form.pm @@ -27,6 +27,10 @@ use WebGUI::URL; Package WebGUI::Form +=head1 DESCRIPTION + +Base forms package. Eliminates some of the normal code work that goes along with creating forms. Used by the HTMLForm package. + =head1 SYNOPSIS use WebGUI::Form; @@ -58,11 +62,7 @@ Package WebGUI::Form $html = WebGUI::Form::yesNo({name=>"happy"}); $html = WebGUI::Form::zipcode({name=>"workZip"}); -=head1 DESCRIPTION - -Base forms package. Eliminates some of the normal code work that goes along with creating forms. Used by the HTMLForm package. - -=head1 FUNCTIONS +=head1 METHODS All of the functions in this package accept the input of a hash reference containing the parameters to populate the form element. These functions are available from this package: diff --git a/lib/WebGUI/HTML.pm b/lib/WebGUI/HTML.pm index 8f4aeb542..6b8c26165 100644 --- a/lib/WebGUI/HTML.pm +++ b/lib/WebGUI/HTML.pm @@ -22,16 +22,16 @@ use WebGUI::Session; Package WebGUI::HTML +=head1 DESCRIPTION + +A package for manipulating and massaging HTML. + =head1 SYNOPSIS use WebGUI::HTML; $html = WebGUI::HTML::cleanSegment($html); $html = WebGUI::HTML::filter($html); -=head1 DESCRIPTION - -A package for manipulating and massaging HTML. - =head1 METHODS These methods are available from this package: diff --git a/lib/WebGUI/HTMLForm.pm b/lib/WebGUI/HTMLForm.pm index 1466e77d4..691db00b4 100644 --- a/lib/WebGUI/HTMLForm.pm +++ b/lib/WebGUI/HTMLForm.pm @@ -27,6 +27,10 @@ use WebGUI::SQL; Package WebGUI::HTMLForm +=head1 DESCRIPTION + +Package that makes HTML forms typed data and significantly reduces the code needed for properties pages in WebGUI. + =head1 SYNOPSIS use WebGUI::HTMLForm; @@ -72,10 +76,6 @@ Alternatively each of these methods can also be called with the tag element synt $f->print; $f->printRowsOnly; -=head1 DESCRIPTION - -Package that makes HTML forms typed data and significantly reduces the code needed for properties pages in WebGUI. - =head1 METHODS These methods are available from this class: @@ -1341,13 +1341,7 @@ sub readOnly { } #------------------------------------------------------------------- - -=head2 select - -Use of this method is depricated. Use selectList instead. - -=cut - +#Use of this method is depricated. Use selectList instead. sub select { my $self = shift; return $self->selectList(@_); @@ -1355,7 +1349,7 @@ sub select { #------------------------------------------------------------------- -=head2 selectList ( name, options [ label, value, size, multiple, extras, subtext, uiLevel ] ) +=head2 selectList ( name, options, [ label, value, size, multiple, extras, subtext, uiLevel ] ) Adds a select list row to this form. diff --git a/lib/WebGUI/Icon.pm b/lib/WebGUI/Icon.pm index cb56b680d..0ed1369e1 100644 --- a/lib/WebGUI/Icon.pm +++ b/lib/WebGUI/Icon.pm @@ -27,6 +27,10 @@ our @EXPORT = qw(&helpIcon &becomeIcon &cutIcon ©Icon &deleteIcon &editIcon Package WebGUI::Icon +=head1 DESCRIPTION + +A package for generating user interface buttons. The subroutines found herein do nothing other than to create a short way of doing much longer repetitive tasks. They simply make the programmer's life easier through fewer keystrokes and less cluttered code. + =head1 SYNOPSIS use WebGUI::Icon; @@ -44,10 +48,6 @@ Package WebGUI::Icon $html = viewIcon('op=something'); $html = wobjectIcon(); -=head1 DESCRIPTION - -A package for generating user interface buttons. The subroutines found herein do nothing other than to create a short way of doing much longer repetitive tasks. They simply make the programmer's life easier through fewer keystrokes and less cluttered code. - =head1 METHODS These subroutines are available from this package: diff --git a/lib/WebGUI/International.pm b/lib/WebGUI/International.pm index 5d27ef8fa..8c0ad3368 100644 --- a/lib/WebGUI/International.pm +++ b/lib/WebGUI/International.pm @@ -24,17 +24,17 @@ my %international; Package WebGUI::International +=head1 DESCRIPTION + +This package provides an interface to the internationalization system. + =head1 SYNOPSIS use WebGUI::International; - $string = WebGUI::International::get($internationalId,$namespace,$languageId); - %languages = WebGUI::International::getLanguages(); + $string = WebGUI::International::get($internationalId,$namespace); + %languages = WebGUI::International::getLanguages(); -=head1 DESCRIPTION - -This package provides an interface to the internationalization system. - -=head1 FUNCTIONS +=head1 METHODS These functions are available from this package: diff --git a/lib/WebGUI/Macro.pm b/lib/WebGUI/Macro.pm index 14e710911..d9de2e39b 100644 --- a/lib/WebGUI/Macro.pm +++ b/lib/WebGUI/Macro.pm @@ -24,18 +24,18 @@ use WebGUI::Session; Package WebGUI::Macro +=head1 DESCRIPTION + +This package is the interface to the WebGUI macro system. + +NOTE: This entire system is likely to be replaced in the near future. It has served WebGUI well since the very beginning but lacks the speed and flexibility that WebGUI users will require in the future. + =head1 SYNOPSIS use WebGUI::Macro; @array = WebGUI::Macro::getParams($parameterString); $html = WebGUI::Macro::process($html); -=head1 DESCRIPTION - -This package is the interface to the WebGUI macro system. - -NOTE: This entire system is likely to be replaced in the near future. It has served WebGUI well since the very beginning but lacks the speed and flexibility that WebGUI users will require in the future. - =head1 METHODS These functions are available from this package: diff --git a/lib/WebGUI/Mail.pm b/lib/WebGUI/Mail.pm index 8eaf20bff..ab9c2a8f7 100644 --- a/lib/WebGUI/Mail.pm +++ b/lib/WebGUI/Mail.pm @@ -24,15 +24,15 @@ use WebGUI::Session; Package WebGUI::Mail +=head1 DESCRIPTION + +This package provides access to use SMTP based email services. + =head1 SYNOPSIS use WebGUI::Mail; WebGUI::Mail::send($to,$subject,$message); -=head1 DESCRIPTION - -This package provides access to use SMTP based email services. - =head1 METHODS These methods are available from this class: diff --git a/lib/WebGUI/MessageLog.pm b/lib/WebGUI/MessageLog.pm index 51edc8349..6d5db03c7 100644 --- a/lib/WebGUI/MessageLog.pm +++ b/lib/WebGUI/MessageLog.pm @@ -31,6 +31,10 @@ use WebGUI::Utility; Package WebGUI::MessageLog +=head1 DESCRIPTION + +This package is WebGUI's notification system. + =head1 SYNOPSIS use WebGUI::MessageLog; @@ -38,10 +42,6 @@ Package WebGUI::MessageLog WebGUI::MessageLog::addInternationalizedEntry($userId,$groupId,$url,$internationalId); WebGUI::MessageLog::completeEntry($messageLogId); -=head1 DESCRIPTION - -This package is WebGUI's notification system. - =head1 METHODS These functions are available from this package: diff --git a/lib/WebGUI/Navigation.pm b/lib/WebGUI/Navigation.pm index 629e4a4e3..f85fe0f91 100644 --- a/lib/WebGUI/Navigation.pm +++ b/lib/WebGUI/Navigation.pm @@ -27,6 +27,10 @@ use WebGUI::URL; Package WebGUI::Navigation +=head1 DESCRIPTION + +A package used to generate navigation. + =head1 SYNOPSIS use WebGUI::Navigation; @@ -35,10 +39,6 @@ Package WebGUI::Navigation $html = WebGUI::Navigation::drawHorizontal($tree); $html = WebGUI::Navigation::drawVertical($tree); -=head1 DESCRIPTION - -A package used to generate navigation. - =head1 METHODS These methods are available from this package: diff --git a/lib/WebGUI/Node.pm b/lib/WebGUI/Node.pm index bb0179e27..dbec45f6b 100644 --- a/lib/WebGUI/Node.pm +++ b/lib/WebGUI/Node.pm @@ -24,6 +24,10 @@ use WebGUI::Session; Package WebGUI::Node +=head1 DESCRIPTION + +Package to manipulate WebGUI storage nodes. The nodes system is a two-tiered filesystem hash that WebGUI uses to keep attachment data separated. There should be no need for anyone other than Plain Black Software to use this package. + =head1 SYNOPSIS use WebGUI::Node; @@ -34,10 +38,6 @@ Package WebGUI::Node $node->getPath; $node->getURL; -=head1 DESCRIPTION - -Package to manipulate WebGUI storage nodes. The nodes system is a two-tiered filesystem hash that WebGUI uses to keep attachment data separated. There should be no need for anyone other than Plain Black Software to use this package. - =head1 METHODS These methods are available from this package: diff --git a/lib/WebGUI/Page.pm b/lib/WebGUI/Page.pm index a86a702e4..b198956d3 100644 --- a/lib/WebGUI/Page.pm +++ b/lib/WebGUI/Page.pm @@ -30,6 +30,10 @@ use WebGUI::Template; Package WebGUI::Page +=head1 DESCRIPTION + +This package provides utility functions for WebGUI's page system. + =head1 SYNOPSIS use WebGUI::Page; @@ -40,10 +44,6 @@ Package WebGUI::Page $hashRef = WebGUI::Page::getTemplatePositions($templateId); $url = WebGUI::Page::makeUnique($url,$pageId); -=head1 DESCRIPTION - -This package provides utility functions for WebGUI's page system. - =head1 METHODS These functions are available from this package: diff --git a/lib/WebGUI/Paginator.pm b/lib/WebGUI/Paginator.pm index b2a3444dc..f5ad4b285 100644 --- a/lib/WebGUI/Paginator.pm +++ b/lib/WebGUI/Paginator.pm @@ -23,6 +23,10 @@ use WebGUI::URL; Package WebGUI::Paginator +=head1 DESCRIPTION + +Package that paginates rows of arbitrary data for display on the web. + =head1 SYNOPSIS use WebGUI::Paginator; @@ -43,10 +47,6 @@ Package WebGUI::Paginator $html = $p->getPageLinks; $html = $p->getPreviousPageLink; -=head1 DESCRIPTION - -Package that paginates rows of arbitrary data for display on the web. - =head1 METHODS These methods are available from this class: diff --git a/lib/WebGUI/Privilege.pm b/lib/WebGUI/Privilege.pm index c7f66538d..33336573c 100644 --- a/lib/WebGUI/Privilege.pm +++ b/lib/WebGUI/Privilege.pm @@ -26,6 +26,10 @@ use WebGUI::URL; Package WebGUI::Privilege +=head1 DESCRIPTION + +This package provides access to the WebGUI security system and security messages. + =head1 SYNOPSIS use WebGUI::Privilege; @@ -38,12 +42,7 @@ Package WebGUI::Privilege $html = WebGUI::Privilege::notMember(); $html = WebGUI::Privilege::vitalComponent(); - -=head1 DESCRIPTION - -This package provides access to the WebGUI security system and security messages. - -=head1 FUNCTIONS +=head1 METHODS These functions are available from this package: diff --git a/lib/WebGUI/Profile.pm b/lib/WebGUI/Profile.pm index 2c49c0ab5..16af164da 100644 --- a/lib/WebGUI/Profile.pm +++ b/lib/WebGUI/Profile.pm @@ -23,15 +23,15 @@ use WebGUI::URL; Package WebGUI::Profile +=head1 DESCRIPTION + +Package that allows getting and setting of user profile information. + =head1 SYNOPSIS use WebGUI::Profile; $p = WebGUI::Profile->new(39); -=head1 DESCRIPTION - -Package that allows getting and setting of user profile information. - =head1 METHODS These methods are available from this class: diff --git a/lib/WebGUI/SQL.pm b/lib/WebGUI/SQL.pm index 5c47aecc5..9e81bc8fb 100644 --- a/lib/WebGUI/SQL.pm +++ b/lib/WebGUI/SQL.pm @@ -29,6 +29,10 @@ our @EXPORT = qw("e &getNextId); Package WebGUI::SQL +=head1 DESCRIPTION + +Package for interfacing with SQL databases. This package implements Perl DBI functionality in a less code-intensive manner and adds some extra functionality. + =head1 SYNOPSIS use WebGUI::SQL; @@ -56,10 +60,6 @@ Package WebGUI::SQL $id = getNextId("wobjectId"); $string = quote($string); -=head1 DESCRIPTION - -Package for interfacing with SQL databases. This package implements Perl DBI functionality in a less code-intensive manner and adds some extra functionality. - =head1 METHODS These methods are available from this package: diff --git a/lib/WebGUI/Search.pm b/lib/WebGUI/Search.pm index d69d60876..28f7b6d43 100644 --- a/lib/WebGUI/Search.pm +++ b/lib/WebGUI/Search.pm @@ -27,16 +27,16 @@ use WebGUI::SQL; Package WebGUI::Search +=head1 DESCRIPTION + +A package built to take the hassle out of creating advanced search functionality in WebGUI applications. + =head1 SYNOPSIS use WebGUI::Search; $sql = WebGUI::Search::buildConstraints(\@fields); $html = WebGUI::Search::form(\%hidden); -=head1 DESCRIPTION - -A package built to take the hassle out of creating advanced search functionality in WebGUI applications. - =head1 METHODS These methods are available from this package: diff --git a/lib/WebGUI/Session.pm b/lib/WebGUI/Session.pm index df2ecc885..0ba045ff7 100644 --- a/lib/WebGUI/Session.pm +++ b/lib/WebGUI/Session.pm @@ -35,6 +35,14 @@ tie %session, 'Tie::CPHash'; Package WebGUI::Session +=head1 DESCRIPTION + +This package is the heart and lifeblood of WebGUI. Without it WebGUI could not exist. By using this package a package gains access to WebGUI's $session variable which contains everything WebGUI needs to know to operate. + +NOTE: It is important to distinguish the difference between a WebGUI session and a user session. A user session is attached to a WebGUI session. A WebGUI session is all of the basic data the WebGUI needs to operate. + +TIP: The $session variable is a case-insensitive hash. The contents of the has vary, but can be seen by adding debug=1 to the end of any WebGUI URL while logged in as an admin user. + =head1 SYNOPSIS use WebGUI::Session; @@ -51,14 +59,6 @@ Package WebGUI::Session WebGUI::Session::setScratch($name,$value); WebGUI::Session::start($userId); -=head1 DESCRIPTION - -This package is the heart and lifeblood of WebGUI. Without it WebGUI could not exist. By using this package a package gains access to WebGUI's $session variable which contains everything WebGUI needs to know to operate. - -NOTE: It is important to distinguish the difference between a WebGUI session and a user session. A user session is attached to a WebGUI session. A WebGUI session is all of the basic data the WebGUI needs to operate. - -TIP: The $session variable is a case-insensitive hash. The contents of the has vary, but can be seen by adding debug=1 to the end of any WebGUI URL while logged in as an admin user. - =head1 METHODS These subroutines are available from this package: diff --git a/lib/WebGUI/Style.pm b/lib/WebGUI/Style.pm index 57a13a69c..306bf180a 100644 --- a/lib/WebGUI/Style.pm +++ b/lib/WebGUI/Style.pm @@ -27,15 +27,15 @@ use WebGUI::Template; Package WebGUI::Style +=head1 DESCRIPTION + +This package contains utility methods for WebGUI's style system. + =head1 SYNOPSIS use WebGUI::Style; $style = WebGUI::Style::get(); -=head1 DESCRIPTION - -This package contains utility methods for WebGUI's style system. - =head1 METHODS These subroutines are available from this package: diff --git a/lib/WebGUI/Template.pm b/lib/WebGUI/Template.pm index 662dc6a98..0cc77b12b 100644 --- a/lib/WebGUI/Template.pm +++ b/lib/WebGUI/Template.pm @@ -28,6 +28,10 @@ use WebGUI::SQL; Package WebGUI::Template +=head1 DESCRIPTION + +This package contains utility methods for WebGUI's template system. + =head1 SYNOPSIS use WebGUI::Template; @@ -35,11 +39,6 @@ Package WebGUI::Template $hashRef = WebGUI::Template::getList($namespace); $html = WebGUI::Template::process($template); - -=head1 DESCRIPTION - -This package contains utility methods for WebGUI's template system. - =head1 METHODS These subroutines are available from this package: diff --git a/lib/WebGUI/URL.pm b/lib/WebGUI/URL.pm index 757d95fb9..369aff911 100644 --- a/lib/WebGUI/URL.pm +++ b/lib/WebGUI/URL.pm @@ -25,6 +25,10 @@ use WebGUI::Utility; Package WebGUI::URL +=head1 DESCRIPTION + +This package provides URL writing functionality. It is important that all WebGUI URLs be written using these methods so that they can contain any extra information that WebGUI needs to add to the URLs in order to function properly. + =head1 SYNOPSIS use WebGUI::URL; @@ -36,10 +40,6 @@ Package WebGUI::URL $string = WebGUI::URL::unescape($string); $url = WebGUI::URL::urlize($string); -=head1 DESCRIPTION - -This package provides URL writing functionality. It is important that all WebGUI URLs be written using these methods so that they can contain any extra information that WebGUI needs to add to the URLs in order to function properly. - =head1 METHODS These subroutines are available from this package: diff --git a/lib/WebGUI/User.pm b/lib/WebGUI/User.pm index d10a35edf..65fc42b00 100644 --- a/lib/WebGUI/User.pm +++ b/lib/WebGUI/User.pm @@ -26,6 +26,10 @@ use WebGUI::Authentication; Package WebGUI::User +=head1 DESCRIPTION + +This package provides an object-oriented way of managing WebGUI users as well as getting/setting a users's profile data. + =head1 SYNOPSIS use WebGUI::User; @@ -43,10 +47,6 @@ Package WebGUI::User $u->deleteFromGroups(\@arr); $u->delete; -=head1 DESCRIPTION - -This package provides an object-oriented way of managing WebGUI users as well as getting/setting a users's profile data. - =head1 METHODS These methods are available from this class: diff --git a/lib/WebGUI/Utility.pm b/lib/WebGUI/Utility.pm index a0fc490b5..0ec7cd227 100644 --- a/lib/WebGUI/Utility.pm +++ b/lib/WebGUI/Utility.pm @@ -29,6 +29,10 @@ our @EXPORT = qw(&makeTabSafe &makeArrayTabSafe &randomizeHash &commify &randomi Package WebGUI::Utility +=head1 DESCRIPTION + +This package provides miscellaneous but useful utilities to the WebGUI programmer. + =head1 SYNOPSIS use WebGUI::Utility; @@ -44,11 +48,6 @@ Package WebGUI::Utility $hashRef = sortHash(\%hash); $hashRef = sortHashDescending(\%hash); - -=head1 DESCRIPTION - -This package provides miscellaneous but useful utilities to the WebGUI programmer. - =head1 METHODS These subroutines are available from this package: diff --git a/lib/WebGUI/Wobject.pm b/lib/WebGUI/Wobject.pm index a5f4a1434..e95dd2a8d 100644 --- a/lib/WebGUI/Wobject.pm +++ b/lib/WebGUI/Wobject.pm @@ -31,12 +31,14 @@ use WebGUI::Template; use WebGUI::URL; use WebGUI::Utility; - - =head1 NAME Package WebGUI::Wobject +=head1 DESCRIPTION + +An abstract class for all other wobjects to extend. + =head1 SYNOPSIS use WebGUI::Wobject; @@ -44,10 +46,6 @@ Package WebGUI::Wobject See the subclasses in lib/WebGUI/Wobjects for details. -=head1 DESCRIPTION - -An abstract class for all other wobjects to extend. - =head1 METHODS These methods are available from this class: