[Sandweb-commit] CVS: sandweb/lib/SandWeb/Repository cvs.pm,1.36,1.37

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

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

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


Index: cvs.pm
===================================================================
RCS file: /cvsroot/sandweb/sandweb/lib/SandWeb/Repository/cvs.pm,v
retrieving revision 1.36
retrieving revision 1.37
diff -U2 -r1.36 -r1.37
--- cvs.pm	6 Jan 2003 09:49:30 -0000	1.36
+++ cvs.pm	12 Jan 2003 05:13:47 -0000	1.37
@@ -4,5 +4,51 @@
 SandWeb::Repository::cvs
 
---------------------------------------------------------------------------------
+This class directly interfaces with the CVS version control system. It can
+translate calls from Repository into command-line flags that CVS can use.
+
+It is intended to be called by SandWeb::Repository, not directly.
+
+=cut
+
+#  SandWeb (Web-based VCS client)
[...2238 lines suppressed...]
+
+PARAMETERS
+
+    None
+
+RETURN CODE
+
+    A string containing the current system password for an instantiated CVS
+    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 {