[LON-CAPA-cvs] cvs: loncom /interface loncommon.pm

[raeburn]

raeburn		Mon Jul  2 11:37:18 2007 EDT

  Modified files:              
    /loncom/interface	loncommon.pm 
  Log:
  - Add documentation
  - Fix some typos
  - perldoc was complaining about an unmatched =back
  
  
Index: loncom/interface/loncommon.pm
diff -u loncom/interface/loncommon.pm:1.541 loncom/interface/loncommon.pm:1.542
--- loncom/interface/loncommon.pm:1.541	Sun Jul  1 23:36:28 2007
+++ loncom/interface/loncommon.pm	Mon Jul  2 11:37:15 2007
@@ -1,7 +1,7 @@
 # The LearningOnline Network with CAPA
 # a pile of common routines
 #
-# $Id: loncommon.pm,v 1.541 2007/07/02 03:36:28 raeburn Exp $
+# $Id: loncommon.pm,v 1.542 2007/07/02 15:37:15 raeburn Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -240,7 +240,7 @@
 
 formname and elementname specify the name of the html form and the name
 of the element the selection from the search results will be placed in.
-=back
+
 =cut
 
 sub browser_and_searcher_javascript {
@@ -1078,7 +1078,7 @@
 =pod
 
 =back
-
+ 
 =head1 Excel and CSV file utility routines
 
 =over 4
@@ -1212,7 +1212,7 @@
 
 =item * create_text_file
 
-Create a file to write to and eventually make available to the usre.
+Create a file to write to and eventually make available to the user.
 If file creation fails, outputs an error message on the request object and 
 return undefs.
 
@@ -2119,6 +2119,19 @@
     }
 }
 
+# -------------------------------------------------------------------- getemails
+=pod
+
+=item * getemails($uname,$udom)
+
+Gets a user's email information and returns it as a hash with keys:
+notification, critnotification, permanentemail
+
+For notification and critnotification, values are comma-separated lists 
+of e-mail address(es); for permanentemail, value is a single e-mail address.
+ 
+=cut
+
 sub getemails {
     my ($uname,$udom)=@_;
     if ($udom eq 'public' && $uname eq 'public') {
@@ -4880,7 +4893,7 @@
 
 =pod
 
-=item * &check_user_status
+=item * &check_user_status()
 
 Determines current status of supplied role for a
 specific user. Roles can be active, previous or future.