Add a bunch of missing POD while the gears spin.

plainblack · Jan 18, 2012 · 7406c02 · 7406c02
1 parent 475b73f
commit 7406c02
Show file tree

Hide file tree

Showing 5 changed files with 41 additions and 1 deletion.
diff --git a/lib/WebGUI.pm b/lib/WebGUI.pm
@@ -134,6 +134,17 @@ sub call {
     }
 }
 
+=head2 handle ($session)
+
+Process the list of content handlers from the config file and then evaluate any Template objects which
+may have been returned.
+
+=head3 $session
+
+A WebGUI::Session object.
+
+=cut
+
 sub handle {
     my ( $self, $session ) = @_;
 

diff --git a/lib/WebGUI/Command/changeIobStatus.pm b/lib/WebGUI/Command/changeIobStatus.pm
@@ -14,6 +14,12 @@ use WebGUI::Command -command;
 use strict;
 use warnings;
 
+=head2 opt_spec
+
+Return a set of options to WebGUI::Command so that it knows how to process command line options.
+
+=cut
+
 sub opt_spec {
     return (
         [ 'configFile=s', 'The WebGUI config file to use.  This parameter is required.'],
@@ -26,6 +32,12 @@ sub opt_spec {
     );
 }
 
+=head2 validate_args
+
+Check for mandatory command line options
+
+=cut
+
 sub validate_args {
     my ($self, $opt, $args) = @_;
     if (! $opt->{configfile}) {

diff --git a/lib/WebGUI/Form/Control.pm b/lib/WebGUI/Form/Control.pm
@@ -336,6 +336,14 @@ sub getDatabaseFieldType {
     return "CHAR(255)";
 }
 
+#-------------------------------------------------------------------
+
+=head2 getLabel ( )
+
+Gets the label for this form control, including any configured hover help.
+
+=cut 
+
 sub getLabel {
     my ( $self ) = @_;
 

diff --git a/lib/WebGUI/Operation/WebGUI.pm b/lib/WebGUI/Operation/WebGUI.pm
@@ -40,7 +40,7 @@ sub www_genesis {
 
 #-------------------------------------------------------------------
 
-=head2 theWg ( )
+=head2 www_theWg ( )
 
 The core WebGUI function.  All WebGUI Assets, Operations and functions require this
 to work, even superseding the session variable.

diff --git a/lib/WebGUI/Upgrade/File/txt.pm b/lib/WebGUI/Upgrade/File/txt.pm
@@ -14,12 +14,21 @@
 
 WebGUI::Upgrade::File::txt - Upgrade class for text documents
 
+Displays the text document to the user, and then after a keypress, continues on to the
+next upgarde file.
+
 =cut
 
 package WebGUI::Upgrade::File::txt;
 use Moose;
 with 'WebGUI::Upgrade::File';
 
+=head2 once
+
+Override the default so that the text is only displayed once.
+
+=cut
+
 sub once { 1 }
 
 sub run {