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

[albertel]

albertel		Thu Feb 13 18:02:42 2003 EDT

  Modified files:              
    /loncom/interface	loncommon.pm 
  Log:
  -adding some docs
  
  
Index: loncom/interface/loncommon.pm
diff -u loncom/interface/loncommon.pm:1.80 loncom/interface/loncommon.pm:1.81
--- loncom/interface/loncommon.pm:1.80	Thu Feb 13 16:35:50 2003
+++ loncom/interface/loncommon.pm	Thu Feb 13 18:02:42 2003
@@ -1,7 +1,7 @@
 # The LearningOnline Network with CAPA
 # a pile of common routines
 #
-# $Id: loncommon.pm,v 1.80 2003/02/13 21:35:50 albertel Exp $
+# $Id: loncommon.pm,v 1.81 2003/02/13 23:02:42 albertel Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -1103,7 +1103,17 @@
 ###############################################################
 
 # -------------------------------------------------------------- Plaintext name
+=pod
+
+=item plainname($uname,$udom)
+
+Gets a users name and returns it as a string in
+"first middle last generation"
+form
+
+=cut
 
+###############################################################
 sub plainname {
     my ($uname,$udom)=@_;
     my %names=&Apache::lonnet::get('environment',
@@ -1117,7 +1127,21 @@
 }
 
 # -------------------------------------------------------------------- Nickname
+=pod
+
+=item nickname($uname,$udom)
+
+Gets a users name and returns it as a string as
+
+""nickname""
 
+if the user has a nickname or
+
+"first middle last generation"
+
+if the user does not
+
+=cut
 
 sub nickname {
     my ($uname,$udom)=@_;
@@ -1137,6 +1161,14 @@
 
 
 # ------------------------------------------------------------------ Screenname
+
+=pod
+
+=item screenname($uname,$udom)
+
+Gets a users screenname and returns it as a string
+
+=cut
 
 sub screenname {
     my ($uname,$udom)=@_;