[LON-CAPA-cvs] cvs: loncom / LONCAPA.pm

[jms]

jms		Mon Nov 17 13:24:02 2008 EDT

  Modified files:              
    /loncom	LONCAPA.pm 
  Log:
  More POD comment fixes
  
Index: loncom/LONCAPA.pm
diff -u loncom/LONCAPA.pm:1.25 loncom/LONCAPA.pm:1.26
--- loncom/LONCAPA.pm:1.25	Mon Nov 17 13:22:01 2008
+++ loncom/LONCAPA.pm	Mon Nov 17 13:24:02 2008
@@ -1,7 +1,7 @@
 # The LearningOnline Network
 # Base routines
 #
-# $Id: LONCAPA.pm,v 1.25 2008/11/17 13:22:01 jms Exp $
+# $Id: LONCAPA.pm,v 1.26 2008/11/17 13:24:02 jms Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -102,12 +102,19 @@
 my %perlvar;
 
 
+=pod
+
+=head2 NOTE:
 
-# Inputs are a url, and a hash ref of
-# form name => value pairs
-# takes care of properly adding the form name elements and values to the 
-# the url doing proper escaping of the values and joining with ? or & as 
-# needed
+add_get_param()
+
+Inputs are a url, and a hash ref of
+form name => value pairs
+takes care of properly adding the form name elements and values to the 
+the url doing proper escaping of the values and joining with ? or & as 
+needed
+
+=cut
 
 sub add_get_param {
     my ($url,$form_data) = @_;
@@ -209,6 +216,8 @@
 
 =pod
 
+=out
+
 =item tie_domain_hash()
 
 Manipulation of hash based databases (factoring out common code
@@ -230,6 +239,8 @@
    Reference to a hash bound to the db file or alternatively undef
    if the tie failed.
 
+=back
+
 =cut
 
 sub tie_domain_hash {
@@ -253,6 +264,8 @@
 
 =pod
 
+=out
+
 =item tie_user_hash()
 
   Ties a user's resource file to a hash.  
@@ -273,6 +286,8 @@
   hash to which the database is tied.  It's up to the caller to untie.
   undef if the has could not be tied.
 
+back
+
 =cut
 
 sub tie_user_hash {
@@ -291,11 +306,15 @@
 
 =pod
 
+=out
+
 =item locking_hash_tie()
 
 routines if you just have a filename
 return tied hashref or undef
 
+=back
+
 =cut
 
 sub locking_hash_tie {