Add stub POD to these modules to get them to pass the POD test.

This commit is contained in:
Colin Kuskie 2009-01-26 23:35:51 +00:00
parent 3a172a9e3d
commit 787697adce
8 changed files with 398 additions and 6 deletions

View file

@ -35,6 +35,11 @@ use WebGUI::Asset::RSSFromParent;
=cut
#-------------------------------------------------------------------
=head2 definition
=cut
sub definition {
my $class = shift;
my $session = shift;
@ -58,6 +63,11 @@ sub definition {
}
#-------------------------------------------------------------------
=head2 update
=cut
sub update {
# Re-force isHidden to 1 on each update; these should always be hidden.
my $self = shift;
@ -66,6 +76,11 @@ sub update {
}
#------------------------------------------------
=head2 _escapeXml
=cut
sub _escapeXml {
my $text = shift;
return $text unless (ref $text eq "");
@ -73,6 +88,11 @@ sub _escapeXml {
}
#------------------------------------------------
=head2 _tlsOfAsset
=cut
sub _tlsOfAsset {
my $self = shift;
my $asset = shift;
@ -86,12 +106,27 @@ sub _tlsOfAsset {
}
#------------------------------------------------
=head2 {
=cut
sub isValidRssItem { 0 }
#------------------------------------------------
=head2 displayInFolder2
=cut
sub displayInFolder2 { 0 }
#------------------------------------------------
=head2 www_view
=cut
sub www_view {
my $self = shift;
return '' unless $self->session->asset->getId eq $self->getId;

View file

@ -20,6 +20,11 @@ use HTML::Template::Expr;
#-------------------------------------------------------------------
=head2 _rewriteVars
=cut
sub _rewriteVars { # replace dots with underscrores in keys (except in keys that aren't usable as variables (URLs etc.))
my $vars = shift;
my $newVars = {};

View file

@ -22,6 +22,11 @@ use POSIX qw(ceil floor);
use base 'WebGUI::Asset::Wobject';
#-------------------------------------------------------------------
=head2 _addDaysForMonth
=cut
sub _addDaysForMonth {
my $self = shift;
my $dt = $self->session->datetime;
@ -53,6 +58,11 @@ sub _addDaysForMonth {
}
#-------------------------------------------------------------------
=head2 _clobberImproperDependants
=cut
sub _clobberImproperDependants {
my $self = shift;
my $projectId = shift;
@ -62,6 +72,11 @@ sub _clobberImproperDependants {
}
#-------------------------------------------------------------------
=head2 _doGanttTaskResourceDisplay
=cut
sub _doGanttTaskResourceDisplay {
my $self = shift;
my $hash = shift;
@ -96,6 +111,11 @@ sub _doGanttTaskResourceDisplay {
}
#-------------------------------------------------------------------
=head2 _getDurationUnitHash
=cut
sub _getDurationUnitHash {
my $self = shift;
my ($session,$privilege,$form,$db,$dt,$i18n,$user) = $self->setSessionVars;
@ -107,6 +127,11 @@ sub _getDurationUnitHash {
}
#-------------------------------------------------------------------
=head2 _getDurationUnitHashAbbrev
=cut
sub _getDurationUnitHashAbbrev {
my $self = shift;
my ($session,$privilege,$form,$db,$dt,$i18n,$user) = $self->setSessionVars;
@ -118,6 +143,11 @@ sub _getDurationUnitHashAbbrev {
}
#-------------------------------------------------------------------
=head2 _groupSearchQuery
=cut
sub _groupSearchQuery {
my $self = shift;
my $exclude = shift;
@ -136,6 +166,11 @@ SQL
}
#-------------------------------------------------------------------
=head2 _htmlOfResourceList
=cut
sub _htmlOfResourceList {
my $self = shift;
my %args = %{+shift};
@ -188,6 +223,11 @@ sub _htmlOfResourceList {
}
#-------------------------------------------------------------------
=head2 _innerHtmlOfResources
=cut
sub _innerHtmlOfResources {
my $self = shift;
my @resources = @_;
@ -196,6 +236,11 @@ sub _innerHtmlOfResources {
}
#-------------------------------------------------------------------
=head2 _resourceListOfTask
=cut
sub _resourceListOfTask {
my $self = shift;
my $taskId = shift;
@ -219,6 +264,11 @@ sub _resourceListOfTask {
}
#-------------------------------------------------------------------
=head2 _resourceSearchPopup
=cut
sub _resourceSearchPopup {
my $self = shift;
my %args = @_;
@ -260,6 +310,11 @@ sub _resourceSearchPopup {
}
#-------------------------------------------------------------------
=head2 _userSearchQuery
=cut
sub _userSearchQuery {
my $self = shift;
my $exclude = shift;
@ -280,6 +335,11 @@ SQL
}
#-------------------------------------------------------------------
=head2 _updateDependantDates
=cut
sub _updateDependantDates {
my $self = shift;
my $db = $self->session->db;
@ -335,6 +395,11 @@ sub _updateDependantDates {
}
#-------------------------------------------------------------------
=head2 _userCanManageProject
=cut
sub _userCanManageProject {
my $self = shift;
my $user = shift;
@ -344,6 +409,11 @@ sub _userCanManageProject {
}
#-------------------------------------------------------------------
=head2 _userCanManageProjectList
=cut
sub _userCanManageProjectList {
my $self = shift;
my $user = shift;
@ -351,6 +421,11 @@ sub _userCanManageProjectList {
}
#-------------------------------------------------------------------
=head2 _userCanObserveProject
=cut
sub _userCanObserveProject {
my $self = shift;
my $user = shift;
@ -360,6 +435,11 @@ sub _userCanObserveProject {
}
#-------------------------------------------------------------------
=head2 definition
=cut
sub definition {
my $class = shift;
my $session = shift;
@ -439,6 +519,11 @@ sub definition {
#-------------------------------------------------------------------
#API method called by Time Tracker to return the instance of the PM wobject which this project blongs
=head2 getProjectInstance
=cut
sub getProjectInstance {
my $class = shift;
my $session = shift;
@ -454,6 +539,11 @@ sub getProjectInstance {
#-------------------------------------------------------------------
#API method called by Time Tracker to return all projects in all assets for which the user passed in has tasks assigned
=head2 getProjectList
=cut
sub getProjectList {
my $self = shift;
my $db = $self->session->db;
@ -474,6 +564,11 @@ SQL
#-------------------------------------------------------------------
#API method called by Time Tracker to return all tasks for the projectId passed in
=head2 getTaskList
=cut
sub getTaskList {
my $self = shift;
my $db = $self->session->db;
@ -494,6 +589,11 @@ SQL
}
#-------------------------------------------------------------------
=head2 i18n
=cut
sub i18n {
my $self = shift;
my $session = $self->session;
@ -507,6 +607,11 @@ sub i18n {
}
#-------------------------------------------------------------------
=head2 prepareView
=cut
sub prepareView {
my $self = shift;
$self->SUPER::prepareView();
@ -516,6 +621,11 @@ sub prepareView {
}
#-------------------------------------------------------------------
=head2 processErrors
=cut
sub processErrors {
my $self = shift;
my $errors = "";
@ -531,6 +641,11 @@ sub processErrors {
#-------------------------------------------------------------------
=head2 purge
=cut
sub purge {
my $self = shift;
#purge your wobject-specific data here. This does not include fields
@ -539,6 +654,11 @@ sub purge {
}
#-------------------------------------------------------------------
=head2 setSessionVars
=cut
sub setSessionVars {
my $self = shift;
my $session = $self->session;
@ -556,6 +676,11 @@ sub setSessionVars {
#-------------------------------------------------------------------
# API method called by Time Tracker to set percent complete field in the task and update the project cache
=head2 updateProjectTask
=cut
sub updateProjectTask {
my $self = shift;
my $db = $self->session->db;
@ -594,6 +719,11 @@ sub updateProjectTask {
}
#-------------------------------------------------------------------
=head2 updateProject
=cut
sub updateProject {
my $self = shift;
my ($session,$privilege,$form,$db,$dt,$i18n,$user) = $self->setSessionVars;
@ -614,6 +744,11 @@ sub updateProject {
#-------------------------------------------------------------------
=head2 view
=cut
sub view {
my $self = shift;
my $var = $self->get;
@ -681,6 +816,11 @@ sub view {
}
#-------------------------------------------------------------------
=head2 www_deleteProject
=cut
sub www_deleteProject {
my $self = shift;
#Set Method Helpers
@ -700,6 +840,11 @@ sub www_deleteProject {
}
#-------------------------------------------------------------------
=head2 www_deleteTask
=cut
sub www_deleteTask {
my $self = shift;
#Set Method Helpers
@ -743,6 +888,11 @@ sub www_deleteTask {
}
#-------------------------------------------------------------------
=head2 www_drawGanttChart
=cut
sub www_drawGanttChart {
my $self = shift;
my $var = {};
@ -988,6 +1138,11 @@ sub www_drawGanttChart {
}
#-------------------------------------------------------------------
=head2 www_editProject
=cut
sub www_editProject {
my $self = shift;
#Set Method Helpers
@ -1101,6 +1256,11 @@ sub www_editProject {
}
#-------------------------------------------------------------------
=head2 www_editProjectSave
=cut
sub www_editProjectSave {
my $self = shift;
#Set Method Helpers
@ -1166,6 +1326,11 @@ sub www_editProjectSave {
#-------------------------------------------------------------------
=head2 www_editTask
=cut
sub www_editTask {
my $self = shift;
my $var = {};
@ -1362,6 +1527,11 @@ sub www_editTask {
}
#-------------------------------------------------------------------
=head2 www_editTaskSave
=cut
sub www_editTaskSave {
my $self = shift;
my $var = {};
@ -1452,6 +1622,11 @@ sub www_editTaskSave {
}
#-------------------------------------------------------------------
=head2 www_groupSearchPopup
=cut
sub www_groupSearchPopup {
my $self = shift;
my %args = (func => 'groupSearchPopup',
@ -1462,6 +1637,11 @@ sub www_groupSearchPopup {
}
#-------------------------------------------------------------------
=head2 www_innerHtmlOfResources
=cut
sub www_innerHtmlOfResources {
my $self = shift;
my @resources = map {
@ -1472,6 +1652,11 @@ sub www_innerHtmlOfResources {
}
#-------------------------------------------------------------------
=head2 www_saveExistingTasks
=cut
sub www_saveExistingTasks {
my $self = shift;
my $var = {};
@ -1515,6 +1700,11 @@ sub www_saveExistingTasks {
}
#-------------------------------------------------------------------
=head2 www_userSearchPopup
=cut
sub www_userSearchPopup {
my $self = shift;
@ -1526,6 +1716,11 @@ sub www_userSearchPopup {
}
#-------------------------------------------------------------------
=head2 www_viewProject
=cut
sub www_viewProject {
my $self = shift;
my $var = {};

View file

@ -22,6 +22,11 @@ use base 'WebGUI::Asset::Wobject';
use WebGUI::Asset::Wobject::ProjectManager;
#-------------------------------------------------------------------
=head2 definition
=cut
sub definition {
my $class = shift;
my $session = shift;
@ -82,6 +87,11 @@ sub definition {
#-------------------------------------------------------------------
=head2 prepareView
=cut
sub prepareView {
my $self = shift;
$self->SUPER::prepareView();
@ -96,6 +106,11 @@ sub prepareView {
}
#-------------------------------------------------------------------
=head2 processErrors
=cut
sub processErrors {
my $self = shift;
my $errors = "";
@ -111,6 +126,11 @@ sub processErrors {
#-------------------------------------------------------------------
=head2 purge
=cut
sub purge {
my $self = shift;
#purge your wobject-specific data here. This does not include fields
@ -119,6 +139,11 @@ sub purge {
}
#-------------------------------------------------------------------
=head2 getDaysInWeek
=cut
sub getDaysInWeek {
my $self = shift;
my $week = $_[0];
@ -142,6 +167,11 @@ sub getDaysInWeek {
}
#-------------------------------------------------------------------
=head2 getSessionVars
=cut
sub getSessionVars {
my $self = shift;
my @vars = @_;
@ -159,6 +189,11 @@ sub getSessionVars {
#-------------------------------------------------------------------
=head2 view
=cut
sub view {
my $self = shift;
my $var = $self->get;
@ -197,6 +232,11 @@ sub view {
}
#-------------------------------------------------------------------
=head2 www_editTimeEntrySave
=cut
sub www_editTimeEntrySave {
my $self = shift;
my ($session,$privilege,$form,$db,$user,$eh,$dt) = $self->getSessionVars("privilege","form","db","user","errorHandler","datetime");
@ -271,6 +311,11 @@ sub www_editTimeEntrySave {
}
#-------------------------------------------------------------------
=head2 www_deleteProject
=cut
sub www_deleteProject {
my $self = shift;
my ($session,$privilege,$form,$db,$user,$eh,$config) = $self->getSessionVars("privilege","form","db","user","errorHandler","config");
@ -293,6 +338,11 @@ sub www_deleteProject {
}
#-------------------------------------------------------------------
=head2 www_editProject
=cut
sub www_editProject {
my $self = shift;
my ($session,$privilege,$form,$db,$user,$eh,$config) = $self->getSessionVars("privilege","form","db","user","errorHandler","config");
@ -393,6 +443,11 @@ sub www_editProject {
}
#-------------------------------------------------------------------
=head2 www_editProjectSave
=cut
sub www_editProjectSave {
my $self = shift;
my ($session,$privilege,$form,$db,$dt,$user,$eh) = $self->getSessionVars("privilege","form","db","datetime","user","errorHandler");
@ -453,6 +508,11 @@ sub www_editProjectSave {
}
#-------------------------------------------------------------------
=head2 www_manageProjects
=cut
sub www_manageProjects {
my $self = shift;
my ($session,$privilege,$form,$db,$dt,$user,$eh,$config) = $self->getSessionVars("privilege","form","db","datetime","user","errorHandler","config");
@ -574,6 +634,11 @@ sub www_manageProjects {
}
#-------------------------------------------------------------------
=head2 www_buildTimeTable
=cut
sub www_buildTimeTable {
my $self = shift;
my $viewVar = $_[0];
@ -738,6 +803,11 @@ sub www_buildTimeTable {
}
#-------------------------------------------------------------------
=head2 _buildRow
=cut
sub _buildRow {
my $self = shift;
my ($session,$dt,$eh,$form,$db,$user) = $self->getSessionVars("datetime","errorHandler","form","db","user");

View file

@ -4,6 +4,11 @@ use strict;
use WebGUI::Storage;
#-------------------------------------------------------------------
=head2 canDelete
=cut
sub canDelete {
my $self = shift;
@ -12,6 +17,11 @@ sub canDelete {
}
#-------------------------------------------------------------------
=head2 delete
=cut
sub delete {
my $self = shift;
@ -26,6 +36,11 @@ sub delete {
}
#-------------------------------------------------------------------
=head2 getId
=cut
sub getId {
my $self = shift;
@ -33,6 +48,11 @@ sub getId {
}
#-------------------------------------------------------------------
=head2 getFontList
=cut
sub getFontList {
my $self = shift;
my $session = shift || $self->session;
@ -41,6 +61,11 @@ sub getFontList {
}
#-------------------------------------------------------------------
=head2 getFile
=cut
sub getFile {
my $self = shift;
@ -52,6 +77,11 @@ sub getFile {
}
#-------------------------------------------------------------------
=head2 getFilename
=cut
sub getFilename {
my $self = shift;
@ -59,6 +89,11 @@ sub getFilename {
}
#-------------------------------------------------------------------
=head2 getName
=cut
sub getName {
my $self = shift;
@ -66,6 +101,11 @@ sub getName {
}
#-------------------------------------------------------------------
=head2 getStorageId
=cut
sub getStorageId {
my $self = shift;
@ -73,6 +113,11 @@ sub getStorageId {
}
#-------------------------------------------------------------------
=head2 new
=cut
sub new {
my $class = shift;
my $session = shift;
@ -102,6 +147,11 @@ sub new {
}
#-------------------------------------------------------------------
=head2 session
=cut
sub session {
my $self = shift;
@ -109,6 +159,11 @@ sub session {
}
#-------------------------------------------------------------------
=head2 setFilename
=cut
sub setFilename {
my $self = shift;
my $filename = shift;
@ -122,6 +177,11 @@ sub setFilename {
}
#-------------------------------------------------------------------
=head2 setName
=cut
sub setName {
my $self = shift;
my $name = shift;
@ -135,6 +195,11 @@ sub setName {
}
#-------------------------------------------------------------------
=head2 setStorageId
=cut
sub setStorageId {
my $self = shift;
my $storageId = shift;

View file

@ -13,6 +13,11 @@ package WebGUI::Macro::Widget;
use strict;
#-------------------------------------------------------------------
=head2 process
=cut
sub process {
# get passed parameters

View file

@ -28,10 +28,4 @@ The use of this module is deprecated and is only here for backward compatibility
=cut
1;

View file

@ -37,6 +37,11 @@ See WebGUI::Workflow::Activity for details on how to use any activity.
#-------------------------------------------------------------------
=head2 definition
=cut
sub definition {
my $class = shift;
my $session = shift;
@ -56,12 +61,24 @@ sub definition {
use constant DELETE_FILES_SCRATCH => 'Workflow_Activity_DeleteExportedFiles_deleteFiles';
use constant PRUNE_DIRS_SCRATCH => 'Workflow_Activity_DeleteExportedFiles_pruneDirs';
#-------------------------------------------------------------------
=head2 _canonExportPath
=cut
sub _canonExportPath {
my $self = shift;
my $path = shift;
$self->session->config->get('exportPath').'/'.canonpath($path);
}
#-------------------------------------------------------------------
=head2 _pruneOfFile
=cut
sub _pruneOfFile {
my $self = shift;
my $filename = shift;
@ -73,6 +90,12 @@ sub _pruneOfFile {
return ();
}
#-------------------------------------------------------------------
=head2 execute
=cut
sub execute {
my $self = shift;
my $object = shift;