[Sandweb-commit] CVS: sandweb/lib/SandWeb Repository.pm,1.49,1.50

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

Update of /cvsroot/sandweb/sandweb/lib/SandWeb
In directory sc8-pr-cvs1:/tmp/cvs-serv16255/SandWeb

Modified Files:
	Repository.pm 
Log Message:
better formatting; now the API doc section for each method is right
above that method in the code.


Index: Repository.pm
===================================================================
RCS file: /cvsroot/sandweb/sandweb/lib/SandWeb/Repository.pm,v
retrieving revision 1.49
retrieving revision 1.50
diff -U2 -r1.49 -r1.50
--- Repository.pm	6 Jan 2003 09:49:30 -0000	1.49
+++ Repository.pm	12 Jan 2003 05:13:47 -0000	1.50
@@ -4,4 +4,58 @@
 SandWeb::Repository
 
+SandWeb::Repository
+
+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.
+
+=cut
+
[...2791 lines suppressed...]
+
+    None
+
+RETURN CODE
+
+    A string containing the current system password for an instantiated Repository
+    object is returned.
+
+    0 = This means that the method got an error proccessing your request.
+        Perhaps an invalid parameter?
+
+   -1 = This return value means that there was not sufficient permision to
+        read the files specified, or they did not exist.
+
+
+
+=cut
+
 sub get_system_password {
 	my $self = shift;