Update of /cvsroot/sandweb/sandweb/lib
In directory sc8-pr-cvs1:/tmp/cvs-serv15829
Modified Files:
SandWeb.pm
Log Message:
beginning of POD docs
Index: SandWeb.pm
===================================================================
RCS file: /cvsroot/sandweb/sandweb/lib/SandWeb.pm,v
retrieving revision 1.20
retrieving revision 1.21
diff -U2 -r1.20 -r1.21
--- SandWeb.pm 27 Jul 2002 01:47:58 -0000 1.20
+++ SandWeb.pm 5 Jan 2003 08:59:07 -0000 1.21
@@ -1,7 +1,15 @@
# SandWeb main class
#
-#This class handles all the "bootstrapping" for SandWeb. It created the
-#basic objects we always need on every run, like Log, Config, UI, and
-#Auth.
+
+=pod
+=head1
+
+SandWeb.pm
+
+This class handles all the "bootstrapping" for SandWeb. It created the
+basic objects we always need on every run, like Log, Config, UI, and
+Auth.
+
+=cut
#
# SandWeb (Web-based VCS client)
@@ -24,7 +32,25 @@
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
#
+#
+
+=head1
+
+Part of the SandWeb package
+
+=cut
package SandWeb;
+=head1
+
+Depends on :
+
+SandWeb::Config
+SandWeb::Log
+SandWeb::UI
+SandWeb::Auth
+
+=cut
+
use SandWeb::Config;
use SandWeb::Log;
@@ -32,4 +58,18 @@
use SandWeb::Auth;
+=head1
+
+Methods
+
+=cut
+
+=head1
+
+get_version
+
+ returns the current version of SandWeb
+
+=cut
+
$VERSION = 'BETA';
sub get_version {
@@ -37,5 +77,14 @@
}
-# initiates the config class, and creates the other objects with its data
+=head1
+
+start_up
+
+ initiates the config class, and creates the other objects
+ with its data
+
+
+=cut
+
sub start_up {
my $class = shift;
@@ -73,6 +122,12 @@
}
-# all direct access to data should eventually be replaced with method calls
-# to increase encapsulation.
+=head1
+
+load_log_object
+
+ instantiates a log object and passes it to the application
+
+=cut
+
sub _load_log_object {
my %args = @_;
@@ -88,4 +143,12 @@
}
+=head1
+
+load_ui_object
+
+ instantiates a UI object and passes it to the application
+
+=cut
+
sub _load_ui_object {
my %args = @_;
@@ -100,4 +163,12 @@
return $ui;
}
+
+=head1
+
+load_auth_object
+
+ instantiates an auth object and passes it to the application
+
+=cut
sub _load_auth_object {
|
