[Sandweb-commit] CVS: sandweb/lib/SandWeb Log.pm,1.16,1.17

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

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

Modified Files:
	Log.pm 
Log Message:
added API doc for "get_debug_msgs" method


Index: Log.pm
===================================================================
RCS file: /cvsroot/sandweb/sandweb/lib/SandWeb/Log.pm,v
retrieving revision 1.16
retrieving revision 1.17
diff -U2 -r1.16 -r1.17
--- Log.pm	22 Jan 2003 06:49:36 -0000	1.16
+++ Log.pm	23 Jan 2003 17:36:34 -0000	1.17
@@ -258,4 +258,34 @@
 } 
 
+=head1
+
+METHOD
+
+	get_debug_msgs
+
+SYNOPSIS
+
+        $log->get_debug_msgs();
+
+DESCRIPTION
+
+	Returns all debug messages.
+
+PARAMETERS
+
+	None.
+
+RETURN CODES
+
+    1 = The operation completed successfully.
+ 
+    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.
+
+--------------------------------------------------------------------------------
+
 sub get_debug_msgs {
 	my $self = shift;