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

[albertel]

albertel		Tue Feb 25 16:54:14 2003 EDT

  Modified files:              
    /loncom/interface	loncommon.pm 
  Log:
  - POD
  
  
Index: loncom/interface/loncommon.pm
diff -u loncom/interface/loncommon.pm:1.84 loncom/interface/loncommon.pm:1.85
--- loncom/interface/loncommon.pm:1.84	Tue Feb 25 16:49:45 2003
+++ loncom/interface/loncommon.pm	Tue Feb 25 16:54:14 2003
@@ -1,7 +1,7 @@
 # The LearningOnline Network with CAPA
 # a pile of common routines
 #
-# $Id: loncommon.pm,v 1.84 2003/02/25 21:49:45 albertel Exp $
+# $Id: loncommon.pm,v 1.85 2003/02/25 21:54:14 albertel Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -1921,6 +1921,22 @@
     return($i);
 }
 
+=pod
+
+=item check_if_partid_hidden($id,$symb,$udom,$uname)
+
+Returns either 1 or undef
+
+1 if the part is to be hidden, undef if it is to be shown
+
+Arguments are:
+
+$id the id of the part to be checked
+$symb, optional the symb of the resource to check
+$udom, optional the domain of the user to check for
+$uname, optional the username of the user to check for
+
+=cut
 
 sub check_if_partid_hidden {
     my ($id,$symb,$udom,$uname) = @_;