[Sandweb-commit] CVS: sandweb/lib/SandWeb UI.pm,1.35,1.36 Log.pm,1.10,1.11 Auth.pm,1.21,1.22 Diff.pm,1.7,1.8 Browse.pm,1.76,1.77 Repository.pm,1.43,1.44 Shell.pm,1.13,1.14 File.pm,1.57,1.58

[Rob H. <for...@us...>]

Update of /cvsroot/sandweb/sandweb/lib/SandWeb
In directory usw-pr-cvs1:/tmp/cvs-serv27419/lib/SandWeb

Modified Files:
	UI.pm Log.pm Auth.pm Diff.pm Browse.pm Repository.pm Shell.pm 
	File.pm 
Log Message:
added comments to the top of every class


Index: UI.pm
===================================================================
RCS file: /cvsroot/sandweb/sandweb/lib/SandWeb/UI.pm,v
retrieving revision 1.35
retrieving revision 1.36
diff -U2 -r1.35 -r1.36
--- UI.pm	28 Mar 2002 06:39:41 -0000	1.35
+++ UI.pm	19 Jun 2002 07:08:59 -0000	1.36
@@ -1,4 +1,5 @@
 # SandWeb User Interface Class
 #
+# This class is currently a front-end to our templating system, HTML::Template
 #
 #  SandWeb (Web-based VCS client)

Index: Log.pm
===================================================================
RCS file: /cvsroot/sandweb/sandweb/lib/SandWeb/Log.pm,v
retrieving revision 1.10
retrieving revision 1.11
diff -U2 -r1.10 -r1.11
--- Log.pm	10 Mar 2002 01:56:05 -0000	1.10
+++ Log.pm	19 Jun 2002 07:08:59 -0000	1.11
@@ -1,4 +1,6 @@
 # SandWeb logging facility
 # 
+# This class allows us to have a standardized method for logging and debugging.
+# It's possible to print messages to the screen as well as to a log file.
 #
 #  SandWeb (Web-based VCS client)

Index: Auth.pm
===================================================================
RCS file: /cvsroot/sandweb/sandweb/lib/SandWeb/Auth.pm,v
retrieving revision 1.21
retrieving revision 1.22
diff -U2 -r1.21 -r1.22
--- Auth.pm	18 Mar 2002 21:07:58 -0000	1.21
+++ Auth.pm	19 Jun 2002 07:08:59 -0000	1.22
@@ -1,5 +1,6 @@
 #lib/SandWeb/Auth.pm
 #
-# the login class.
+#This class handles logins using modules. A module will return true if the user
+#is authentic, false if not.
 #
 #  SandWeb (Web-based VCS client)

Index: Diff.pm
===================================================================
RCS file: /cvsroot/sandweb/sandweb/lib/SandWeb/Diff.pm,v
retrieving revision 1.7
retrieving revision 1.8
diff -U2 -r1.7 -r1.8
--- Diff.pm	12 Apr 2002 20:23:03 -0000	1.7
+++ Diff.pm	19 Jun 2002 07:08:59 -0000	1.8
@@ -1,2 +1,10 @@
+#SandWeb Diff Class
+#
+#This class will eventually implement "diff" functionality for SandWeb. This
+#will give us VCS-independant formatting of diffs, and will also give us the
+#ability to do nicely-formatted, side-by-side colorized diffs.
+#
+#At the moment, all this class does is colorize any "unified format" diff 
+#given to it.
 #
 #  SandWeb (Web-based VCS client)

Index: Browse.pm
===================================================================
RCS file: /cvsroot/sandweb/sandweb/lib/SandWeb/Browse.pm,v
retrieving revision 1.76
retrieving revision 1.77
diff -U2 -r1.76 -r1.77
--- Browse.pm	18 Mar 2002 05:17:38 -0000	1.76
+++ Browse.pm	19 Jun 2002 07:08:59 -0000	1.77
@@ -1,5 +1,12 @@
 #lib/SandWeb/Browse.pm
 #
-# the browse class.
+#This class handles all filesystem and sandbox browsing functionality. It
+#can show the user a list of files, allow the user to perform abitrary
+#actions on any number of files, and allows you to view the contents of
+#specific files.
+#
+#All filesystem and VCS operations are handled through a generic tool_bar,
+#which is displayed in the UI. All UI is handled through the SandWeb::UI 
+#class.
 #
 #  SandWeb (Web-based VCS client)

Index: Repository.pm
===================================================================
RCS file: /cvsroot/sandweb/sandweb/lib/SandWeb/Repository.pm,v
retrieving revision 1.43
retrieving revision 1.44
diff -U2 -r1.43 -r1.44
--- Repository.pm	19 Jun 2002 06:44:40 -0000	1.43
+++ Repository.pm	19 Jun 2002 07:09:00 -0000	1.44
@@ -1,5 +1,8 @@
 #lib/SandWeb/Repository.pm
 #
-# the repository class.
+#This class abstracts VCS functionality. It takes high-level VCS operations,
+#and decides what method(s) to call in it's VCS-specific subclasses ( such
+#as SandWeb::Repository::cvs ). It is up to the subclass to translate the
+#high-level commands into something each VCS can use directly.
 #
 #  SandWeb (Web-based VCS client)

Index: Shell.pm
===================================================================
RCS file: /cvsroot/sandweb/sandweb/lib/SandWeb/Shell.pm,v
retrieving revision 1.13
retrieving revision 1.14
diff -U2 -r1.13 -r1.14
--- Shell.pm	19 Jun 2002 06:55:36 -0000	1.13
+++ Shell.pm	19 Jun 2002 07:09:00 -0000	1.14
@@ -1,2 +1,8 @@
+#lib/SandWeb/Shell
+#
+#This class makes any and all calls to the operating system shell. It has
+#one public method, execute, which takes a command parameter. Shell is
+#capable of understand SandWeb-specific needs, such as running a command
+#as a specific Unix user, or authenticating to a VCS system like CVS.
 #
 #  SandWeb (Web-based VCS client)

Index: File.pm
===================================================================
RCS file: /cvsroot/sandweb/sandweb/lib/SandWeb/File.pm,v
retrieving revision 1.57
retrieving revision 1.58
diff -U2 -r1.57 -r1.58
--- File.pm	23 Mar 2002 19:47:11 -0000	1.57
+++ File.pm	19 Jun 2002 07:09:00 -0000	1.58
@@ -1,5 +1,8 @@
 #lib/SandWeb/File.pm
 #
-# the file class.
+#This class handles all file viewing and operations. If any class wants
+#to view the contents of a file or directory, or perform a file action
+#such as delete, rename, create, etc. then it just needs to create a File
+#object and call the appropriate File method.
 #
 #  SandWeb (Web-based VCS client)